Index
All Classes and Interfaces|All Packages
A
- Adding the package to your product - Search tag in Overview
- Section
- addPolicy(HttpPipelinePolicy) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
.
- AGENT - Static variable in class com.azure.ai.agents.persistent.models.MessageRole
-
The role representing the agent.
- AgentDeletionStatus - Class in com.azure.ai.agents.persistent.models
-
The status of an agent deletion operation.
- AGENTS - Static variable in class com.azure.ai.agents.persistent.models.FilePurpose
-
Indicates a file is used as input to agents.
- AGENTS_OUTPUT - Static variable in class com.azure.ai.agents.persistent.models.FilePurpose
-
Indicates a file is used as output by agents.
- AgentsServiceVersion - Enum in com.azure.ai.agents.persistent
-
Service version of AgentsClient.
- AISearchIndexResource - Class in com.azure.ai.agents.persistent.models
-
A AI Search Index resource.
- AISearchIndexResource() - Constructor for class com.azure.ai.agents.persistent.models.AISearchIndexResource
-
Creates an instance of AISearchIndexResource class.
- ANONYMOUS - Static variable in class com.azure.ai.agents.persistent.models.OpenApiAuthType
-
Static value anonymous for OpenApiAuthType.
- ASCENDING - Static variable in class com.azure.ai.agents.persistent.models.ListSortOrder
-
Specifies an ascending sort order.
- Authentication - Search tag in Overview
- Section
- AUTO - Static variable in class com.azure.ai.agents.persistent.models.ImageDetailLevel
-
Automatically select an appropriate detail level.
- AUTO - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentsResponseFormatMode
-
Default value.
- AUTO - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentsToolChoiceOptionMode
-
The model can pick between generating a message or calling a function.
- AUTO - Static variable in class com.azure.ai.agents.persistent.models.TruncationStrategy
-
Default value.
- AUTO - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyRequestType
-
Static value auto for VectorStoreChunkingStrategyRequestType.
- AZURE_AISEARCH - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentsNamedToolChoiceType
-
Tool type `azure_ai_search`.
- Azure Agents client library for Java - Search tag in Overview
- Section
- AzureAISearchQueryType - Class in com.azure.ai.agents.persistent.models
-
Available query types for Azure AI Search tool.
- AzureAISearchQueryType() - Constructor for class com.azure.ai.agents.persistent.models.AzureAISearchQueryType
-
Deprecated.
- AzureAISearchToolDefinition - Class in com.azure.ai.agents.persistent.models
-
The input definition information for an Azure AI search tool as used to configure an agent.
- AzureAISearchToolDefinition() - Constructor for class com.azure.ai.agents.persistent.models.AzureAISearchToolDefinition
-
Creates an instance of AzureAISearchToolDefinition class.
- AzureAISearchToolResource - Class in com.azure.ai.agents.persistent.models
-
A set of index resources used by the `azure_ai_search` tool.
- AzureAISearchToolResource() - Constructor for class com.azure.ai.agents.persistent.models.AzureAISearchToolResource
-
Creates an instance of AzureAISearchToolResource class.
- AzureFunctionBinding - Class in com.azure.ai.agents.persistent.models
-
The structure for keeping storage queue name and URI.
- AzureFunctionBinding(AzureFunctionStorageQueue) - Constructor for class com.azure.ai.agents.persistent.models.AzureFunctionBinding
-
Creates an instance of AzureFunctionBinding class.
- AzureFunctionDefinition - Class in com.azure.ai.agents.persistent.models
-
The definition of Azure function.
- AzureFunctionDefinition(FunctionDefinition, AzureFunctionBinding, AzureFunctionBinding) - Constructor for class com.azure.ai.agents.persistent.models.AzureFunctionDefinition
-
Creates an instance of AzureFunctionDefinition class.
- AzureFunctionStorageQueue - Class in com.azure.ai.agents.persistent.models
-
The structure for keeping storage queue name and URI.
- AzureFunctionStorageQueue(String, String) - Constructor for class com.azure.ai.agents.persistent.models.AzureFunctionStorageQueue
-
Creates an instance of AzureFunctionStorageQueue class.
- AzureFunctionToolDefinition - Class in com.azure.ai.agents.persistent.models
-
The input definition information for a azure function tool as used to configure an agent.
- AzureFunctionToolDefinition(AzureFunctionDefinition) - Constructor for class com.azure.ai.agents.persistent.models.AzureFunctionToolDefinition
-
Creates an instance of AzureFunctionToolDefinition class.
B
- BATCH - Static variable in class com.azure.ai.agents.persistent.models.FilePurpose
-
Indicates a file is used as input to .
- BATCH_OUTPUT - Static variable in class com.azure.ai.agents.persistent.models.FilePurpose
-
Indicates a file is used as output by a vector store batch operation.
- BING_GROUNDING - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentsNamedToolChoiceType
-
Tool type `bing_grounding`.
- BingGroundingSearchConfiguration - Class in com.azure.ai.agents.persistent.models
-
Search configuration for Bing Grounding.
- BingGroundingSearchConfiguration(String) - Constructor for class com.azure.ai.agents.persistent.models.BingGroundingSearchConfiguration
-
Creates an instance of BingGroundingSearchConfiguration class.
- BingGroundingSearchToolParameters - Class in com.azure.ai.agents.persistent.models
-
The bing grounding search tool parameters.
- BingGroundingSearchToolParameters(List<BingGroundingSearchConfiguration>) - Constructor for class com.azure.ai.agents.persistent.models.BingGroundingSearchToolParameters
-
Creates an instance of BingGroundingSearchToolParameters class.
- BingGroundingToolDefinition - Class in com.azure.ai.agents.persistent.models
-
The input definition information for a bing grounding search tool as used to configure an agent.
- BingGroundingToolDefinition(BingGroundingSearchToolParameters) - Constructor for class com.azure.ai.agents.persistent.models.BingGroundingToolDefinition
-
Creates an instance of BingGroundingToolDefinition class.
- buildAsyncClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of PersistentAgentsAdministrationAsyncClient class.
- buildClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of PersistentAgentsAdministrationClient class.
- buildFilesAsyncClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of FilesAsyncClient class.
- buildFilesClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of FilesClient class.
- buildMessagesAsyncClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of MessagesAsyncClient class.
- buildMessagesClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of MessagesClient class.
- buildRunsAsyncClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of RunsAsyncClient class.
- buildRunsClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of RunsClient class.
- buildRunStepsAsyncClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of RunStepsAsyncClient class.
- buildRunStepsClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of RunStepsClient class.
- buildThreadsAsyncClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of ThreadsAsyncClient class.
- buildThreadsClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of ThreadsClient class.
- buildVectorStoreFileBatchesAsyncClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of VectorStoreFileBatchesAsyncClient class.
- buildVectorStoreFileBatchesClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of VectorStoreFileBatchesClient class.
- buildVectorStoreFilesAsyncClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of VectorStoreFilesAsyncClient class.
- buildVectorStoreFilesClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of VectorStoreFilesClient class.
- buildVectorStoresAsyncClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of VectorStoresAsyncClient class.
- buildVectorStoresClient() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Builds an instance of VectorStoresClient class.
C
- CANCELLED - Static variable in class com.azure.ai.agents.persistent.models.RunStatus
-
Represents a run that has been cancelled.
- CANCELLED - Static variable in class com.azure.ai.agents.persistent.models.RunStepStatus
-
Represents a run step that was cancelled.
- CANCELLED - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreFileBatchStatus
-
The vector store file batch was cancelled.
- CANCELLED - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreFileStatus
-
The file was cancelled.
- CANCELLED - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreFileStatusFilter
-
Retrieve only files that were cancelled.
- CANCELLING - Static variable in class com.azure.ai.agents.persistent.models.RunStatus
-
Represents a run that is in the process of cancellation.
- cancelRun(String, String) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Cancels a run of an in‐progress thread.
- cancelRun(String, String) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Cancels a run of an in‐progress thread.
- cancelRunWithResponse(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Cancels a run of an in‐progress thread.
- cancelRunWithResponse(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Cancels a run of an in‐progress thread.
- cancelVectorStoreFileBatch(String, String) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesAsyncClient
-
Cancel a vector store file batch.
- cancelVectorStoreFileBatch(String, String) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesClient
-
Cancel a vector store file batch.
- cancelVectorStoreFileBatchWithResponse(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesAsyncClient
-
Cancel a vector store file batch.
- cancelVectorStoreFileBatchWithResponse(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesClient
-
Cancel a vector store file batch.
- clientOptions(ClientOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
.
- CODE_INTERPRETER - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentsNamedToolChoiceType
-
Tool type `code_interpreter`.
- CodeInterpreterToolDefinition - Class in com.azure.ai.agents.persistent.models
-
The input definition information for a code interpreter tool as used to configure an agent.
- CodeInterpreterToolDefinition() - Constructor for class com.azure.ai.agents.persistent.models.CodeInterpreterToolDefinition
-
Creates an instance of CodeInterpreterToolDefinition class.
- CodeInterpreterToolResource - Class in com.azure.ai.agents.persistent.models
-
A set of resources that are used by the `code_interpreter` tool.
- CodeInterpreterToolResource() - Constructor for class com.azure.ai.agents.persistent.models.CodeInterpreterToolResource
-
Creates an instance of CodeInterpreterToolResource class.
- com.azure.ai.agents.persistent - package com.azure.ai.agents.persistent
-
Package containing the classes for Agents.
- com.azure.ai.agents.persistent.models - package com.azure.ai.agents.persistent.models
-
Package containing the data models for Agents.
- COMPLETED - Static variable in class com.azure.ai.agents.persistent.models.MessageStatus
-
This message was successfully completed by a run.
- COMPLETED - Static variable in class com.azure.ai.agents.persistent.models.RunStatus
-
Represents a run that successfully completed.
- COMPLETED - Static variable in class com.azure.ai.agents.persistent.models.RunStepStatus
-
Represents a run step that successfully completed.
- COMPLETED - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreFileBatchStatus
-
the vector store file batch is ready for use.
- COMPLETED - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreFileStatus
-
The file has been successfully processed.
- COMPLETED - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreFileStatusFilter
-
Retrieve only files that have been successfully processed.
- COMPLETED - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreStatus
-
completed status indicates that this vector store is ready for use.
- configuration(Configuration) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
.
- CONNECTED_AGENT - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentsNamedToolChoiceType
-
Tool type `connected_agent`.
- ConnectedAgentDetails - Class in com.azure.ai.agents.persistent.models
-
Information for connecting one agent to another as a tool.
- ConnectedAgentDetails(String, String, String) - Constructor for class com.azure.ai.agents.persistent.models.ConnectedAgentDetails
-
Creates an instance of ConnectedAgentDetails class.
- ConnectedAgentToolDefinition - Class in com.azure.ai.agents.persistent.models
-
The input definition information for a connected agent tool which defines a domain specific sub-agent.
- ConnectedAgentToolDefinition(ConnectedAgentDetails) - Constructor for class com.azure.ai.agents.persistent.models.ConnectedAgentToolDefinition
-
Creates an instance of ConnectedAgentToolDefinition class.
- CONNECTION - Static variable in class com.azure.ai.agents.persistent.models.OpenApiAuthType
-
Static value connection for OpenApiAuthType.
- CONTENT_FILTER - Static variable in class com.azure.ai.agents.persistent.models.MessageIncompleteDetailsReason
-
The run generating the message was terminated due to content filter flagging.
- Contributing - Search tag in Overview
- Section
- createAgent(CreateAgentOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationAsyncClient
-
Creates a new agent.
- createAgent(CreateAgentOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClient
-
Creates a new agent.
- CreateAgentOptions - Class in com.azure.ai.agents.persistent.models
-
Options for createAgent API.
- CreateAgentOptions(String) - Constructor for class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Creates an instance of CreateAgentOptions class.
- createAgentWithResponse(BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationAsyncClient
-
Creates a new agent.
- createAgentWithResponse(BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClient
-
Creates a new agent.
- createMessage(String, MessageRole, BinaryData) - Method in class com.azure.ai.agents.persistent.MessagesAsyncClient
-
Creates a new message on a specified thread.
- createMessage(String, MessageRole, BinaryData) - Method in class com.azure.ai.agents.persistent.MessagesClient
-
Creates a new message on a specified thread.
- createMessage(String, MessageRole, BinaryData, List<MessageAttachment>, Map<String, String>) - Method in class com.azure.ai.agents.persistent.MessagesAsyncClient
-
Creates a new message on a specified thread.
- createMessage(String, MessageRole, BinaryData, List<MessageAttachment>, Map<String, String>) - Method in class com.azure.ai.agents.persistent.MessagesClient
-
Creates a new message on a specified thread.
- createMessage(String, MessageRole, String) - Method in class com.azure.ai.agents.persistent.MessagesAsyncClient
-
Creates a new message on a specified thread.
- createMessage(String, MessageRole, String) - Method in class com.azure.ai.agents.persistent.MessagesClient
-
Creates a new message on a specified thread.
- createMessage(String, MessageRole, String, List<MessageAttachment>, Map<String, String>) - Method in class com.azure.ai.agents.persistent.MessagesAsyncClient
-
Creates a new message on a specified thread.
- createMessage(String, MessageRole, String, List<MessageAttachment>, Map<String, String>) - Method in class com.azure.ai.agents.persistent.MessagesClient
-
Creates a new message on a specified thread.
- createMessageWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.MessagesAsyncClient
-
Creates a new message on a specified thread.
- createMessageWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.MessagesClient
-
Creates a new message on a specified thread.
- createRun(CreateRunOptions) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Creates a new run for an agent thread.
- createRun(CreateRunOptions) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Creates a new run for an agent thread.
- CreateRunOptions - Class in com.azure.ai.agents.persistent.models
-
Options for createRun API.
- CreateRunOptions(String, String) - Constructor for class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Creates an instance of CreateRunOptions class.
- createRunStreaming(CreateRunOptions) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Creates a new streaming run for an agent thread.
- createRunStreaming(CreateRunOptions) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Creates a new streaming run for an agent thread.
- createRunWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Creates a new run for an agent thread.
- createRunWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Creates a new run for an agent thread.
- createThread() - Method in class com.azure.ai.agents.persistent.ThreadsAsyncClient
-
Creates a new thread.
- createThread() - Method in class com.azure.ai.agents.persistent.ThreadsClient
-
Creates a new thread.
- createThread(List<ThreadMessageOptions>, ToolResources, Map<String, String>) - Method in class com.azure.ai.agents.persistent.ThreadsAsyncClient
-
Creates a new thread.
- createThread(List<ThreadMessageOptions>, ToolResources, Map<String, String>) - Method in class com.azure.ai.agents.persistent.ThreadsClient
-
Creates a new thread.
- createThreadAndRun(CreateThreadAndRunOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationAsyncClient
-
Creates a new agent thread and immediately starts a run using that new thread.
- createThreadAndRun(CreateThreadAndRunOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClient
-
Creates a new agent thread and immediately starts a run using that new thread.
- CreateThreadAndRunOptions - Class in com.azure.ai.agents.persistent.models
-
Options for createThreadAndRun API.
- CreateThreadAndRunOptions(String) - Constructor for class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Creates an instance of CreateThreadAndRunOptions class.
- createThreadAndRunWithResponse(BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationAsyncClient
-
Creates a new agent thread and immediately starts a run using that new thread.
- createThreadAndRunWithResponse(BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClient
-
Creates a new agent thread and immediately starts a run using that new thread.
- createThreadWithResponse(BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.ThreadsAsyncClient
-
Creates a new thread.
- createThreadWithResponse(BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.ThreadsClient
-
Creates a new thread.
- createVectorStore() - Method in class com.azure.ai.agents.persistent.VectorStoresAsyncClient
-
Creates a vector store.
- createVectorStore() - Method in class com.azure.ai.agents.persistent.VectorStoresClient
-
Creates a vector store.
- createVectorStore(List<String>, String, VectorStoreConfiguration, VectorStoreExpirationPolicy, VectorStoreChunkingStrategyRequest, Map<String, String>) - Method in class com.azure.ai.agents.persistent.VectorStoresAsyncClient
-
Creates a vector store.
- createVectorStore(List<String>, String, VectorStoreConfiguration, VectorStoreExpirationPolicy, VectorStoreChunkingStrategyRequest, Map<String, String>) - Method in class com.azure.ai.agents.persistent.VectorStoresClient
-
Creates a vector store.
- createVectorStoreFile(String) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesAsyncClient
-
Create a vector store file by attaching a file to a vector store.
- createVectorStoreFile(String) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesClient
-
Create a vector store file by attaching a file to a vector store.
- createVectorStoreFile(String, String, VectorStoreDataSource, VectorStoreChunkingStrategyRequest) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesAsyncClient
-
Create a vector store file by attaching a file to a vector store.
- createVectorStoreFile(String, String, VectorStoreDataSource, VectorStoreChunkingStrategyRequest) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesClient
-
Create a vector store file by attaching a file to a vector store.
- createVectorStoreFileBatch(String) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesAsyncClient
-
Create a vector store file batch.
- createVectorStoreFileBatch(String) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesClient
-
Create a vector store file batch.
- createVectorStoreFileBatch(String, List<String>, List<VectorStoreDataSource>, VectorStoreChunkingStrategyRequest) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesAsyncClient
-
Create a vector store file batch.
- createVectorStoreFileBatch(String, List<String>, List<VectorStoreDataSource>, VectorStoreChunkingStrategyRequest) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesClient
-
Create a vector store file batch.
- createVectorStoreFileBatchWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesAsyncClient
-
Create a vector store file batch.
- createVectorStoreFileBatchWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesClient
-
Create a vector store file batch.
- createVectorStoreFileWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesAsyncClient
-
Create a vector store file by attaching a file to a vector store.
- createVectorStoreFileWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesClient
-
Create a vector store file by attaching a file to a vector store.
- createVectorStoreWithResponse(BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoresAsyncClient
-
Creates a vector store.
- createVectorStoreWithResponse(BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoresClient
-
Creates a vector store.
- credential(TokenCredential) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
.
D
- deleteAgent(String) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationAsyncClient
-
Deletes an agent.
- deleteAgent(String) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClient
-
Deletes an agent.
- deleteAgentWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationAsyncClient
-
Deletes an agent.
- deleteAgentWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClient
-
Deletes an agent.
- DELETED - Static variable in class com.azure.ai.agents.persistent.models.FileState
-
The entity has been deleted but may still be referenced by other entities predating the deletion.
- deleteFile(String) - Method in class com.azure.ai.agents.persistent.FilesAsyncClient
-
Delete a previously uploaded file.
- deleteFile(String) - Method in class com.azure.ai.agents.persistent.FilesClient
-
Delete a previously uploaded file.
- deleteFileWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.FilesAsyncClient
-
Delete a previously uploaded file.
- deleteFileWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.FilesClient
-
Delete a previously uploaded file.
- deleteThread(String) - Method in class com.azure.ai.agents.persistent.ThreadsAsyncClient
-
Deletes an existing thread.
- deleteThread(String) - Method in class com.azure.ai.agents.persistent.ThreadsClient
-
Deletes an existing thread.
- deleteThreadWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.ThreadsAsyncClient
-
Deletes an existing thread.
- deleteThreadWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.ThreadsClient
-
Deletes an existing thread.
- deleteVectorStore(String) - Method in class com.azure.ai.agents.persistent.VectorStoresAsyncClient
-
Deletes the vector store object matching the specified ID.
- deleteVectorStore(String) - Method in class com.azure.ai.agents.persistent.VectorStoresClient
-
Deletes the vector store object matching the specified ID.
- deleteVectorStoreFile(String, String) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesAsyncClient
-
Deletes a vector store file.
- deleteVectorStoreFile(String, String) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesClient
-
Deletes a vector store file.
- deleteVectorStoreFileWithResponse(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesAsyncClient
-
Deletes a vector store file.
- deleteVectorStoreFileWithResponse(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesClient
-
Deletes a vector store file.
- deleteVectorStoreWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoresAsyncClient
-
Deletes the vector store object matching the specified ID.
- deleteVectorStoreWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoresClient
-
Deletes the vector store object matching the specified ID.
- DELETING - Static variable in class com.azure.ai.agents.persistent.models.FileState
-
The entity is in the process to be deleted.
- DESCENDING - Static variable in class com.azure.ai.agents.persistent.models.ListSortOrder
-
Specifies a descending sort order.
- deserializeEvent(String, BinaryData) - Method in class com.azure.ai.agents.persistent.models.StreamTypeFactory
-
Deserializes the server sent event into the appropriate type.
- Documentation - Search tag in Overview
- Section
- DONE - Static variable in class com.azure.ai.agents.persistent.models.DoneEvent
-
Event sent when the stream is done.
- DONE - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when the stream is done.
- DoneEvent - Class in com.azure.ai.agents.persistent.models
-
Terminal event indicating the successful end of a stream.
- DoneEvent() - Constructor for class com.azure.ai.agents.persistent.models.DoneEvent
-
Deprecated.Use the
DoneEvent.fromString(String)factory method.
E
- endpoint(String) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
.
- ERROR - Static variable in class com.azure.ai.agents.persistent.models.ErrorEvent
-
Event sent when an error occurs, such as an internal server error or a timeout.
- ERROR - Static variable in class com.azure.ai.agents.persistent.models.FileState
-
The operation has completed processing with a failure and cannot be further consumed.
- ERROR - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when an error occurs, such as an internal server error or a timeout.
- ErrorEvent - Class in com.azure.ai.agents.persistent.models
-
Terminal event indicating a server side error while streaming.
- ErrorEvent() - Constructor for class com.azure.ai.agents.persistent.models.ErrorEvent
-
Deprecated.Use the
ErrorEvent.fromString(String)factory method. - Examples - Search tag in Overview
- Section
- EXPIRED - Static variable in class com.azure.ai.agents.persistent.models.RunStatus
-
Represents a run that expired before it could otherwise finish.
- EXPIRED - Static variable in class com.azure.ai.agents.persistent.models.RunStepStatus
-
Represents a run step that expired before otherwise finishing.
- EXPIRED - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreStatus
-
expired status indicates that this vector store has expired and is no longer available for use.
F
- FAILED - Static variable in class com.azure.ai.agents.persistent.models.RunStatus
-
Represents a run that failed.
- FAILED - Static variable in class com.azure.ai.agents.persistent.models.RunStepStatus
-
Represents a run step that failed.
- FAILED - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreFileBatchStatus
-
The vector store file batch failed to process.
- FAILED - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreFileStatus
-
The file has failed to process.
- FAILED - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreFileStatusFilter
-
Retrieve only files that have failed to process.
- FILE_SEARCH - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentsNamedToolChoiceType
-
Tool type `file_search`.
- FILE_SEARCH_CONTENTS - Static variable in class com.azure.ai.agents.persistent.models.RunAdditionalFieldList
-
File search result content.
- FileDeletionStatus - Class in com.azure.ai.agents.persistent.models
-
A status response from a file deletion operation.
- FileInfo - Class in com.azure.ai.agents.persistent.models
-
Represents an agent that can call the model and use tools.
- FileListResponse - Class in com.azure.ai.agents.persistent.models
-
The response data from a file list operation.
- FilePurpose - Class in com.azure.ai.agents.persistent.models
-
The possible values denoting the intended usage of a file.
- FilePurpose() - Constructor for class com.azure.ai.agents.persistent.models.FilePurpose
-
Deprecated.Use the
FilePurpose.fromString(String)factory method. - FilesAsyncClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the asynchronous PersistentAgentsAdministrationClient type.
- FilesClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the synchronous PersistentAgentsAdministrationClient type.
- FileSearchRankingOptions - Class in com.azure.ai.agents.persistent.models
-
Ranking options for file search.
- FileSearchRankingOptions(String, double) - Constructor for class com.azure.ai.agents.persistent.models.FileSearchRankingOptions
-
Creates an instance of FileSearchRankingOptions class.
- FileSearchToolCallContent - Class in com.azure.ai.agents.persistent.models
-
The file search result content object.
- FileSearchToolDefinition - Class in com.azure.ai.agents.persistent.models
-
The input definition information for a file search tool as used to configure an agent.
- FileSearchToolDefinition() - Constructor for class com.azure.ai.agents.persistent.models.FileSearchToolDefinition
-
Creates an instance of FileSearchToolDefinition class.
- FileSearchToolDefinitionDetails - Class in com.azure.ai.agents.persistent.models
-
Options overrides for the file search tool.
- FileSearchToolDefinitionDetails() - Constructor for class com.azure.ai.agents.persistent.models.FileSearchToolDefinitionDetails
-
Creates an instance of FileSearchToolDefinitionDetails class.
- FileSearchToolResource - Class in com.azure.ai.agents.persistent.models
-
A set of resources that are used by the `file_search` tool.
- FileSearchToolResource() - Constructor for class com.azure.ai.agents.persistent.models.FileSearchToolResource
-
Creates an instance of FileSearchToolResource class.
- FileState - Class in com.azure.ai.agents.persistent.models
-
The state of the file.
- FileState() - Constructor for class com.azure.ai.agents.persistent.models.FileState
-
Deprecated.Use the
FileState.fromString(String)factory method. - FINE_TUNE - Static variable in class com.azure.ai.agents.persistent.models.FilePurpose
-
Indicates a file is used for fine tuning input.
- FINE_TUNE_RESULTS - Static variable in class com.azure.ai.agents.persistent.models.FilePurpose
-
Indicates a file is used for fine tuning results.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.AgentDeletionStatus
-
Reads an instance of AgentDeletionStatus from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.AISearchIndexResource
-
Reads an instance of AISearchIndexResource from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.AzureAISearchToolDefinition
-
Reads an instance of AzureAISearchToolDefinition from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.AzureAISearchToolResource
-
Reads an instance of AzureAISearchToolResource from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.AzureFunctionBinding
-
Reads an instance of AzureFunctionBinding from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.AzureFunctionDefinition
-
Reads an instance of AzureFunctionDefinition from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.AzureFunctionStorageQueue
-
Reads an instance of AzureFunctionStorageQueue from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.AzureFunctionToolDefinition
-
Reads an instance of AzureFunctionToolDefinition from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.BingGroundingSearchConfiguration
-
Reads an instance of BingGroundingSearchConfiguration from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.BingGroundingSearchToolParameters
-
Reads an instance of BingGroundingSearchToolParameters from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.BingGroundingToolDefinition
-
Reads an instance of BingGroundingToolDefinition from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.CodeInterpreterToolDefinition
-
Reads an instance of CodeInterpreterToolDefinition from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.CodeInterpreterToolResource
-
Reads an instance of CodeInterpreterToolResource from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.ConnectedAgentDetails
-
Reads an instance of ConnectedAgentDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.ConnectedAgentToolDefinition
-
Reads an instance of ConnectedAgentToolDefinition from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.FileDeletionStatus
-
Reads an instance of FileDeletionStatus from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.FileInfo
-
Reads an instance of FileInfo from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.FileListResponse
-
Reads an instance of FileListResponse from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.FileSearchRankingOptions
-
Reads an instance of FileSearchRankingOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.FileSearchToolCallContent
-
Reads an instance of FileSearchToolCallContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.FileSearchToolDefinition
-
Reads an instance of FileSearchToolDefinition from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.FileSearchToolDefinitionDetails
-
Reads an instance of FileSearchToolDefinitionDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.FileSearchToolResource
-
Reads an instance of FileSearchToolResource from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.FunctionDefinition
-
Reads an instance of FunctionDefinition from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.FunctionName
-
Reads an instance of FunctionName from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.FunctionToolDefinition
-
Reads an instance of FunctionToolDefinition from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.IncompleteRunDetails
-
Reads an instance of IncompleteRunDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.InternalPersistentAgentsResponseFormat
-
Reads an instance of InternalPersistentAgentsResponseFormat from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageAttachment
-
Reads an instance of MessageAttachment from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageContent
-
Reads an instance of MessageContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageDelta
-
Reads an instance of MessageDelta from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageDeltaChunk
-
Reads an instance of MessageDeltaChunk from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageDeltaContent
-
Reads an instance of MessageDeltaContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageDeltaImageFileContent
-
Reads an instance of MessageDeltaImageFileContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageDeltaImageFileContentObject
-
Reads an instance of MessageDeltaImageFileContentObject from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageDeltaTextAnnotation
-
Reads an instance of MessageDeltaTextAnnotation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageDeltaTextContent
-
Reads an instance of MessageDeltaTextContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageDeltaTextContentObject
-
Reads an instance of MessageDeltaTextContentObject from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFileCitationAnnotation
-
Reads an instance of MessageDeltaTextFileCitationAnnotation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFileCitationAnnotationObject
-
Reads an instance of MessageDeltaTextFileCitationAnnotationObject from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFilePathAnnotation
-
Reads an instance of MessageDeltaTextFilePathAnnotation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFilePathAnnotationObject
-
Reads an instance of MessageDeltaTextFilePathAnnotationObject from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageDeltaTextUrlCitationAnnotation
-
Reads an instance of MessageDeltaTextUrlCitationAnnotation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageDeltaTextUrlCitationDetails
-
Reads an instance of MessageDeltaTextUrlCitationDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageImageFileContent
-
Reads an instance of MessageImageFileContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageImageFileDetails
-
Reads an instance of MessageImageFileDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageImageFileParam
-
Reads an instance of MessageImageFileParam from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageImageUrlParam
-
Reads an instance of MessageImageUrlParam from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageIncompleteDetails
-
Reads an instance of MessageIncompleteDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageInputContentBlock
-
Reads an instance of MessageInputContentBlock from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageInputImageFileBlock
-
Reads an instance of MessageInputImageFileBlock from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageInputImageUrlBlock
-
Reads an instance of MessageInputImageUrlBlock from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageInputTextBlock
-
Reads an instance of MessageInputTextBlock from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageTextAnnotation
-
Reads an instance of MessageTextAnnotation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageTextContent
-
Reads an instance of MessageTextContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageTextDetails
-
Reads an instance of MessageTextDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageTextFileCitationAnnotation
-
Reads an instance of MessageTextFileCitationAnnotation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageTextFileCitationDetails
-
Reads an instance of MessageTextFileCitationDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageTextFilePathAnnotation
-
Reads an instance of MessageTextFilePathAnnotation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageTextFilePathDetails
-
Reads an instance of MessageTextFilePathDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageTextUrlCitationAnnotation
-
Reads an instance of MessageTextUrlCitationAnnotation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.MessageTextUrlCitationDetails
-
Reads an instance of MessageTextUrlCitationDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.OpenApiAnonymousAuthDetails
-
Reads an instance of OpenApiAnonymousAuthDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.OpenApiAuthDetails
-
Reads an instance of OpenApiAuthDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.OpenApiConnectionAuthDetails
-
Reads an instance of OpenApiConnectionAuthDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.OpenApiConnectionSecurityScheme
-
Reads an instance of OpenApiConnectionSecurityScheme from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.OpenApiFunctionDefinition
-
Reads an instance of OpenApiFunctionDefinition from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.OpenApiManagedAuthDetails
-
Reads an instance of OpenApiManagedAuthDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.OpenApiManagedSecurityScheme
-
Reads an instance of OpenApiManagedSecurityScheme from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.OpenApiToolDefinition
-
Reads an instance of OpenApiToolDefinition from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.PersistentAgent
-
Reads an instance of PersistentAgent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.PersistentAgentsNamedToolChoice
-
Reads an instance of PersistentAgentsNamedToolChoice from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.PersistentAgentThread
-
Reads an instance of PersistentAgentThread from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.PersistentAgentThreadCreationOptions
-
Reads an instance of PersistentAgentThreadCreationOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RequiredAction
-
Reads an instance of RequiredAction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RequiredFunctionToolCall
-
Reads an instance of RequiredFunctionToolCall from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RequiredFunctionToolCallDetails
-
Reads an instance of RequiredFunctionToolCallDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RequiredToolCall
-
Reads an instance of RequiredToolCall from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.ResponseFormatJsonSchema
-
Reads an instance of ResponseFormatJsonSchema from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.ResponseFormatJsonSchemaType
-
Reads an instance of ResponseFormatJsonSchemaType from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunCompletionUsage
-
Reads an instance of RunCompletionUsage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunError
-
Reads an instance of RunError from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStep
-
Reads an instance of RunStep from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepAzureAISearchToolCall
-
Reads an instance of RunStepAzureAISearchToolCall from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepBingGroundingToolCall
-
Reads an instance of RunStepBingGroundingToolCall from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterImageOutput
-
Reads an instance of RunStepCodeInterpreterImageOutput from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterImageReference
-
Reads an instance of RunStepCodeInterpreterImageReference from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterLogOutput
-
Reads an instance of RunStepCodeInterpreterLogOutput from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterToolCall
-
Reads an instance of RunStepCodeInterpreterToolCall from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterToolCallDetails
-
Reads an instance of RunStepCodeInterpreterToolCallDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterToolCallOutput
-
Reads an instance of RunStepCodeInterpreterToolCallOutput from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepCompletionUsage
-
Reads an instance of RunStepCompletionUsage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDelta
-
Reads an instance of RunStepDelta from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDeltaChunk
-
Reads an instance of RunStepDeltaChunk from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterDetailItemObject
-
Reads an instance of RunStepDeltaCodeInterpreterDetailItemObject from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterImageOutput
-
Reads an instance of RunStepDeltaCodeInterpreterImageOutput from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterImageOutputObject
-
Reads an instance of RunStepDeltaCodeInterpreterImageOutputObject from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterLogOutput
-
Reads an instance of RunStepDeltaCodeInterpreterLogOutput from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterOutput
-
Reads an instance of RunStepDeltaCodeInterpreterOutput from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterToolCall
-
Reads an instance of RunStepDeltaCodeInterpreterToolCall from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDeltaDetail
-
Reads an instance of RunStepDeltaDetail from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDeltaFileSearchToolCall
-
Reads an instance of RunStepDeltaFileSearchToolCall from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDeltaFunction
-
Reads an instance of RunStepDeltaFunction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDeltaFunctionToolCall
-
Reads an instance of RunStepDeltaFunctionToolCall from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDeltaMessageCreation
-
Reads an instance of RunStepDeltaMessageCreation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDeltaMessageCreationObject
-
Reads an instance of RunStepDeltaMessageCreationObject from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDeltaToolCall
-
Reads an instance of RunStepDeltaToolCall from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDeltaToolCallObject
-
Reads an instance of RunStepDeltaToolCallObject from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepDetails
-
Reads an instance of RunStepDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepError
-
Reads an instance of RunStepError from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepFileSearchToolCall
-
Reads an instance of RunStepFileSearchToolCall from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepFileSearchToolCallResult
-
Reads an instance of RunStepFileSearchToolCallResult from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepFileSearchToolCallResults
-
Reads an instance of RunStepFileSearchToolCallResults from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepFunctionToolCall
-
Reads an instance of RunStepFunctionToolCall from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepFunctionToolCallDetails
-
Reads an instance of RunStepFunctionToolCallDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepMessageCreationDetails
-
Reads an instance of RunStepMessageCreationDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepMessageCreationReference
-
Reads an instance of RunStepMessageCreationReference from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepOpenApiToolCall
-
Reads an instance of RunStepOpenApiToolCall from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepToolCall
-
Reads an instance of RunStepToolCall from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.RunStepToolCallDetails
-
Reads an instance of RunStepToolCallDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.SubmitToolOutputsAction
-
Reads an instance of SubmitToolOutputsAction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.SubmitToolOutputsDetails
-
Reads an instance of SubmitToolOutputsDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.ThreadDeletionStatus
-
Reads an instance of ThreadDeletionStatus from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.ThreadMessage
-
Reads an instance of ThreadMessage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.ThreadMessageOptions
-
Reads an instance of ThreadMessageOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Reads an instance of ThreadRun from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.ToolDefinition
-
Reads an instance of ToolDefinition from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.ToolOutput
-
Reads an instance of ToolOutput from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.ToolResources
-
Reads an instance of ToolResources from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.TruncationObject
-
Reads an instance of TruncationObject from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStore
-
Reads an instance of VectorStore from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreAutoChunkingStrategyRequest
-
Reads an instance of VectorStoreAutoChunkingStrategyRequest from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreAutoChunkingStrategyResponse
-
Reads an instance of VectorStoreAutoChunkingStrategyResponse from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyRequest
-
Reads an instance of VectorStoreChunkingStrategyRequest from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyResponse
-
Reads an instance of VectorStoreChunkingStrategyResponse from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreConfiguration
-
Reads an instance of VectorStoreConfiguration from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreConfigurations
-
Reads an instance of VectorStoreConfigurations from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreDataSource
-
Reads an instance of VectorStoreDataSource from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreDeletionStatus
-
Reads an instance of VectorStoreDeletionStatus from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreExpirationPolicy
-
Reads an instance of VectorStoreExpirationPolicy from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreFile
-
Reads an instance of VectorStoreFile from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreFileBatch
-
Reads an instance of VectorStoreFileBatch from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreFileCount
-
Reads an instance of VectorStoreFileCount from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreFileDeletionStatus
-
Reads an instance of VectorStoreFileDeletionStatus from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreFileError
-
Reads an instance of VectorStoreFileError from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreStaticChunkingStrategyOptions
-
Reads an instance of VectorStoreStaticChunkingStrategyOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreStaticChunkingStrategyRequest
-
Reads an instance of VectorStoreStaticChunkingStrategyRequest from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreStaticChunkingStrategyResponse
-
Reads an instance of VectorStoreStaticChunkingStrategyResponse from the JsonReader.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.AzureAISearchQueryType
-
Creates or finds a AzureAISearchQueryType from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.DoneEvent
-
Creates or finds a DoneEvent from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.ErrorEvent
-
Creates or finds a ErrorEvent from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.FilePurpose
-
Creates or finds a FilePurpose from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.FileState
-
Creates or finds a FileState from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.ImageDetailLevel
-
Creates or finds a ImageDetailLevel from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.IncompleteDetailsReason
-
Creates or finds a IncompleteDetailsReason from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.ListSortOrder
-
Creates or finds a ListSortOrder from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.MessageBlockType
-
Creates or finds a MessageBlockType from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.MessageIncompleteDetailsReason
-
Creates or finds a MessageIncompleteDetailsReason from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.MessageRole
-
Creates or finds a MessageRole from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.MessageStatus
-
Creates or finds a MessageStatus from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.MessageStreamEvent
-
Creates or finds a MessageStreamEvent from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.OpenApiAuthType
-
Creates or finds a OpenApiAuthType from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.PersistentAgentsNamedToolChoiceType
-
Creates or finds a PersistentAgentsNamedToolChoiceType from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.PersistentAgentsResponseFormatMode
-
Creates or finds a PersistentAgentsResponseFormatMode from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.PersistentAgentsToolChoiceOptionMode
-
Creates or finds a PersistentAgentsToolChoiceOptionMode from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Creates or finds a PersistentAgentStreamEvent from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.ResponseFormat
-
Creates or finds a ResponseFormat from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.RunAdditionalFieldList
-
Creates or finds a RunAdditionalFieldList from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.RunStatus
-
Creates or finds a RunStatus from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.RunStepErrorCode
-
Creates or finds a RunStepErrorCode from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.RunStepStatus
-
Creates or finds a RunStepStatus from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.RunStepStreamEvent
-
Creates or finds a RunStepStreamEvent from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.RunStepType
-
Creates or finds a RunStepType from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.RunStreamEvent
-
Creates or finds a RunStreamEvent from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.ThreadStreamEvent
-
Creates or finds a ThreadStreamEvent from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.TruncationStrategy
-
Creates or finds a TruncationStrategy from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyRequestType
-
Creates or finds a VectorStoreChunkingStrategyRequestType from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyResponseType
-
Creates or finds a VectorStoreChunkingStrategyResponseType from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreDataSourceAssetType
-
Creates or finds a VectorStoreDataSourceAssetType from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreExpirationPolicyAnchor
-
Creates or finds a VectorStoreExpirationPolicyAnchor from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreFileBatchStatus
-
Creates or finds a VectorStoreFileBatchStatus from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreFileErrorCode
-
Creates or finds a VectorStoreFileErrorCode from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreFileStatus
-
Creates or finds a VectorStoreFileStatus from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreFileStatusFilter
-
Creates or finds a VectorStoreFileStatusFilter from its string representation.
- fromString(String) - Static method in class com.azure.ai.agents.persistent.models.VectorStoreStatus
-
Creates or finds a VectorStoreStatus from its string representation.
- FUNCTION - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentsNamedToolChoiceType
-
Tool type `function`.
- FunctionDefinition - Class in com.azure.ai.agents.persistent.models
-
The input definition information for a function.
- FunctionDefinition(String, BinaryData) - Constructor for class com.azure.ai.agents.persistent.models.FunctionDefinition
-
Creates an instance of FunctionDefinition class.
- FunctionName - Class in com.azure.ai.agents.persistent.models
-
The function name that will be used, if using the `function` tool.
- FunctionName(String) - Constructor for class com.azure.ai.agents.persistent.models.FunctionName
-
Creates an instance of FunctionName class.
- FunctionToolDefinition - Class in com.azure.ai.agents.persistent.models
-
The input definition information for a function tool as used to configure an agent.
- FunctionToolDefinition(FunctionDefinition) - Constructor for class com.azure.ai.agents.persistent.models.FunctionToolDefinition
-
Creates an instance of FunctionToolDefinition class.
G
- getAdditionalInstructions() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the additionalInstructions property: Additional instructions to append at the end of the instructions for the run.
- getAdditionalMessages() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the additionalMessages property: Adds additional messages to the thread before creating the run.
- getAgent(String) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationAsyncClient
-
Retrieves an existing agent.
- getAgent(String) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClient
-
Retrieves an existing agent.
- getAgentWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationAsyncClient
-
Retrieves an existing agent.
- getAgentWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClient
-
Retrieves an existing agent.
- getAnchor() - Method in class com.azure.ai.agents.persistent.models.VectorStoreExpirationPolicy
-
Get the anchor property: Anchor timestamp after which the expiration policy applies.
- getAnnotations() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextContentObject
-
Get the annotations property: Annotations for the text.
- getAnnotations() - Method in class com.azure.ai.agents.persistent.models.MessageTextDetails
-
Get the annotations property: A list of annotations associated with this text.
- getArguments() - Method in class com.azure.ai.agents.persistent.models.RequiredFunctionToolCallDetails
-
Get the arguments property: The arguments to use when invoking the named function, as provided by the model.
- getArguments() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaFunction
-
Get the arguments property: The arguments passed to the function as input.
- getArguments() - Method in class com.azure.ai.agents.persistent.models.RunStepFunctionToolCallDetails
-
Get the arguments property: The arguments that the model requires are provided to the named function.
- getAssetIdentifier() - Method in class com.azure.ai.agents.persistent.models.VectorStoreDataSource
-
Get the assetIdentifier property: Asset URI.
- getAssetType() - Method in class com.azure.ai.agents.persistent.models.VectorStoreDataSource
-
Get the assetType property: The asset type.
- getAssistantId() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the assistantId property: The ID of the agent that should run the thread.
- getAssistantId() - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Get the assistantId property: The ID of the agent for which the thread should be created.
- getAssistantId() - Method in class com.azure.ai.agents.persistent.models.RunStep
-
Get the assistantId property: The ID of the agent associated with the run step.
- getAssistantId() - Method in class com.azure.ai.agents.persistent.models.ThreadMessage
-
Get the assistantId property: If applicable, the ID of the agent that authored this message.
- getAssistantId() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the assistantId property: The ID of the agent associated with the thread this run was performed against.
- getAssistantId() - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Get the assistantId property: The ID of the agent to modify.
- getAttachments() - Method in class com.azure.ai.agents.persistent.models.ThreadMessage
-
Get the attachments property: A list of files attached to the message, and the tools they were added to.
- getAttachments() - Method in class com.azure.ai.agents.persistent.models.ThreadMessageOptions
-
Get the attachments property: A list of files attached to the message, and the tools they should be added to.
- getAudience() - Method in class com.azure.ai.agents.persistent.models.OpenApiManagedSecurityScheme
-
Get the audience property: Authentication scope for managed_identity auth type.
- getAuth() - Method in class com.azure.ai.agents.persistent.models.OpenApiFunctionDefinition
-
Get the auth property: Open API authentication details.
- getAzureAISearch() - Method in class com.azure.ai.agents.persistent.models.RunStepAzureAISearchToolCall
-
Get the azureAISearch property: Reserved for future use.
- getAzureAISearch() - Method in class com.azure.ai.agents.persistent.models.ToolResources
-
Get the azureAISearch property: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names.
- getAzureFunction() - Method in class com.azure.ai.agents.persistent.models.AzureFunctionToolDefinition
-
Get the azureFunction property: The definition of the concrete function that the function tool should call.
- getBingGrounding() - Method in class com.azure.ai.agents.persistent.models.BingGroundingToolDefinition
-
Get the bingGrounding property: The bing grounding search tool parameters.
- getBingGrounding() - Method in class com.azure.ai.agents.persistent.models.RunStepBingGroundingToolCall
-
Get the bingGrounding property: Reserved for future use.
- getBytes() - Method in class com.azure.ai.agents.persistent.models.FileInfo
-
Get the bytes property: The size of the file, in bytes.
- getCancelled() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileCount
-
Get the cancelled property: The number of files that were cancelled.
- getCancelledAt() - Method in class com.azure.ai.agents.persistent.models.RunStep
-
Get the cancelledAt property: The Unix timestamp, in seconds, representing when this was cancelled.
- getCancelledAt() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the cancelledAt property: The Unix timestamp, in seconds, representing when this was cancelled.
- getChunkingStrategy() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFile
-
Get the chunkingStrategy property: The strategy used to chunk the file.
- getChunkOverlapTokens() - Method in class com.azure.ai.agents.persistent.models.VectorStoreStaticChunkingStrategyOptions
-
Get the chunkOverlapTokens property: The number of tokens that overlap between chunks.
- getCode() - Method in class com.azure.ai.agents.persistent.models.RunError
-
Get the code property: The status for the error.
- getCode() - Method in class com.azure.ai.agents.persistent.models.RunStepError
-
Get the code property: The error code for this error.
- getCode() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileError
-
Get the code property: One of `server_error` or `rate_limit_exceeded`.
- getCodeInterpreter() - Method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterToolCall
-
Get the codeInterpreter property: The details of the tool call to the code interpreter tool.
- getCodeInterpreter() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterToolCall
-
Get the codeInterpreter property: The Code Interpreter data for the tool call.
- getCodeInterpreter() - Method in class com.azure.ai.agents.persistent.models.ToolResources
-
Get the codeInterpreter property: Resources to be used by the `code_interpreter` tool consisting of file IDs.
- getCompleted() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileCount
-
Get the completed property: The number of files that have been successfully processed.
- getCompletedAt() - Method in class com.azure.ai.agents.persistent.models.RunStep
-
Get the completedAt property: The Unix timestamp, in seconds, representing when this completed.
- getCompletedAt() - Method in class com.azure.ai.agents.persistent.models.ThreadMessage
-
Get the completedAt property: The Unix timestamp (in seconds) for when the message was completed.
- getCompletedAt() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the completedAt property: The Unix timestamp, in seconds, representing when this completed.
- getCompletionTokens() - Method in class com.azure.ai.agents.persistent.models.RunCompletionUsage
-
Get the completionTokens property: Number of completion tokens used over the course of the run.
- getCompletionTokens() - Method in class com.azure.ai.agents.persistent.models.RunStepCompletionUsage
-
Get the completionTokens property: Number of completion tokens used over the course of the run step.
- getConnectedAgent() - Method in class com.azure.ai.agents.persistent.models.ConnectedAgentToolDefinition
-
Get the connectedAgent property: The sub-agent to connect.
- getConnectionId() - Method in class com.azure.ai.agents.persistent.models.BingGroundingSearchConfiguration
-
Get the connectionId property: Connection id for grounding with bing search.
- getConnectionId() - Method in class com.azure.ai.agents.persistent.models.OpenApiConnectionSecurityScheme
-
Get the connectionId property: Connection id for Connection auth type.
- getContent() - Method in class com.azure.ai.agents.persistent.models.MessageDelta
-
Get the content property: The content of the message as an array of text and/or images.
- getContent() - Method in class com.azure.ai.agents.persistent.models.RunStepFileSearchToolCallResult
-
Get the content property: The content of the result that was found.
- getContent() - Method in class com.azure.ai.agents.persistent.models.ThreadMessage
-
Get the content property: The list of content items associated with the agent thread message.
- getContent() - Method in class com.azure.ai.agents.persistent.models.ThreadMessageOptions
-
Get the content property: The content of the initial message.
- getCount() - Method in class com.azure.ai.agents.persistent.models.BingGroundingSearchConfiguration
-
Get the count property: The number of search results to return in the bing api response.
- getCreatedAt() - Method in class com.azure.ai.agents.persistent.models.FileInfo
-
Get the createdAt property: The Unix timestamp, in seconds, representing when this object was created.
- getCreatedAt() - Method in class com.azure.ai.agents.persistent.models.PersistentAgent
-
Get the createdAt property: The Unix timestamp, in seconds, representing when this object was created.
- getCreatedAt() - Method in class com.azure.ai.agents.persistent.models.PersistentAgentThread
-
Get the createdAt property: The Unix timestamp, in seconds, representing when this object was created.
- getCreatedAt() - Method in class com.azure.ai.agents.persistent.models.RunStep
-
Get the createdAt property: The Unix timestamp, in seconds, representing when this object was created.
- getCreatedAt() - Method in class com.azure.ai.agents.persistent.models.ThreadMessage
-
Get the createdAt property: The Unix timestamp, in seconds, representing when this object was created.
- getCreatedAt() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the createdAt property: The Unix timestamp, in seconds, representing when this object was created.
- getCreatedAt() - Method in class com.azure.ai.agents.persistent.models.VectorStore
-
Get the createdAt property: The Unix timestamp (in seconds) for when the vector store was created.
- getCreatedAt() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFile
-
Get the createdAt property: The Unix timestamp (in seconds) for when the vector store file was created.
- getCreatedAt() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileBatch
-
Get the createdAt property: The Unix timestamp (in seconds) for when the vector store files batch was created.
- getData() - Method in class com.azure.ai.agents.persistent.models.FileListResponse
-
Get the data property: The files returned for the request.
- getDataSource() - Method in class com.azure.ai.agents.persistent.models.MessageAttachment
-
Get the dataSource property: Azure asset ID.
- getDataSources() - Method in class com.azure.ai.agents.persistent.models.CodeInterpreterToolResource
-
Get the dataSources property: The data sources to be used.
- getDataSources() - Method in class com.azure.ai.agents.persistent.models.VectorStoreConfiguration
-
Get the dataSources property: Data sources.
- getDays() - Method in class com.azure.ai.agents.persistent.models.VectorStoreExpirationPolicy
-
Get the days property: The anchor timestamp after which the expiration policy applies.
- getDefaultParams() - Method in class com.azure.ai.agents.persistent.models.OpenApiFunctionDefinition
-
Get the defaultParams property: List of OpenAPI spec parameters that will use user-provided defaults.
- getDelta() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaChunk
-
Get the delta property: The delta containing the fields that have changed on the Message.
- getDelta() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaChunk
-
Get the delta property: The delta containing the fields that have changed on the run step.
- getDescription() - Method in class com.azure.ai.agents.persistent.models.ConnectedAgentDetails
-
Get the description property: A description of what the agent does, used by the model to choose when and how to call the agent.
- getDescription() - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Get the description property: The description of the new agent.
- getDescription() - Method in class com.azure.ai.agents.persistent.models.FunctionDefinition
-
Get the description property: A description of what the function does, used by the model to choose when and how to call the function.
- getDescription() - Method in class com.azure.ai.agents.persistent.models.OpenApiFunctionDefinition
-
Get the description property: A description of what the function does, used by the model to choose when and how to call the function.
- getDescription() - Method in class com.azure.ai.agents.persistent.models.PersistentAgent
-
Get the description property: The description of the agent.
- getDescription() - Method in class com.azure.ai.agents.persistent.models.ResponseFormatJsonSchema
-
Get the description property: A description of what the response format is for, used by the model to determine how to respond in the format.
- getDescription() - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Get the description property: The modified description for the agent to use.
- getDetail() - Method in class com.azure.ai.agents.persistent.models.MessageImageFileParam
-
Get the detail property: Optional detail level for the image (auto, low, or high).
- getDetail() - Method in class com.azure.ai.agents.persistent.models.MessageImageUrlParam
-
Get the detail property: Optional detail level for the image (auto, low, or high).
- getEndIndex() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFileCitationAnnotation
-
Get the endIndex property: The end index of this annotation in the content text.
- getEndIndex() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFilePathAnnotation
-
Get the endIndex property: The end index of this annotation in the content text.
- getEndIndex() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextUrlCitationAnnotation
-
Get the endIndex property: The last text index associated with this text annotation.
- getEndIndex() - Method in class com.azure.ai.agents.persistent.models.MessageTextFileCitationAnnotation
-
Get the endIndex property: The last text index associated with this text annotation.
- getEndIndex() - Method in class com.azure.ai.agents.persistent.models.MessageTextFilePathAnnotation
-
Get the endIndex property: The last text index associated with this text annotation.
- getEndIndex() - Method in class com.azure.ai.agents.persistent.models.MessageTextUrlCitationAnnotation
-
Get the endIndex property: The last text index associated with this text annotation.
- getEvents() - Method in class com.azure.ai.agents.persistent.models.PersistentAgentServerSentEvents
-
Gets the stream of server sent events.
- getExpiredAt() - Method in class com.azure.ai.agents.persistent.models.RunStep
-
Get the expiredAt property: The Unix timestamp, in seconds, representing when this item expired.
- getExpiresAfter() - Method in class com.azure.ai.agents.persistent.models.VectorStore
-
Get the expiresAfter property: Details on when this vector store expires.
- getExpiresAt() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the expiresAt property: The Unix timestamp, in seconds, representing when this item expires.
- getExpiresAt() - Method in class com.azure.ai.agents.persistent.models.VectorStore
-
Get the expiresAt property: The Unix timestamp (in seconds) for when the vector store will expire.
- getFailed() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileCount
-
Get the failed property: The number of files that have failed to process.
- getFailedAt() - Method in class com.azure.ai.agents.persistent.models.RunStep
-
Get the failedAt property: The Unix timestamp, in seconds, representing when this failed.
- getFailedAt() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the failedAt property: The Unix timestamp, in seconds, representing when this failed.
- getFile(String) - Method in class com.azure.ai.agents.persistent.FilesAsyncClient
-
Returns information about a specific file.
- getFile(String) - Method in class com.azure.ai.agents.persistent.FilesClient
-
Returns information about a specific file.
- getFileCitation() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFileCitationAnnotation
-
Get the fileCitation property: The file citation information.
- getFileCitation() - Method in class com.azure.ai.agents.persistent.models.MessageTextFileCitationAnnotation
-
Get the fileCitation property: A citation within the message that points to a specific quote from a specific file.
- getFileContent(String) - Method in class com.azure.ai.agents.persistent.FilesAsyncClient
-
Retrieves the raw content of a specific file.
- getFileContent(String) - Method in class com.azure.ai.agents.persistent.FilesClient
-
Retrieves the raw content of a specific file.
- getFileContentWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.FilesAsyncClient
-
Retrieves the raw content of a specific file.
- getFileContentWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.FilesClient
-
Retrieves the raw content of a specific file.
- getFileCounts() - Method in class com.azure.ai.agents.persistent.models.VectorStore
-
Get the fileCounts property: Files count grouped by status processed or being processed by this vector store.
- getFileCounts() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileBatch
-
Get the fileCounts property: Files count grouped by status processed or being processed by this vector store.
- getFileId() - Method in class com.azure.ai.agents.persistent.models.MessageAttachment
-
Get the fileId property: The ID of the file to attach to the message.
- getFileId() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaImageFileContentObject
-
Get the fileId property: The file ID of the image in the message content.
- getFileId() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFileCitationAnnotationObject
-
Get the fileId property: The ID of the specific file the citation is from.
- getFileId() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFilePathAnnotationObject
-
Get the fileId property: The file ID for the annotation.
- getFileId() - Method in class com.azure.ai.agents.persistent.models.MessageImageFileDetails
-
Get the fileId property: The ID for the file associated with this image.
- getFileId() - Method in class com.azure.ai.agents.persistent.models.MessageImageFileParam
-
Get the fileId property: The ID of the previously uploaded image file.
- getFileId() - Method in class com.azure.ai.agents.persistent.models.MessageTextFileCitationDetails
-
Get the fileId property: The ID of the file associated with this citation.
- getFileId() - Method in class com.azure.ai.agents.persistent.models.MessageTextFilePathDetails
-
Get the fileId property: The ID of the specific file that the citation is from.
- getFileId() - Method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterImageReference
-
Get the fileId property: The ID of the file associated with this image.
- getFileId() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterImageOutputObject
-
Get the fileId property: The file ID for the image.
- getFileId() - Method in class com.azure.ai.agents.persistent.models.RunStepFileSearchToolCallResult
-
Get the fileId property: The ID of the file that result was found in.
- getFileIds() - Method in class com.azure.ai.agents.persistent.models.CodeInterpreterToolResource
-
Get the fileIds property: A list of file IDs made available to the `code_interpreter` tool.
- getFilename() - Method in class com.azure.ai.agents.persistent.models.FileInfo
-
Get the filename property: The name of the file.
- getFileName() - Method in class com.azure.ai.agents.persistent.models.RunStepFileSearchToolCallResult
-
Get the fileName property: The name of the file that result was found in.
- getFilePath() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFilePathAnnotation
-
Get the filePath property: The file path information.
- getFilePath() - Method in class com.azure.ai.agents.persistent.models.MessageTextFilePathAnnotation
-
Get the filePath property: A URL for the file that's generated when the agent used the code_interpreter tool to generate a file.
- getFileSearch() - Method in class com.azure.ai.agents.persistent.models.FileSearchToolDefinition
-
Get the fileSearch property: Options overrides for the file search tool.
- getFileSearch() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaFileSearchToolCall
-
Get the fileSearch property: Reserved for future use.
- getFileSearch() - Method in class com.azure.ai.agents.persistent.models.RunStepFileSearchToolCall
-
Get the fileSearch property: For now, this is always going to be an empty object.
- getFileSearch() - Method in class com.azure.ai.agents.persistent.models.ToolResources
-
Get the fileSearch property: Resources to be used by the `file_search` tool consisting of vector store IDs.
- getFileWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.FilesAsyncClient
-
Returns information about a specific file.
- getFileWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.FilesClient
-
Returns information about a specific file.
- getFilter() - Method in class com.azure.ai.agents.persistent.models.AISearchIndexResource
-
Get the filter property: filter string for search resource.
- getFreshness() - Method in class com.azure.ai.agents.persistent.models.BingGroundingSearchConfiguration
-
Get the freshness property: Filter search results by a specific time range.
- getFunction() - Method in class com.azure.ai.agents.persistent.models.AzureFunctionDefinition
-
Get the function property: The definition of azure function and its parameters.
- getFunction() - Method in class com.azure.ai.agents.persistent.models.FunctionToolDefinition
-
Get the function property: The definition of the concrete function that the function tool should call.
- getFunction() - Method in class com.azure.ai.agents.persistent.models.PersistentAgentsNamedToolChoice
-
Get the function property: The name of the function to call.
- getFunction() - Method in class com.azure.ai.agents.persistent.models.RequiredFunctionToolCall
-
Get the function property: Detailed information about the function to be executed by the tool that includes name and arguments.
- getFunction() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaFunctionToolCall
-
Get the function property: The function data for the tool call.
- getFunction() - Method in class com.azure.ai.agents.persistent.models.RunStepFunctionToolCall
-
Get the function property: The detailed information about the function called by the model.
- getFunctions() - Method in class com.azure.ai.agents.persistent.models.OpenApiFunctionDefinition
-
Get the functions property: List of function definitions used by OpenApi tool.
- getId() - Method in class com.azure.ai.agents.persistent.models.AgentDeletionStatus
-
Get the id property: The ID of the resource specified for deletion.
- getId() - Method in class com.azure.ai.agents.persistent.models.ConnectedAgentDetails
-
Get the id property: The identifier of the child agent.
- getId() - Method in class com.azure.ai.agents.persistent.models.FileDeletionStatus
-
Get the id property: The ID of the resource specified for deletion.
- getId() - Method in class com.azure.ai.agents.persistent.models.FileInfo
-
Get the id property: The identifier, which can be referenced in API endpoints.
- getId() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaChunk
-
Get the id property: The identifier of the message, which can be referenced in API endpoints.
- getId() - Method in class com.azure.ai.agents.persistent.models.PersistentAgent
-
Get the id property: The identifier, which can be referenced in API endpoints.
- getId() - Method in class com.azure.ai.agents.persistent.models.PersistentAgentThread
-
Get the id property: The identifier, which can be referenced in API endpoints.
- getId() - Method in class com.azure.ai.agents.persistent.models.RequiredToolCall
-
Get the id property: The ID of the tool call.
- getId() - Method in class com.azure.ai.agents.persistent.models.RunStep
-
Get the id property: The identifier, which can be referenced in API endpoints.
- getId() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaChunk
-
Get the id property: The identifier of the run step, which can be referenced in API endpoints.
- getId() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaToolCall
-
Get the id property: The ID of the tool call, used when submitting outputs to the run.
- getId() - Method in class com.azure.ai.agents.persistent.models.RunStepToolCall
-
Get the id property: The ID of the tool call.
- getId() - Method in class com.azure.ai.agents.persistent.models.ThreadDeletionStatus
-
Get the id property: The ID of the resource specified for deletion.
- getId() - Method in class com.azure.ai.agents.persistent.models.ThreadMessage
-
Get the id property: The identifier, which can be referenced in API endpoints.
- getId() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the id property: The identifier, which can be referenced in API endpoints.
- getId() - Method in class com.azure.ai.agents.persistent.models.VectorStore
-
Get the id property: The identifier, which can be referenced in API endpoints.
- getId() - Method in class com.azure.ai.agents.persistent.models.VectorStoreDeletionStatus
-
Get the id property: The ID of the resource specified for deletion.
- getId() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFile
-
Get the id property: The identifier, which can be referenced in API endpoints.
- getId() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileBatch
-
Get the id property: The identifier, which can be referenced in API endpoints.
- getId() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileDeletionStatus
-
Get the id property: The ID of the resource specified for deletion.
- getImage() - Method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterImageOutput
-
Get the image property: Referential information for the image associated with this output.
- getImage() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterImageOutput
-
Get the image property: The image data for the Code Interpreter tool call output.
- getImageFile() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaImageFileContent
-
Get the imageFile property: The image_file data.
- getImageFile() - Method in class com.azure.ai.agents.persistent.models.MessageImageFileContent
-
Get the imageFile property: The image file for this thread message content item.
- getImageFile() - Method in class com.azure.ai.agents.persistent.models.MessageInputImageFileBlock
-
Get the imageFile property: Information about the referenced image file, including file ID and optional detail level.
- getImageUrl() - Method in class com.azure.ai.agents.persistent.models.MessageInputImageUrlBlock
-
Get the imageUrl property: Information about the external image URL, including the URL and optional detail level.
- getInclude() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the include property: A list of additional fields to include in the response.
- getIncompleteAt() - Method in class com.azure.ai.agents.persistent.models.ThreadMessage
-
Get the incompleteAt property: The Unix timestamp (in seconds) for when the message was marked as incomplete.
- getIncompleteDetails() - Method in class com.azure.ai.agents.persistent.models.ThreadMessage
-
Get the incompleteDetails property: On an incomplete message, details about why the message is incomplete.
- getIncompleteDetails() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the incompleteDetails property: Details on why the run is incomplete.
- getIndex() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaContent
-
Get the index property: The index of the content part of the message.
- getIndex() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextAnnotation
-
Get the index property: The index of the annotation within a text content part.
- getIndex() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterOutput
-
Get the index property: The index of the output in the streaming run step tool call's Code Interpreter outputs array.
- getIndex() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaToolCall
-
Get the index property: The index of the tool call detail in the run step's tool_calls array.
- getIndexAssetId() - Method in class com.azure.ai.agents.persistent.models.AISearchIndexResource
-
Get the indexAssetId property: Index asset id for search resource.
- getIndexConnectionId() - Method in class com.azure.ai.agents.persistent.models.AISearchIndexResource
-
Get the indexConnectionId property: An index connection id in an IndexResource attached to this agent.
- getIndexList() - Method in class com.azure.ai.agents.persistent.models.AzureAISearchToolResource
-
Get the indexList property: The indices attached to this agent.
- getIndexName() - Method in class com.azure.ai.agents.persistent.models.AISearchIndexResource
-
Get the indexName property: The name of an index in an IndexResource attached to this agent.
- getInProgress() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileCount
-
Get the inProgress property: The number of files that are currently being processed.
- getInput() - Method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterToolCallDetails
-
Get the input property: The input provided by the model to the code interpreter tool.
- getInput() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterDetailItemObject
-
Get the input property: The input into the Code Interpreter tool call.
- getInputBinding() - Method in class com.azure.ai.agents.persistent.models.AzureFunctionDefinition
-
Get the inputBinding property: Input storage queue.
- getInstructions() - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Get the instructions property: The system instructions for the new agent to use.
- getInstructions() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the instructions property: The overridden system instructions that the agent should use to run the thread.
- getInstructions() - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Get the instructions property: The overridden system instructions the agent should use to run the thread.
- getInstructions() - Method in class com.azure.ai.agents.persistent.models.PersistentAgent
-
Get the instructions property: The system instructions for the agent to use.
- getInstructions() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the instructions property: The overridden system instructions used for this agent thread run.
- getInstructions() - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Get the instructions property: The modified system instructions for the new agent to use.
- getJsonSchema() - Method in class com.azure.ai.agents.persistent.models.ResponseFormatJsonSchemaType
-
Get the jsonSchema property: The JSON schema, describing response format.
- getKind() - Method in class com.azure.ai.agents.persistent.models.StreamUpdate
-
Returns what kind of StreamUpdate this is.
- getLastActiveAt() - Method in class com.azure.ai.agents.persistent.models.VectorStore
-
Get the lastActiveAt property: The Unix timestamp (in seconds) for when the vector store was last active.
- getLastError() - Method in class com.azure.ai.agents.persistent.models.RunStep
-
Get the lastError property: If applicable, information about the last error encountered by this run step.
- getLastError() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the lastError property: The last error, if any, encountered by this agent thread run.
- getLastError() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFile
-
Get the lastError property: The last error associated with this vector store file.
- getLastMessages() - Method in class com.azure.ai.agents.persistent.models.TruncationObject
-
Get the lastMessages property: The number of most recent messages from the thread when constructing the context for the run.
- getLatest() - Static method in enum com.azure.ai.agents.persistent.AgentsServiceVersion
-
Gets the latest service version supported by this client library.
- getLogs() - Method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterLogOutput
-
Get the logs property: The serialized log output emitted by the code interpreter.
- getLogs() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterLogOutput
-
Get the logs property: The text output from the Code Interpreter tool call.
- getMarket() - Method in class com.azure.ai.agents.persistent.models.BingGroundingSearchConfiguration
-
Get the market property: The market where the results come from.
- getMaxChunkSizeTokens() - Method in class com.azure.ai.agents.persistent.models.VectorStoreStaticChunkingStrategyOptions
-
Get the maxChunkSizeTokens property: The maximum number of tokens in each chunk.
- getMaxCompletionTokens() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the maxCompletionTokens property: The maximum number of completion tokens that may be used over the course of the run.
- getMaxCompletionTokens() - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Get the maxCompletionTokens property: The maximum number of completion tokens that may be used over the course of the run.
- getMaxCompletionTokens() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the maxCompletionTokens property: The maximum number of completion tokens specified to have been used over the course of the run.
- getMaxNumResults() - Method in class com.azure.ai.agents.persistent.models.FileSearchToolDefinitionDetails
-
Get the maxNumResults property: The maximum number of results the file search tool should output.
- getMaxPromptTokens() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the maxPromptTokens property: The maximum number of prompt tokens that may be used over the course of the run.
- getMaxPromptTokens() - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Get the maxPromptTokens property: The maximum number of prompt tokens that may be used over the course of the run.
- getMaxPromptTokens() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the maxPromptTokens property: The maximum number of prompt tokens specified to have been used over the course of the run.
- getMessage() - Method in class com.azure.ai.agents.persistent.models.RunError
-
Get the message property: The human-readable text associated with the error.
- getMessage() - Method in class com.azure.ai.agents.persistent.models.RunStepError
-
Get the message property: The human-readable text associated with this error.
- getMessage() - Method in class com.azure.ai.agents.persistent.models.StreamMessageCreation
-
Get the data of this message sent by the service.
- getMessage() - Method in class com.azure.ai.agents.persistent.models.StreamMessageUpdate
-
Get the message incremental delta update sent by the service.
- getMessage() - Method in class com.azure.ai.agents.persistent.models.StreamRequiredAction
-
Get the message detailing the action required by the service.
- getMessage() - Method in class com.azure.ai.agents.persistent.models.StreamRunCreation
-
Get the update with the data about this run step sent by the service.
- getMessage() - Method in class com.azure.ai.agents.persistent.models.StreamRunStepUpdate
-
Get the incremental update sent by the service.
- getMessage() - Method in class com.azure.ai.agents.persistent.models.StreamThreadCreation
-
Get the thread data sent in the update by the service.
- getMessage() - Method in class com.azure.ai.agents.persistent.models.StreamThreadRunCreation
-
Get the thread run with the update sent by the service.
- getMessage() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileError
-
Get the message property: A human-readable description of the error.
- getMessage(String, String) - Method in class com.azure.ai.agents.persistent.MessagesAsyncClient
-
Retrieves an existing message.
- getMessage(String, String) - Method in class com.azure.ai.agents.persistent.MessagesClient
-
Retrieves an existing message.
- getMessageCreation() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaMessageCreation
-
Get the messageCreation property: The message creation data.
- getMessageCreation() - Method in class com.azure.ai.agents.persistent.models.RunStepMessageCreationDetails
-
Get the messageCreation property: Information about the message creation associated with this run step.
- getMessageId() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaMessageCreationObject
-
Get the messageId property: The ID of the newly-created message.
- getMessageId() - Method in class com.azure.ai.agents.persistent.models.RunStepMessageCreationReference
-
Get the messageId property: The ID of the message created by this run step.
- getMessages() - Method in class com.azure.ai.agents.persistent.models.PersistentAgentThreadCreationOptions
-
Get the messages property: The initial messages to associate with the new thread.
- getMessageWithResponse(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.MessagesAsyncClient
-
Retrieves an existing message.
- getMessageWithResponse(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.MessagesClient
-
Retrieves an existing message.
- getMetadata() - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Get the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- getMetadata() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- getMetadata() - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Get the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- getMetadata() - Method in class com.azure.ai.agents.persistent.models.PersistentAgent
-
Get the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- getMetadata() - Method in class com.azure.ai.agents.persistent.models.PersistentAgentThread
-
Get the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- getMetadata() - Method in class com.azure.ai.agents.persistent.models.PersistentAgentThreadCreationOptions
-
Get the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- getMetadata() - Method in class com.azure.ai.agents.persistent.models.RunStep
-
Get the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- getMetadata() - Method in class com.azure.ai.agents.persistent.models.ThreadMessage
-
Get the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- getMetadata() - Method in class com.azure.ai.agents.persistent.models.ThreadMessageOptions
-
Get the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- getMetadata() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- getMetadata() - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Get the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- getMetadata() - Method in class com.azure.ai.agents.persistent.models.VectorStore
-
Get the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- getModel() - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Get the model property: The ID of the model to use.
- getModel() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the model property: The overridden model name that the agent should use to run the thread.
- getModel() - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Get the model property: The overridden model that the agent should use to run the thread.
- getModel() - Method in class com.azure.ai.agents.persistent.models.PersistentAgent
-
Get the model property: The ID of the model to use.
- getModel() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the model property: The ID of the model to use.
- getModel() - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Get the model property: The ID of the model to use.
- getName() - Method in class com.azure.ai.agents.persistent.models.ConnectedAgentDetails
-
Get the name property: The name of the agent to be called.
- getName() - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Get the name property: The name of the new agent.
- getName() - Method in class com.azure.ai.agents.persistent.models.FunctionDefinition
-
Get the name property: The name of the function to be called.
- getName() - Method in class com.azure.ai.agents.persistent.models.FunctionName
-
Get the name property: The name of the function to call.
- getName() - Method in class com.azure.ai.agents.persistent.models.OpenApiFunctionDefinition
-
Get the name property: The name of the function to be called.
- getName() - Method in class com.azure.ai.agents.persistent.models.PersistentAgent
-
Get the name property: The name of the agent.
- getName() - Method in class com.azure.ai.agents.persistent.models.RequiredFunctionToolCallDetails
-
Get the name property: The name of the function.
- getName() - Method in class com.azure.ai.agents.persistent.models.ResponseFormatJsonSchema
-
Get the name property: The name of a schema.
- getName() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaFunction
-
Get the name property: The name of the function.
- getName() - Method in class com.azure.ai.agents.persistent.models.RunStepFunctionToolCallDetails
-
Get the name property: The name of the function.
- getName() - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Get the name property: The modified name for the agent to use.
- getName() - Method in class com.azure.ai.agents.persistent.models.VectorStore
-
Get the name property: The name of the vector store.
- getObject() - Method in class com.azure.ai.agents.persistent.models.AgentDeletionStatus
-
Get the object property: The object type, which is always 'assistant.deleted'.
- getObject() - Method in class com.azure.ai.agents.persistent.models.FileDeletionStatus
-
Get the object property: The object type, which is always 'file'.
- getObject() - Method in class com.azure.ai.agents.persistent.models.FileInfo
-
Get the object property: The object type, which is always 'file'.
- getObject() - Method in class com.azure.ai.agents.persistent.models.FileListResponse
-
Get the object property: The object type, which is always 'list'.
- getObject() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaChunk
-
Get the object property: The object type, which is always `thread.message.delta`.
- getObject() - Method in class com.azure.ai.agents.persistent.models.PersistentAgent
-
Get the object property: The object type, which is always assistant.
- getObject() - Method in class com.azure.ai.agents.persistent.models.PersistentAgentThread
-
Get the object property: The object type, which is always 'thread'.
- getObject() - Method in class com.azure.ai.agents.persistent.models.RunStep
-
Get the object property: The object type, which is always 'thread.run.step'.
- getObject() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaChunk
-
Get the object property: The object type, which is always `thread.run.step.delta`.
- getObject() - Method in class com.azure.ai.agents.persistent.models.ThreadDeletionStatus
-
Get the object property: The object type, which is always 'thread.deleted'.
- getObject() - Method in class com.azure.ai.agents.persistent.models.ThreadMessage
-
Get the object property: The object type, which is always 'thread.message'.
- getObject() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the object property: The object type, which is always 'thread.run'.
- getObject() - Method in class com.azure.ai.agents.persistent.models.VectorStore
-
Get the object property: The object type, which is always `vector_store`.
- getObject() - Method in class com.azure.ai.agents.persistent.models.VectorStoreDeletionStatus
-
Get the object property: The object type, which is always 'vector_store.deleted'.
- getObject() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFile
-
Get the object property: The object type, which is always `vector_store.file`.
- getObject() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileBatch
-
Get the object property: The object type, which is always `vector_store.file_batch`.
- getObject() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileDeletionStatus
-
Get the object property: The object type, which is always 'vector_store.deleted'.
- getOpenapi() - Method in class com.azure.ai.agents.persistent.models.OpenApiToolDefinition
-
Get the openapi property: The openapi function definition.
- getOpenApi() - Method in class com.azure.ai.agents.persistent.models.RunStepOpenApiToolCall
-
Get the openApi property: Reserved for future use.
- getOutput() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaFunction
-
Get the output property: The output of the function, null if outputs have not yet been submitted.
- getOutput() - Method in class com.azure.ai.agents.persistent.models.ToolOutput
-
Get the output property: The output from the tool to be submitted.
- getOutputBinding() - Method in class com.azure.ai.agents.persistent.models.AzureFunctionDefinition
-
Get the outputBinding property: Output storage queue.
- getOutputs() - Method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterToolCallDetails
-
Get the outputs property: The outputs produced by the code interpreter tool back to the model in response to the tool call.
- getOutputs() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterDetailItemObject
-
Get the outputs property: The outputs from the Code Interpreter tool call.
- getParameters() - Method in class com.azure.ai.agents.persistent.models.FunctionDefinition
-
Get the parameters property: The parameters the functions accepts, described as a JSON Schema object.
- getPromptTokens() - Method in class com.azure.ai.agents.persistent.models.RunCompletionUsage
-
Get the promptTokens property: Number of prompt tokens used over the course of the run.
- getPromptTokens() - Method in class com.azure.ai.agents.persistent.models.RunStepCompletionUsage
-
Get the promptTokens property: Number of prompt tokens used over the course of the run step.
- getPurpose() - Method in class com.azure.ai.agents.persistent.models.FileInfo
-
Get the purpose property: The intended purpose of a file.
- getQueryType() - Method in class com.azure.ai.agents.persistent.models.AISearchIndexResource
-
Get the queryType property: Type of query in an AIIndexResource attached to this agent.
- getQueueName() - Method in class com.azure.ai.agents.persistent.models.AzureFunctionStorageQueue
-
Get the queueName property: The name of an Azure function storage queue.
- getQuote() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFileCitationAnnotationObject
-
Get the quote property: The specific quote in the cited file.
- getQuote() - Method in class com.azure.ai.agents.persistent.models.MessageTextFileCitationDetails
-
Get the quote property: The specific quote cited in the associated file.
- getRanker() - Method in class com.azure.ai.agents.persistent.models.FileSearchRankingOptions
-
Get the ranker property: File search ranker.
- getRankingOptions() - Method in class com.azure.ai.agents.persistent.models.FileSearchToolDefinitionDetails
-
Get the rankingOptions property: Ranking options for file search.
- getRankingOptions() - Method in class com.azure.ai.agents.persistent.models.RunStepFileSearchToolCallResults
-
Get the rankingOptions property: Ranking options for file search.
- getReason() - Method in class com.azure.ai.agents.persistent.models.IncompleteRunDetails
-
Get the reason property: The reason why the run is incomplete.
- getReason() - Method in class com.azure.ai.agents.persistent.models.MessageIncompleteDetails
-
Get the reason property: The provided reason describing why the message was marked as incomplete.
- getRequiredAction() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the requiredAction property: The details of the action required for the agent thread run to continue.
- getResponseFormat() - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Get the responseFormat property: The response format of the tool calls used by this agent.
- getResponseFormat() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the responseFormat property: Specifies the format that the model must output.
- getResponseFormat() - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Get the responseFormat property: Specifies the format that the model must output.
- getResponseFormat() - Method in class com.azure.ai.agents.persistent.models.PersistentAgent
-
Get the responseFormat property: The response format of the tool calls used by this agent.
- getResponseFormat() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the responseFormat property: The response format of the tool calls used in this run.
- getResponseFormat() - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Get the responseFormat property: The response format of the tool calls used by this agent.
- getResults() - Method in class com.azure.ai.agents.persistent.models.RunStepFileSearchToolCallResults
-
Get the results property: The array of a file search results.
- getRole() - Method in class com.azure.ai.agents.persistent.models.MessageDelta
-
Get the role property: The entity that produced the message.
- getRole() - Method in class com.azure.ai.agents.persistent.models.ThreadMessage
-
Get the role property: The role associated with the agent thread message.
- getRole() - Method in class com.azure.ai.agents.persistent.models.ThreadMessageOptions
-
Get the role property: The role of the entity that is creating the message.
- getRun(String, String) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Gets an existing run from an existing thread.
- getRun(String, String) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Gets an existing run from an existing thread.
- getRunId() - Method in class com.azure.ai.agents.persistent.models.RunStep
-
Get the runId property: The ID of the run that this run step is a part of.
- getRunId() - Method in class com.azure.ai.agents.persistent.models.ThreadMessage
-
Get the runId property: If applicable, the ID of the run associated with the authoring of this message.
- getRunStep(String, String, String) - Method in class com.azure.ai.agents.persistent.RunStepsAsyncClient
-
Retrieves a single run step from a thread run.
- getRunStep(String, String, String) - Method in class com.azure.ai.agents.persistent.RunStepsClient
-
Retrieves a single run step from a thread run.
- getRunStep(String, String, String, List<RunAdditionalFieldList>) - Method in class com.azure.ai.agents.persistent.RunStepsAsyncClient
-
Retrieves a single run step from a thread run.
- getRunStep(String, String, String, List<RunAdditionalFieldList>) - Method in class com.azure.ai.agents.persistent.RunStepsClient
-
Retrieves a single run step from a thread run.
- getRunStepWithResponse(String, String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.RunStepsAsyncClient
-
Retrieves a single run step from a thread run.
- getRunStepWithResponse(String, String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.RunStepsClient
-
Retrieves a single run step from a thread run.
- getRunWithResponse(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Gets an existing run from an existing thread.
- getRunWithResponse(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Gets an existing run from an existing thread.
- getSchema() - Method in class com.azure.ai.agents.persistent.models.ResponseFormatJsonSchema
-
Get the schema property: The JSON schema object, describing the response format.
- getScore() - Method in class com.azure.ai.agents.persistent.models.RunStepFileSearchToolCallResult
-
Get the score property: The score of the result.
- getScoreThreshold() - Method in class com.azure.ai.agents.persistent.models.FileSearchRankingOptions
-
Get the scoreThreshold property: Ranker search threshold.
- getSearchConfigurations() - Method in class com.azure.ai.agents.persistent.models.BingGroundingSearchToolParameters
-
Get the searchConfigurations property: The search configurations attached to this tool.
- getSecurityScheme() - Method in class com.azure.ai.agents.persistent.models.OpenApiConnectionAuthDetails
-
Get the securityScheme property: Connection auth security details.
- getSecurityScheme() - Method in class com.azure.ai.agents.persistent.models.OpenApiManagedAuthDetails
-
Get the securityScheme property: Connection auth security details.
- getSetLang() - Method in class com.azure.ai.agents.persistent.models.BingGroundingSearchConfiguration
-
Get the setLang property: The language to use for user interface strings when calling Bing API.
- getSpec() - Method in class com.azure.ai.agents.persistent.models.OpenApiFunctionDefinition
-
Get the spec property: The openapi function shape, described as a JSON Schema object.
- getStartedAt() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the startedAt property: The Unix timestamp, in seconds, representing when this item was started.
- getStartIndex() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFileCitationAnnotation
-
Get the startIndex property: The start index of this annotation in the content text.
- getStartIndex() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFilePathAnnotation
-
Get the startIndex property: The start index of this annotation in the content text.
- getStartIndex() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextUrlCitationAnnotation
-
Get the startIndex property: The first text index associated with this text annotation.
- getStartIndex() - Method in class com.azure.ai.agents.persistent.models.MessageTextFileCitationAnnotation
-
Get the startIndex property: The first text index associated with this text annotation.
- getStartIndex() - Method in class com.azure.ai.agents.persistent.models.MessageTextFilePathAnnotation
-
Get the startIndex property: The first text index associated with this text annotation.
- getStartIndex() - Method in class com.azure.ai.agents.persistent.models.MessageTextUrlCitationAnnotation
-
Get the startIndex property: The first text index associated with this text annotation.
- getStaticProperty() - Method in class com.azure.ai.agents.persistent.models.VectorStoreStaticChunkingStrategyRequest
-
Get the staticProperty property: The options for the static chunking strategy.
- getStaticProperty() - Method in class com.azure.ai.agents.persistent.models.VectorStoreStaticChunkingStrategyResponse
-
Get the staticProperty property: The options for the static chunking strategy.
- getStatus() - Method in class com.azure.ai.agents.persistent.models.FileInfo
-
Get the status property: The state of the file.
- getStatus() - Method in class com.azure.ai.agents.persistent.models.RunStep
-
Get the status property: The status of this run step.
- getStatus() - Method in class com.azure.ai.agents.persistent.models.ThreadMessage
-
Get the status property: The status of the message.
- getStatus() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the status property: The status of the agent thread run.
- getStatus() - Method in class com.azure.ai.agents.persistent.models.VectorStore
-
Get the status property: The status of the vector store, which can be either `expired`, `in_progress`, or `completed`.
- getStatus() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFile
-
Get the status property: The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`.
- getStatus() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileBatch
-
Get the status property: The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`.
- getStatusDetails() - Method in class com.azure.ai.agents.persistent.models.FileInfo
-
Get the statusDetails property: The error message with details in case processing of this file failed.
- getStepDetails() - Method in class com.azure.ai.agents.persistent.models.RunStep
-
Get the stepDetails property: The details for this run step.
- getStepDetails() - Method in class com.azure.ai.agents.persistent.models.RunStepDelta
-
Get the stepDetails property: The details of the run step.
- getStorageQueue() - Method in class com.azure.ai.agents.persistent.models.AzureFunctionBinding
-
Get the storageQueue property: Storage queue.
- getStorageServiceEndpoint() - Method in class com.azure.ai.agents.persistent.models.AzureFunctionStorageQueue
-
Get the storageServiceEndpoint property: URI to the Azure Storage Queue service allowing you to manipulate a queue.
- getStoreConfiguration() - Method in class com.azure.ai.agents.persistent.models.VectorStoreConfigurations
-
Get the storeConfiguration property: Configurations.
- getStoreName() - Method in class com.azure.ai.agents.persistent.models.VectorStoreConfigurations
-
Get the storeName property: Name.
- getSubmitToolOutputs() - Method in class com.azure.ai.agents.persistent.models.SubmitToolOutputsAction
-
Get the submitToolOutputs property: The details describing tools that should be called to submit tool outputs.
- getTemperature() - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Get the temperature property: What sampling temperature to use, between 0 and 2.
- getTemperature() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the temperature property: What sampling temperature to use, between 0 and 2.
- getTemperature() - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Get the temperature property: What sampling temperature to use, between 0 and 2.
- getTemperature() - Method in class com.azure.ai.agents.persistent.models.PersistentAgent
-
Get the temperature property: What sampling temperature to use, between 0 and 2.
- getTemperature() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the temperature property: The sampling temperature used for this run.
- getTemperature() - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Get the temperature property: What sampling temperature to use, between 0 and 2.
- getText() - Method in class com.azure.ai.agents.persistent.models.FileSearchToolCallContent
-
Get the text property: The text content of the file.
- getText() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextContent
-
Get the text property: The text content details.
- getText() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFileCitationAnnotation
-
Get the text property: The text in the message content that needs to be replaced.
- getText() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFilePathAnnotation
-
Get the text property: The text in the message content that needs to be replaced.
- getText() - Method in class com.azure.ai.agents.persistent.models.MessageInputTextBlock
-
Get the text property: The plain text content for this block.
- getText() - Method in class com.azure.ai.agents.persistent.models.MessageTextAnnotation
-
Get the text property: The textual content associated with this text annotation item.
- getText() - Method in class com.azure.ai.agents.persistent.models.MessageTextContent
-
Get the text property: The text and associated annotations for this thread message content item.
- getThread() - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Get the thread property: The details used to create the new thread.
- getThread(String) - Method in class com.azure.ai.agents.persistent.ThreadsAsyncClient
-
Gets information about an existing thread.
- getThread(String) - Method in class com.azure.ai.agents.persistent.ThreadsClient
-
Gets information about an existing thread.
- getThreadId() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the threadId property: Identifier of the thread.
- getThreadId() - Method in class com.azure.ai.agents.persistent.models.RunStep
-
Get the threadId property: The ID of the thread that was run.
- getThreadId() - Method in class com.azure.ai.agents.persistent.models.ThreadMessage
-
Get the threadId property: The ID of the thread that this message belongs to.
- getThreadId() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the threadId property: The ID of the thread associated with this run.
- getThreadWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.ThreadsAsyncClient
-
Gets information about an existing thread.
- getThreadWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.ThreadsClient
-
Gets information about an existing thread.
- Getting started - Search tag in Overview
- Section
- getTitle() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextUrlCitationDetails
-
Get the title property: The title of the URL.
- getTitle() - Method in class com.azure.ai.agents.persistent.models.MessageTextUrlCitationDetails
-
Get the title property: The title of the URL.
- getToolCallId() - Method in class com.azure.ai.agents.persistent.models.ToolOutput
-
Get the toolCallId property: The ID of the tool call being resolved, as provided in the tool calls of a required action from a run.
- getToolCalls() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaToolCallObject
-
Get the toolCalls property: The collection of tool calls for the tool call detail item.
- getToolCalls() - Method in class com.azure.ai.agents.persistent.models.RunStepToolCallDetails
-
Get the toolCalls property: A list of tool call details for this run step.
- getToolCalls() - Method in class com.azure.ai.agents.persistent.models.SubmitToolOutputsDetails
-
Get the toolCalls property: The list of tool calls that must be resolved for the agent thread run to continue.
- getToolChoice() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the toolChoice property: Controls whether or not and which tool is called by the model.
- getToolChoice() - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Get the toolChoice property: Controls whether or not and which tool is called by the model.
- getToolChoice() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the toolChoice property: Controls whether or not and which tool is called by the model.
- getToolResources() - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Get the toolResources property: A set of resources that are used by the agent's tools.
- getToolResources() - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Get the toolResources property: Override the tools the agent can use for this run.
- getToolResources() - Method in class com.azure.ai.agents.persistent.models.PersistentAgent
-
Get the toolResources property: A set of resources that are used by the agent's tools.
- getToolResources() - Method in class com.azure.ai.agents.persistent.models.PersistentAgentThread
-
Get the toolResources property: A set of resources that are made available to the agent's tools in this thread.
- getToolResources() - Method in class com.azure.ai.agents.persistent.models.PersistentAgentThreadCreationOptions
-
Get the toolResources property: A set of resources that are made available to the agent's tools in this thread.
- getToolResources() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the toolResources property: Override the tools the agent can use for this run.
- getToolResources() - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Get the toolResources property: A set of resources that are used by the agent's tools.
- getTools() - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Get the tools property: The collection of tools to enable for the new agent.
- getTools() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the tools property: The overridden list of enabled tools that the agent should use to run the thread.
- getTools() - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Get the tools property: The overridden list of enabled tools the agent should use to run the thread.
- getTools() - Method in class com.azure.ai.agents.persistent.models.MessageAttachment
-
Get the tools property: The tools to add to this file.
- getTools() - Method in class com.azure.ai.agents.persistent.models.PersistentAgent
-
Get the tools property: The collection of tools enabled for the agent.
- getTools() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the tools property: The overridden enabled tools used for this agent thread run.
- getTools() - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Get the tools property: The modified collection of tools to enable for the agent.
- getTopK() - Method in class com.azure.ai.agents.persistent.models.AISearchIndexResource
-
Get the topK property: Number of documents to retrieve from search and present to the model.
- getTopP() - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Get the topP property: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
- getTopP() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the topP property: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
- getTopP() - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Get the topP property: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
- getTopP() - Method in class com.azure.ai.agents.persistent.models.PersistentAgent
-
Get the topP property: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
- getTopP() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the topP property: The nucleus sampling value used for this run.
- getTopP() - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Get the topP property: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
- getTotal() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileCount
-
Get the total property: The total number of files.
- getTotalTokens() - Method in class com.azure.ai.agents.persistent.models.RunCompletionUsage
-
Get the totalTokens property: Total number of tokens used (prompt + completion).
- getTotalTokens() - Method in class com.azure.ai.agents.persistent.models.RunStepCompletionUsage
-
Get the totalTokens property: Total number of tokens used (prompt + completion).
- getTruncationStrategy() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the truncationStrategy property: The strategy to use for dropping messages as the context windows moves forward.
- getTruncationStrategy() - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Get the truncationStrategy property: The strategy to use for dropping messages as the context windows moves forward.
- getTruncationStrategy() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the truncationStrategy property: The strategy to use for dropping messages as the context windows moves forward.
- getType() - Method in class com.azure.ai.agents.persistent.models.AzureAISearchToolDefinition
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.AzureFunctionBinding
-
Get the type property: The type of binding, which is always 'storage_queue'.
- getType() - Method in class com.azure.ai.agents.persistent.models.AzureFunctionToolDefinition
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.BingGroundingToolDefinition
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.CodeInterpreterToolDefinition
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.ConnectedAgentToolDefinition
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.FileSearchToolCallContent
-
Get the type property: The type of the content.
- getType() - Method in class com.azure.ai.agents.persistent.models.FileSearchToolDefinition
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.FunctionToolDefinition
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.InternalPersistentAgentsResponseFormat
-
Get the type property: Must be one of `text` or `json_object`.
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageContent
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaContent
-
Get the type property: The type of content for this content part.
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaImageFileContent
-
Get the type property: The type of content for this content part.
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextAnnotation
-
Get the type property: The type of the text content annotation.
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextContent
-
Get the type property: The type of content for this content part.
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFileCitationAnnotation
-
Get the type property: The type of the text content annotation.
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFilePathAnnotation
-
Get the type property: The type of the text content annotation.
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextUrlCitationAnnotation
-
Get the type property: The type of the text content annotation.
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageImageFileContent
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageInputContentBlock
-
Get the type property: Specifies which kind of content block this is (text, image_file, image_url, etc.).
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageInputImageFileBlock
-
Get the type property: Specifies which kind of content block this is (text, image_file, image_url, etc.).
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageInputImageUrlBlock
-
Get the type property: Specifies which kind of content block this is (text, image_file, image_url, etc.).
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageInputTextBlock
-
Get the type property: Specifies which kind of content block this is (text, image_file, image_url, etc.).
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageTextAnnotation
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageTextContent
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageTextFileCitationAnnotation
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageTextFilePathAnnotation
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.MessageTextUrlCitationAnnotation
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.OpenApiAnonymousAuthDetails
-
Get the type property: The type of authentication, must be anonymous/connection/managed_identity.
- getType() - Method in class com.azure.ai.agents.persistent.models.OpenApiAuthDetails
-
Get the type property: The type of authentication, must be anonymous/connection/managed_identity.
- getType() - Method in class com.azure.ai.agents.persistent.models.OpenApiConnectionAuthDetails
-
Get the type property: The type of authentication, must be anonymous/connection/managed_identity.
- getType() - Method in class com.azure.ai.agents.persistent.models.OpenApiManagedAuthDetails
-
Get the type property: The type of authentication, must be anonymous/connection/managed_identity.
- getType() - Method in class com.azure.ai.agents.persistent.models.OpenApiToolDefinition
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.PersistentAgentsNamedToolChoice
-
Get the type property: the type of tool.
- getType() - Method in class com.azure.ai.agents.persistent.models.RequiredAction
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.RequiredFunctionToolCall
-
Get the type property: The object type for the required tool call.
- getType() - Method in class com.azure.ai.agents.persistent.models.RequiredToolCall
-
Get the type property: The object type for the required tool call.
- getType() - Method in class com.azure.ai.agents.persistent.models.ResponseFormatJsonSchemaType
-
Get the type property: Type.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStep
-
Get the type property: The type of run step, which can be either message_creation or tool_calls.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepAzureAISearchToolCall
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepBingGroundingToolCall
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterImageOutput
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterLogOutput
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterToolCall
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterToolCallOutput
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterImageOutput
-
Get the type property: The type of the streaming run step tool call's Code Interpreter output.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterLogOutput
-
Get the type property: The type of the streaming run step tool call's Code Interpreter output.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterOutput
-
Get the type property: The type of the streaming run step tool call's Code Interpreter output.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterToolCall
-
Get the type property: The type of the tool call detail item in a streaming run step's details.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaDetail
-
Get the type property: The object type for the run step detail object.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaFileSearchToolCall
-
Get the type property: The type of the tool call detail item in a streaming run step's details.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaFunctionToolCall
-
Get the type property: The type of the tool call detail item in a streaming run step's details.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaMessageCreation
-
Get the type property: The object type for the run step detail object.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaToolCall
-
Get the type property: The type of the tool call detail item in a streaming run step's details.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaToolCallObject
-
Get the type property: The object type for the run step detail object.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepDetails
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepFileSearchToolCall
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepFunctionToolCall
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepMessageCreationDetails
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepOpenApiToolCall
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepToolCall
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.RunStepToolCallDetails
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.SubmitToolOutputsAction
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.ToolDefinition
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.TruncationObject
-
Get the type property: The truncation strategy to use for the thread.
- getType() - Method in class com.azure.ai.agents.persistent.models.VectorStoreAutoChunkingStrategyRequest
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.VectorStoreAutoChunkingStrategyResponse
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyRequest
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyResponse
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.VectorStoreStaticChunkingStrategyRequest
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.agents.persistent.models.VectorStoreStaticChunkingStrategyResponse
-
Get the type property: The object type.
- getUrl() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextUrlCitationDetails
-
Get the url property: The URL associated with this citation.
- getUrl() - Method in class com.azure.ai.agents.persistent.models.MessageImageUrlParam
-
Get the url property: The publicly accessible URL of the external image.
- getUrl() - Method in class com.azure.ai.agents.persistent.models.MessageTextUrlCitationDetails
-
Get the url property: The URL associated with this citation.
- getUrlCitation() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextUrlCitationAnnotation
-
Get the urlCitation property: The details of the URL citation.
- getUrlCitation() - Method in class com.azure.ai.agents.persistent.models.MessageTextUrlCitationAnnotation
-
Get the urlCitation property: The details of the URL citation.
- getUsage() - Method in class com.azure.ai.agents.persistent.models.RunStep
-
Get the usage property: Usage statistics related to the run step.
- getUsage() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the usage property: Usage statistics related to the run.
- getUsageBytes() - Method in class com.azure.ai.agents.persistent.models.VectorStore
-
Get the usageBytes property: The total number of bytes used by the files in the vector store.
- getUsageBytes() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFile
-
Get the usageBytes property: The total vector store usage in bytes.
- getValue() - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextContentObject
-
Get the value property: The data that makes up the text.
- getValue() - Method in class com.azure.ai.agents.persistent.models.MessageTextDetails
-
Get the value property: The text data.
- getVectorStore(String) - Method in class com.azure.ai.agents.persistent.VectorStoresAsyncClient
-
Returns the vector store object matching the specified ID.
- getVectorStore(String) - Method in class com.azure.ai.agents.persistent.VectorStoresClient
-
Returns the vector store object matching the specified ID.
- getVectorStoreFile(String, String) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesAsyncClient
-
Retrieves a vector store file.
- getVectorStoreFile(String, String) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesClient
-
Retrieves a vector store file.
- getVectorStoreFileBatch(String, String) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesAsyncClient
-
Retrieve a vector store file batch.
- getVectorStoreFileBatch(String, String) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesClient
-
Retrieve a vector store file batch.
- getVectorStoreFileBatchWithResponse(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesAsyncClient
-
Retrieve a vector store file batch.
- getVectorStoreFileBatchWithResponse(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesClient
-
Retrieve a vector store file batch.
- getVectorStoreFileWithResponse(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesAsyncClient
-
Retrieves a vector store file.
- getVectorStoreFileWithResponse(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesClient
-
Retrieves a vector store file.
- getVectorStoreId() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFile
-
Get the vectorStoreId property: The ID of the vector store that the file is attached to.
- getVectorStoreId() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileBatch
-
Get the vectorStoreId property: The ID of the vector store that the file is attached to.
- getVectorStoreIds() - Method in class com.azure.ai.agents.persistent.models.FileSearchToolResource
-
Get the vectorStoreIds property: The ID of the vector store attached to this agent.
- getVectorStores() - Method in class com.azure.ai.agents.persistent.models.FileSearchToolResource
-
Get the vectorStores property: The list of vector store configuration objects from Azure.
- getVectorStoreWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoresAsyncClient
-
Returns the vector store object matching the specified ID.
- getVectorStoreWithResponse(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoresClient
-
Returns the vector store object matching the specified ID.
- getVersion() - Method in enum com.azure.ai.agents.persistent.AgentsServiceVersion
H
- handleCurrentEvent(String, List<StreamUpdate>) - Method in class com.azure.ai.agents.persistent.models.PersistentAgentServerSentEvents
-
Handles a collected event from the byte buffer which is formated as a UTF_8 string.
- HIGH - Static variable in class com.azure.ai.agents.persistent.models.ImageDetailLevel
-
Use a higher detail level—potentially more resource-intensive.
- httpClient(HttpClient) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
.
- httpLogOptions(HttpLogOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
.
I
- ID_ASSET - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreDataSourceAssetType
-
The data ID.
- IMAGE_FILE - Static variable in class com.azure.ai.agents.persistent.models.MessageBlockType
-
Indicates a block referencing an internally uploaded image file.
- IMAGE_URL - Static variable in class com.azure.ai.agents.persistent.models.MessageBlockType
-
Indicates a block referencing an external image URL.
- ImageDetailLevel - Class in com.azure.ai.agents.persistent.models
-
Specifies an image's detail level.
- ImageDetailLevel() - Constructor for class com.azure.ai.agents.persistent.models.ImageDetailLevel
-
Deprecated.Use the
ImageDetailLevel.fromString(String)factory method. - IN_PROGRESS - Static variable in class com.azure.ai.agents.persistent.models.MessageStatus
-
A run is currently creating this message.
- IN_PROGRESS - Static variable in class com.azure.ai.agents.persistent.models.RunStatus
-
Represents a run that is in progress.
- IN_PROGRESS - Static variable in class com.azure.ai.agents.persistent.models.RunStepStatus
-
Represents a run step still in progress.
- IN_PROGRESS - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreFileBatchStatus
-
The vector store is still processing this file batch.
- IN_PROGRESS - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreFileStatus
-
The file is currently being processed.
- IN_PROGRESS - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreFileStatusFilter
-
Retrieve only files that are currently being processed.
- IN_PROGRESS - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreStatus
-
in_progress status indicates that this vector store is still processing files.
- INCOMPLETE - Static variable in class com.azure.ai.agents.persistent.models.MessageStatus
-
This message is incomplete.
- IncompleteDetailsReason - Class in com.azure.ai.agents.persistent.models
-
The reason why the run is incomplete.
- IncompleteDetailsReason() - Constructor for class com.azure.ai.agents.persistent.models.IncompleteDetailsReason
-
Deprecated.Use the
IncompleteDetailsReason.fromString(String)factory method. - IncompleteRunDetails - Class in com.azure.ai.agents.persistent.models
-
Details on why the run is incomplete.
- InternalPersistentAgentsResponseFormat - Class in com.azure.ai.agents.persistent.models
-
An object describing the expected output of the model.
- InternalPersistentAgentsResponseFormat() - Constructor for class com.azure.ai.agents.persistent.models.InternalPersistentAgentsResponseFormat
-
Creates an instance of InternalPersistentAgentsResponseFormat class.
- INVALID_FILE - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreFileErrorCode
-
The file is not valid.
- isDeleted() - Method in class com.azure.ai.agents.persistent.models.AgentDeletionStatus
-
Get the deleted property: A value indicating whether deletion was successful.
- isDeleted() - Method in class com.azure.ai.agents.persistent.models.FileDeletionStatus
-
Get the deleted property: A value indicating whether deletion was successful.
- isDeleted() - Method in class com.azure.ai.agents.persistent.models.ThreadDeletionStatus
-
Get the deleted property: A value indicating whether deletion was successful.
- isDeleted() - Method in class com.azure.ai.agents.persistent.models.VectorStoreDeletionStatus
-
Get the deleted property: A value indicating whether deletion was successful.
- isDeleted() - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileDeletionStatus
-
Get the deleted property: A value indicating whether deletion was successful.
- isParallelToolCalls() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the parallelToolCalls property: If `true` functions will run in parallel during tool use.
- isParallelToolCalls() - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Get the parallelToolCalls property: If `true` functions will run in parallel during tool use.
- isParallelToolCalls() - Method in class com.azure.ai.agents.persistent.models.ThreadRun
-
Get the parallelToolCalls property: Determines if tools can be executed in parallel within the run.
- isStream() - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Get the stream property: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.
- isStream() - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Get the stream property: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.
J
- JSON_OBJECT - Static variable in class com.azure.ai.agents.persistent.models.ResponseFormat
-
Using `json_object` format will limit the usage of ToolCall to only functions.
K
- Key concepts - Search tag in Overview
- Section
L
- LAST_ACTIVE_AT - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreExpirationPolicyAnchor
-
The expiration policy is based on the last time the vector store was active.
- LAST_MESSAGES - Static variable in class com.azure.ai.agents.persistent.models.TruncationStrategy
-
The thread will truncate to the `lastMessages` count of recent messages.
- listAgents() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationAsyncClient
-
Gets a list of agents that were previously created.
- listAgents() - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClient
-
Gets a list of agents that were previously created.
- listAgents(RequestOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationAsyncClient
-
Gets a list of agents that were previously created.
- listAgents(RequestOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClient
-
Gets a list of agents that were previously created.
- listAgents(Integer, ListSortOrder, String, String) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationAsyncClient
-
Gets a list of agents that were previously created.
- listAgents(Integer, ListSortOrder, String, String) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClient
-
Gets a list of agents that were previously created.
- listFiles() - Method in class com.azure.ai.agents.persistent.FilesAsyncClient
-
Gets a list of previously uploaded files.
- listFiles() - Method in class com.azure.ai.agents.persistent.FilesClient
-
Gets a list of previously uploaded files.
- listFiles(FilePurpose) - Method in class com.azure.ai.agents.persistent.FilesAsyncClient
-
Gets a list of previously uploaded files.
- listFiles(FilePurpose) - Method in class com.azure.ai.agents.persistent.FilesClient
-
Gets a list of previously uploaded files.
- listFilesWithResponse(RequestOptions) - Method in class com.azure.ai.agents.persistent.FilesAsyncClient
-
Gets a list of previously uploaded files.
- listFilesWithResponse(RequestOptions) - Method in class com.azure.ai.agents.persistent.FilesClient
-
Gets a list of previously uploaded files.
- listMessages(String) - Method in class com.azure.ai.agents.persistent.MessagesAsyncClient
-
Gets a list of messages that exist on a thread.
- listMessages(String) - Method in class com.azure.ai.agents.persistent.MessagesClient
-
Gets a list of messages that exist on a thread.
- listMessages(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.MessagesAsyncClient
-
Gets a list of messages that exist on a thread.
- listMessages(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.MessagesClient
-
Gets a list of messages that exist on a thread.
- listMessages(String, String, Integer, ListSortOrder, String, String) - Method in class com.azure.ai.agents.persistent.MessagesAsyncClient
-
Gets a list of messages that exist on a thread.
- listMessages(String, String, Integer, ListSortOrder, String, String) - Method in class com.azure.ai.agents.persistent.MessagesClient
-
Gets a list of messages that exist on a thread.
- listRuns(String) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Gets a list of runs for a specified thread.
- listRuns(String) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Gets a list of runs for a specified thread.
- listRuns(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Gets a list of runs for a specified thread.
- listRuns(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Gets a list of runs for a specified thread.
- listRuns(String, Integer, ListSortOrder, String, String) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Gets a list of runs for a specified thread.
- listRuns(String, Integer, ListSortOrder, String, String) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Gets a list of runs for a specified thread.
- listRunSteps(String, String) - Method in class com.azure.ai.agents.persistent.RunStepsAsyncClient
-
Gets a list of run steps from a thread run.
- listRunSteps(String, String) - Method in class com.azure.ai.agents.persistent.RunStepsClient
-
Gets a list of run steps from a thread run.
- listRunSteps(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.RunStepsAsyncClient
-
Gets a list of run steps from a thread run.
- listRunSteps(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.RunStepsClient
-
Gets a list of run steps from a thread run.
- listRunSteps(String, String, List<RunAdditionalFieldList>, Integer, ListSortOrder, String, String) - Method in class com.azure.ai.agents.persistent.RunStepsAsyncClient
-
Gets a list of run steps from a thread run.
- listRunSteps(String, String, List<RunAdditionalFieldList>, Integer, ListSortOrder, String, String) - Method in class com.azure.ai.agents.persistent.RunStepsClient
-
Gets a list of run steps from a thread run.
- ListSortOrder - Class in com.azure.ai.agents.persistent.models
-
The available sorting options when requesting a list of response objects.
- ListSortOrder() - Constructor for class com.azure.ai.agents.persistent.models.ListSortOrder
-
Deprecated.Use the
ListSortOrder.fromString(String)factory method. - listThreads() - Method in class com.azure.ai.agents.persistent.ThreadsAsyncClient
-
Gets a list of threads that were previously created.
- listThreads() - Method in class com.azure.ai.agents.persistent.ThreadsClient
-
Gets a list of threads that were previously created.
- listThreads(RequestOptions) - Method in class com.azure.ai.agents.persistent.ThreadsAsyncClient
-
Gets a list of threads that were previously created.
- listThreads(RequestOptions) - Method in class com.azure.ai.agents.persistent.ThreadsClient
-
Gets a list of threads that were previously created.
- listThreads(Integer, ListSortOrder, String, String) - Method in class com.azure.ai.agents.persistent.ThreadsAsyncClient
-
Gets a list of threads that were previously created.
- listThreads(Integer, ListSortOrder, String, String) - Method in class com.azure.ai.agents.persistent.ThreadsClient
-
Gets a list of threads that were previously created.
- listVectorStoreFileBatchFiles(String, String) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesAsyncClient
-
Returns a list of vector store files in a batch.
- listVectorStoreFileBatchFiles(String, String) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesClient
-
Returns a list of vector store files in a batch.
- listVectorStoreFileBatchFiles(String, String, VectorStoreFileStatusFilter, Integer, ListSortOrder, String, String) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesAsyncClient
-
Returns a list of vector store files in a batch.
- listVectorStoreFileBatchFiles(String, String, VectorStoreFileStatusFilter, Integer, ListSortOrder, String, String) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesClient
-
Returns a list of vector store files in a batch.
- listVectorStoreFileBatchFiles(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesAsyncClient
-
Returns a list of vector store files in a batch.
- listVectorStoreFileBatchFiles(String, String, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoreFileBatchesClient
-
Returns a list of vector store files in a batch.
- listVectorStoreFiles(String) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesAsyncClient
-
Returns a list of vector store files.
- listVectorStoreFiles(String) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesClient
-
Returns a list of vector store files.
- listVectorStoreFiles(String, VectorStoreFileStatusFilter, Integer, ListSortOrder, String, String) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesAsyncClient
-
Returns a list of vector store files.
- listVectorStoreFiles(String, VectorStoreFileStatusFilter, Integer, ListSortOrder, String, String) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesClient
-
Returns a list of vector store files.
- listVectorStoreFiles(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesAsyncClient
-
Returns a list of vector store files.
- listVectorStoreFiles(String, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoreFilesClient
-
Returns a list of vector store files.
- listVectorStores() - Method in class com.azure.ai.agents.persistent.VectorStoresAsyncClient
-
Returns a list of vector stores.
- listVectorStores() - Method in class com.azure.ai.agents.persistent.VectorStoresClient
-
Returns a list of vector stores.
- listVectorStores(RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoresAsyncClient
-
Returns a list of vector stores.
- listVectorStores(RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoresClient
-
Returns a list of vector stores.
- listVectorStores(Integer, ListSortOrder, String, String) - Method in class com.azure.ai.agents.persistent.VectorStoresAsyncClient
-
Returns a list of vector stores.
- listVectorStores(Integer, ListSortOrder, String, String) - Method in class com.azure.ai.agents.persistent.VectorStoresClient
-
Returns a list of vector stores.
- LOW - Static variable in class com.azure.ai.agents.persistent.models.ImageDetailLevel
-
Use a lower detail level to reduce bandwidth or cost.
M
- MANAGED_IDENTITY - Static variable in class com.azure.ai.agents.persistent.models.OpenApiAuthType
-
Static value managed_identity for OpenApiAuthType.
- MAX_COMPLETION_TOKENS - Static variable in class com.azure.ai.agents.persistent.models.IncompleteDetailsReason
-
Maximum completion tokens exceeded.
- MAX_PROMPT_TOKENS - Static variable in class com.azure.ai.agents.persistent.models.IncompleteDetailsReason
-
Maximum prompt tokens exceeded.
- MAX_TOKENS - Static variable in class com.azure.ai.agents.persistent.models.MessageIncompleteDetailsReason
-
The run generating the message exhausted available tokens before completion.
- MESSAGE_CREATION - Static variable in class com.azure.ai.agents.persistent.models.RunStepType
-
Represents a run step to create a message.
- MessageAttachment - Class in com.azure.ai.agents.persistent.models
-
This describes to which tools a file has been attached.
- MessageAttachment(List<BinaryData>) - Constructor for class com.azure.ai.agents.persistent.models.MessageAttachment
-
Creates an instance of MessageAttachment class.
- MessageBlockType - Class in com.azure.ai.agents.persistent.models
-
Specifies the kind of content block within a message.
- MessageBlockType() - Constructor for class com.azure.ai.agents.persistent.models.MessageBlockType
-
Deprecated.Use the
MessageBlockType.fromString(String)factory method. - MessageContent - Class in com.azure.ai.agents.persistent.models
-
An abstract representation of a single item of thread message content.
- MessageContent() - Constructor for class com.azure.ai.agents.persistent.models.MessageContent
-
Creates an instance of MessageContent class.
- MessageDelta - Class in com.azure.ai.agents.persistent.models
-
Represents the typed 'delta' payload within a streaming message delta chunk.
- MessageDeltaChunk - Class in com.azure.ai.agents.persistent.models
-
Represents a message delta i.e. any changed fields on a message during streaming.
- MessageDeltaContent - Class in com.azure.ai.agents.persistent.models
-
The abstract base representation of a partial streamed message content payload.
- MessageDeltaContent(int) - Constructor for class com.azure.ai.agents.persistent.models.MessageDeltaContent
-
Creates an instance of MessageDeltaContent class.
- MessageDeltaImageFileContent - Class in com.azure.ai.agents.persistent.models
-
Represents a streamed image file content part within a streaming message delta chunk.
- MessageDeltaImageFileContentObject - Class in com.azure.ai.agents.persistent.models
-
Represents the 'image_file' payload within streaming image file content.
- MessageDeltaTextAnnotation - Class in com.azure.ai.agents.persistent.models
-
The abstract base representation of a streamed text content part's text annotation.
- MessageDeltaTextAnnotation(int) - Constructor for class com.azure.ai.agents.persistent.models.MessageDeltaTextAnnotation
-
Creates an instance of MessageDeltaTextAnnotation class.
- MessageDeltaTextContent - Class in com.azure.ai.agents.persistent.models
-
Represents a streamed text content part within a streaming message delta chunk.
- MessageDeltaTextContentObject - Class in com.azure.ai.agents.persistent.models
-
Represents the data of a streamed text content part within a streaming message delta chunk.
- MessageDeltaTextFileCitationAnnotation - Class in com.azure.ai.agents.persistent.models
-
Represents a streamed file citation applied to a streaming text content part.
- MessageDeltaTextFileCitationAnnotationObject - Class in com.azure.ai.agents.persistent.models
-
Represents the data of a streamed file citation as applied to a streaming text content part.
- MessageDeltaTextFilePathAnnotation - Class in com.azure.ai.agents.persistent.models
-
Represents a streamed file path annotation applied to a streaming text content part.
- MessageDeltaTextFilePathAnnotationObject - Class in com.azure.ai.agents.persistent.models
-
Represents the data of a streamed file path annotation as applied to a streaming text content part.
- MessageDeltaTextUrlCitationAnnotation - Class in com.azure.ai.agents.persistent.models
-
A citation within the message that points to a specific URL associated with the message.
- MessageDeltaTextUrlCitationDetails - Class in com.azure.ai.agents.persistent.models
-
A representation of a URL citation, as used in text thread message content.
- MessageImageFileContent - Class in com.azure.ai.agents.persistent.models
-
A representation of image file content in a thread message.
- MessageImageFileDetails - Class in com.azure.ai.agents.persistent.models
-
An image reference, as represented in thread message content.
- MessageImageFileParam - Class in com.azure.ai.agents.persistent.models
-
Defines how an internally uploaded image file is referenced when creating an image-file block.
- MessageImageFileParam(String) - Constructor for class com.azure.ai.agents.persistent.models.MessageImageFileParam
-
Creates an instance of MessageImageFileParam class.
- MessageImageUrlParam - Class in com.azure.ai.agents.persistent.models
-
Defines how an external image URL is referenced when creating an image-URL block.
- MessageImageUrlParam(String) - Constructor for class com.azure.ai.agents.persistent.models.MessageImageUrlParam
-
Creates an instance of MessageImageUrlParam class.
- MessageIncompleteDetails - Class in com.azure.ai.agents.persistent.models
-
Information providing additional detail about a message entering an incomplete status.
- MessageIncompleteDetailsReason - Class in com.azure.ai.agents.persistent.models
-
A set of reasons describing why a message is marked as incomplete.
- MessageIncompleteDetailsReason() - Constructor for class com.azure.ai.agents.persistent.models.MessageIncompleteDetailsReason
-
Deprecated.Use the
MessageIncompleteDetailsReason.fromString(String)factory method. - MessageInputContentBlock - Class in com.azure.ai.agents.persistent.models
-
Defines a single content block when creating a message.
- MessageInputContentBlock() - Constructor for class com.azure.ai.agents.persistent.models.MessageInputContentBlock
-
Creates an instance of MessageInputContentBlock class.
- MessageInputImageFileBlock - Class in com.azure.ai.agents.persistent.models
-
An image-file block in a new message, referencing an internally uploaded image by file ID.
- MessageInputImageFileBlock(MessageImageFileParam) - Constructor for class com.azure.ai.agents.persistent.models.MessageInputImageFileBlock
-
Creates an instance of MessageInputImageFileBlock class.
- MessageInputImageUrlBlock - Class in com.azure.ai.agents.persistent.models
-
An image-URL block in a new message, referencing an external image by URL.
- MessageInputImageUrlBlock(MessageImageUrlParam) - Constructor for class com.azure.ai.agents.persistent.models.MessageInputImageUrlBlock
-
Creates an instance of MessageInputImageUrlBlock class.
- MessageInputTextBlock - Class in com.azure.ai.agents.persistent.models
-
A text block in a new message, containing plain text content.
- MessageInputTextBlock(String) - Constructor for class com.azure.ai.agents.persistent.models.MessageInputTextBlock
-
Creates an instance of MessageInputTextBlock class.
- MessageRole - Class in com.azure.ai.agents.persistent.models
-
The possible values for roles attributed to messages in a thread.
- MessageRole() - Constructor for class com.azure.ai.agents.persistent.models.MessageRole
-
Deprecated.Use the
MessageRole.fromString(String)factory method. - MessagesAsyncClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the asynchronous PersistentAgentsAdministrationClient type.
- MessagesClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the synchronous PersistentAgentsAdministrationClient type.
- MessageStatus - Class in com.azure.ai.agents.persistent.models
-
The possible execution status values for a thread message.
- MessageStatus() - Constructor for class com.azure.ai.agents.persistent.models.MessageStatus
-
Deprecated.Use the
MessageStatus.fromString(String)factory method. - MessageStreamEvent - Class in com.azure.ai.agents.persistent.models
-
Message operation related streaming events.
- MessageStreamEvent() - Constructor for class com.azure.ai.agents.persistent.models.MessageStreamEvent
-
Deprecated.Use the
MessageStreamEvent.fromString(String)factory method. - MessageTextAnnotation - Class in com.azure.ai.agents.persistent.models
-
An abstract representation of an annotation to text thread message content.
- MessageTextAnnotation(String) - Constructor for class com.azure.ai.agents.persistent.models.MessageTextAnnotation
-
Creates an instance of MessageTextAnnotation class.
- MessageTextContent - Class in com.azure.ai.agents.persistent.models
-
A representation of a textual item of thread message content.
- MessageTextDetails - Class in com.azure.ai.agents.persistent.models
-
The text and associated annotations for a single item of agent thread message content.
- MessageTextFileCitationAnnotation - Class in com.azure.ai.agents.persistent.models
-
A citation within the message that points to a specific quote from a specific File associated with the agent or the message.
- MessageTextFileCitationDetails - Class in com.azure.ai.agents.persistent.models
-
A representation of a file-based text citation, as used in a file-based annotation of text thread message content.
- MessageTextFilePathAnnotation - Class in com.azure.ai.agents.persistent.models
-
A citation within the message that points to a file located at a specific path.
- MessageTextFilePathDetails - Class in com.azure.ai.agents.persistent.models
-
An encapsulation of an image file ID, as used by message image content.
- MessageTextUrlCitationAnnotation - Class in com.azure.ai.agents.persistent.models
-
A citation within the message that points to a specific URL associated with the message.
- MessageTextUrlCitationDetails - Class in com.azure.ai.agents.persistent.models
-
A representation of a URL citation, as used in text thread message content.
- modifyVectorStore(String) - Method in class com.azure.ai.agents.persistent.VectorStoresAsyncClient
-
Modifies an existing vector store.
- modifyVectorStore(String) - Method in class com.azure.ai.agents.persistent.VectorStoresClient
-
Modifies an existing vector store.
- modifyVectorStore(String, String, VectorStoreExpirationPolicy, Map<String, String>) - Method in class com.azure.ai.agents.persistent.VectorStoresAsyncClient
-
Modifies an existing vector store.
- modifyVectorStore(String, String, VectorStoreExpirationPolicy, Map<String, String>) - Method in class com.azure.ai.agents.persistent.VectorStoresClient
-
Modifies an existing vector store.
- modifyVectorStoreWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoresAsyncClient
-
Modifies an existing vector store.
- modifyVectorStoreWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.VectorStoresClient
-
Modifies an existing vector store.
N
- Next steps - Search tag in Overview
- Section
- NONE - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentsResponseFormatMode
-
Setting the value to `none`, will result in a 400 Bad request.
- NONE - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentsToolChoiceOptionMode
-
The model will not call a function and instead generates a message.
O
- OpenApiAnonymousAuthDetails - Class in com.azure.ai.agents.persistent.models
-
Security details for OpenApi anonymous authentication.
- OpenApiAnonymousAuthDetails() - Constructor for class com.azure.ai.agents.persistent.models.OpenApiAnonymousAuthDetails
-
Creates an instance of OpenApiAnonymousAuthDetails class.
- OpenApiAuthDetails - Class in com.azure.ai.agents.persistent.models
-
authentication details for OpenApiFunctionDefinition.
- OpenApiAuthDetails() - Constructor for class com.azure.ai.agents.persistent.models.OpenApiAuthDetails
-
Creates an instance of OpenApiAuthDetails class.
- OpenApiAuthType - Class in com.azure.ai.agents.persistent.models
-
Authentication type for OpenApi endpoint.
- OpenApiAuthType() - Constructor for class com.azure.ai.agents.persistent.models.OpenApiAuthType
-
Deprecated.Use the
OpenApiAuthType.fromString(String)factory method. - OpenApiConnectionAuthDetails - Class in com.azure.ai.agents.persistent.models
-
Security details for OpenApi connection authentication.
- OpenApiConnectionAuthDetails(OpenApiConnectionSecurityScheme) - Constructor for class com.azure.ai.agents.persistent.models.OpenApiConnectionAuthDetails
-
Creates an instance of OpenApiConnectionAuthDetails class.
- OpenApiConnectionSecurityScheme - Class in com.azure.ai.agents.persistent.models
-
Security scheme for OpenApi managed_identity authentication.
- OpenApiConnectionSecurityScheme(String) - Constructor for class com.azure.ai.agents.persistent.models.OpenApiConnectionSecurityScheme
-
Creates an instance of OpenApiConnectionSecurityScheme class.
- OpenApiFunctionDefinition - Class in com.azure.ai.agents.persistent.models
-
The input definition information for an openapi function.
- OpenApiFunctionDefinition(String, BinaryData, OpenApiAuthDetails) - Constructor for class com.azure.ai.agents.persistent.models.OpenApiFunctionDefinition
-
Creates an instance of OpenApiFunctionDefinition class.
- OpenApiManagedAuthDetails - Class in com.azure.ai.agents.persistent.models
-
Security details for OpenApi managed_identity authentication.
- OpenApiManagedAuthDetails(OpenApiManagedSecurityScheme) - Constructor for class com.azure.ai.agents.persistent.models.OpenApiManagedAuthDetails
-
Creates an instance of OpenApiManagedAuthDetails class.
- OpenApiManagedSecurityScheme - Class in com.azure.ai.agents.persistent.models
-
Security scheme for OpenApi managed_identity authentication.
- OpenApiManagedSecurityScheme(String) - Constructor for class com.azure.ai.agents.persistent.models.OpenApiManagedSecurityScheme
-
Creates an instance of OpenApiManagedSecurityScheme class.
- OpenApiToolDefinition - Class in com.azure.ai.agents.persistent.models
-
The input definition information for an OpenAPI tool as used to configure an agent.
- OpenApiToolDefinition(OpenApiFunctionDefinition) - Constructor for class com.azure.ai.agents.persistent.models.OpenApiToolDefinition
-
Creates an instance of OpenApiToolDefinition class.
- OTHER - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyResponseType
-
Static value other for VectorStoreChunkingStrategyResponseType.
P
- PENDING - Static variable in class com.azure.ai.agents.persistent.models.FileState
-
The operation was created and is not queued to be processed in the future.
- PersistentAgent - Class in com.azure.ai.agents.persistent.models
-
Represents an agent that can call the model and use tools.
- PersistentAgentsAdministrationAsyncClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the asynchronous PersistentAgentsAdministrationClient type.
- PersistentAgentsAdministrationClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the synchronous PersistentAgentsAdministrationClient type.
- PersistentAgentsAdministrationClientBuilder - Class in com.azure.ai.agents.persistent
-
A builder for creating a new instance of the PersistentAgentsAdministrationClient type.
- PersistentAgentsAdministrationClientBuilder() - Constructor for class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Create an instance of the PersistentAgentsAdministrationClientBuilder.
- PersistentAgentServerSentEvents - Class in com.azure.ai.agents.persistent.models
-
A class that handles the deserialization of server sent events.
- PersistentAgentServerSentEvents(Flux<ByteBuffer>) - Constructor for class com.azure.ai.agents.persistent.models.PersistentAgentServerSentEvents
-
Creates a new instance of PersistentAgentServerSentEvents.
- PersistentAgentsNamedToolChoice - Class in com.azure.ai.agents.persistent.models
-
Specifies a tool the model should use.
- PersistentAgentsNamedToolChoice(PersistentAgentsNamedToolChoiceType) - Constructor for class com.azure.ai.agents.persistent.models.PersistentAgentsNamedToolChoice
-
Creates an instance of PersistentAgentsNamedToolChoice class.
- PersistentAgentsNamedToolChoiceType - Class in com.azure.ai.agents.persistent.models
-
Available tool types for agents named tools.
- PersistentAgentsNamedToolChoiceType() - Constructor for class com.azure.ai.agents.persistent.models.PersistentAgentsNamedToolChoiceType
-
Deprecated.Use the
PersistentAgentsNamedToolChoiceType.fromString(String)factory method. - PersistentAgentsResponseFormatMode - Class in com.azure.ai.agents.persistent.models
-
Represents the mode in which the model will handle the return format of a tool call.
- PersistentAgentsResponseFormatMode() - Constructor for class com.azure.ai.agents.persistent.models.PersistentAgentsResponseFormatMode
-
Deprecated.Use the
PersistentAgentsResponseFormatMode.fromString(String)factory method. - PersistentAgentsToolChoiceOptionMode - Class in com.azure.ai.agents.persistent.models
-
Specifies how the tool choice will be used.
- PersistentAgentsToolChoiceOptionMode() - Constructor for class com.azure.ai.agents.persistent.models.PersistentAgentsToolChoiceOptionMode
-
Deprecated.Use the
PersistentAgentsToolChoiceOptionMode.fromString(String)factory method. - PersistentAgentStreamEvent - Class in com.azure.ai.agents.persistent.models
-
Each event in a server-sent events stream has an `event` and `data` property: ``` event: thread.created data: {"id": "thread_123", "object": "thread", ...} ``` We emit events whenever a new object is created, transitions to a new state, or is being streamed in parts (deltas).
- PersistentAgentStreamEvent() - Constructor for class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Deprecated.Use the
PersistentAgentStreamEvent.fromString(String)factory method. - PersistentAgentThread - Class in com.azure.ai.agents.persistent.models
-
Information about a single thread associated with an agent.
- PersistentAgentThreadCreationOptions - Class in com.azure.ai.agents.persistent.models
-
The details used to create a new agent thread.
- PersistentAgentThreadCreationOptions() - Constructor for class com.azure.ai.agents.persistent.models.PersistentAgentThreadCreationOptions
-
Creates an instance of PersistentAgentThreadCreationOptions class.
- pipeline(HttpPipeline) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
.
- Prerequisites - Search tag in Overview
- Section
- PROCESSED - Static variable in class com.azure.ai.agents.persistent.models.FileState
-
The operation has successfully processed and is ready for consumption.
Q
- QUEUED - Static variable in class com.azure.ai.agents.persistent.models.RunStatus
-
Represents a run that is queued to start.
R
- RATE_LIMIT_EXCEEDED - Static variable in class com.azure.ai.agents.persistent.models.RunStepErrorCode
-
Represents an error indicating configured rate limits were exceeded.
- RequiredAction - Class in com.azure.ai.agents.persistent.models
-
An abstract representation of a required action for an agent thread run to continue.
- RequiredAction() - Constructor for class com.azure.ai.agents.persistent.models.RequiredAction
-
Creates an instance of RequiredAction class.
- RequiredFunctionToolCall - Class in com.azure.ai.agents.persistent.models
-
A representation of a requested call to a function tool, needed by the model to continue evaluation of a run.
- RequiredFunctionToolCallDetails - Class in com.azure.ai.agents.persistent.models
-
The detailed information for a function invocation, as provided by a required action invoking a function tool, that includes the name of and arguments to the function.
- RequiredToolCall - Class in com.azure.ai.agents.persistent.models
-
An abstract representation of a tool invocation needed by the model to continue a run.
- RequiredToolCall(String) - Constructor for class com.azure.ai.agents.persistent.models.RequiredToolCall
-
Creates an instance of RequiredToolCall class.
- REQUIRES_ACTION - Static variable in class com.azure.ai.agents.persistent.models.RunStatus
-
Represents a run that needs another operation, such as tool output submission, to continue.
- ResponseFormat - Class in com.azure.ai.agents.persistent.models
-
Possible API response formats.
- ResponseFormat() - Constructor for class com.azure.ai.agents.persistent.models.ResponseFormat
-
Deprecated.Use the
ResponseFormat.fromString(String)factory method. - ResponseFormatJsonSchema - Class in com.azure.ai.agents.persistent.models
-
A description of what the response format is for, used by the model to determine how to respond in the format.
- ResponseFormatJsonSchema(String, BinaryData) - Constructor for class com.azure.ai.agents.persistent.models.ResponseFormatJsonSchema
-
Creates an instance of ResponseFormatJsonSchema class.
- ResponseFormatJsonSchemaType - Class in com.azure.ai.agents.persistent.models
-
The type of response format being defined: `json_schema`.
- ResponseFormatJsonSchemaType(ResponseFormatJsonSchema) - Constructor for class com.azure.ai.agents.persistent.models.ResponseFormatJsonSchemaType
-
Creates an instance of ResponseFormatJsonSchemaType class.
- retryOptions(RetryOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
.
- retryPolicy(RetryPolicy) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Sets The retry policy that will attempt to retry failed requests, if applicable.
- RUN_CANCELLED - Static variable in class com.azure.ai.agents.persistent.models.MessageIncompleteDetailsReason
-
The run generating the message was cancelled before completion.
- RUN_EXPIRED - Static variable in class com.azure.ai.agents.persistent.models.MessageIncompleteDetailsReason
-
The run generating the message expired.
- RUN_FAILED - Static variable in class com.azure.ai.agents.persistent.models.MessageIncompleteDetailsReason
-
The run generating the message failed.
- RunAdditionalFieldList - Class in com.azure.ai.agents.persistent.models
-
A list of additional fields to include in the response.
- RunAdditionalFieldList() - Constructor for class com.azure.ai.agents.persistent.models.RunAdditionalFieldList
-
Deprecated.Use the
RunAdditionalFieldList.fromString(String)factory method. - RunCompletionUsage - Class in com.azure.ai.agents.persistent.models
-
Usage statistics related to the run.
- RunError - Class in com.azure.ai.agents.persistent.models
-
The details of an error as encountered by an agent thread run.
- RUNNING - Static variable in class com.azure.ai.agents.persistent.models.FileState
-
The operation has started to be processed.
- RunsAsyncClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the asynchronous PersistentAgentsAdministrationClient type.
- RunsClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the synchronous PersistentAgentsAdministrationClient type.
- RunStatus - Class in com.azure.ai.agents.persistent.models
-
Possible values for the status of an agent thread run.
- RunStatus() - Constructor for class com.azure.ai.agents.persistent.models.RunStatus
-
Deprecated.Use the
RunStatus.fromString(String)factory method. - RunStep - Class in com.azure.ai.agents.persistent.models
-
Detailed information about a single step of an agent thread run.
- RunStepAzureAISearchToolCall - Class in com.azure.ai.agents.persistent.models
-
A record of a call to an Azure AI Search tool, issued by the model in evaluation of a defined tool, that represents executed Azure AI search.
- RunStepBingGroundingToolCall - Class in com.azure.ai.agents.persistent.models
-
A record of a call to a bing grounding tool, issued by the model in evaluation of a defined tool, that represents executed search with bing grounding.
- RunStepCodeInterpreterImageOutput - Class in com.azure.ai.agents.persistent.models
-
A representation of an image output emitted by a code interpreter tool in response to a tool call by the model.
- RunStepCodeInterpreterImageReference - Class in com.azure.ai.agents.persistent.models
-
An image reference emitted by a code interpreter tool in response to a tool call by the model.
- RunStepCodeInterpreterLogOutput - Class in com.azure.ai.agents.persistent.models
-
A representation of a log output emitted by a code interpreter tool in response to a tool call by the model.
- RunStepCodeInterpreterToolCall - Class in com.azure.ai.agents.persistent.models
-
A record of a call to a code interpreter tool, issued by the model in evaluation of a defined tool, that represents inputs and outputs consumed and emitted by the code interpreter.
- RunStepCodeInterpreterToolCallDetails - Class in com.azure.ai.agents.persistent.models
-
The detailed information about a code interpreter invocation by the model.
- RunStepCodeInterpreterToolCallOutput - Class in com.azure.ai.agents.persistent.models
-
An abstract representation of an emitted output from a code interpreter tool.
- RunStepCodeInterpreterToolCallOutput() - Constructor for class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterToolCallOutput
-
Creates an instance of RunStepCodeInterpreterToolCallOutput class.
- RunStepCompletionUsage - Class in com.azure.ai.agents.persistent.models
-
Usage statistics related to the run step.
- RunStepDelta - Class in com.azure.ai.agents.persistent.models
-
Represents the delta payload in a streaming run step delta chunk.
- RunStepDeltaChunk - Class in com.azure.ai.agents.persistent.models
-
Represents a run step delta i.e. any changed fields on a run step during streaming.
- RunStepDeltaCodeInterpreterDetailItemObject - Class in com.azure.ai.agents.persistent.models
-
Represents the Code Interpreter tool call data in a streaming run step's tool calls.
- RunStepDeltaCodeInterpreterImageOutput - Class in com.azure.ai.agents.persistent.models
-
Represents an image output as produced the Code interpreter tool and as represented in a streaming run step's delta tool calls collection.
- RunStepDeltaCodeInterpreterImageOutputObject - Class in com.azure.ai.agents.persistent.models
-
Represents the data for a streaming run step's Code Interpreter tool call image output.
- RunStepDeltaCodeInterpreterLogOutput - Class in com.azure.ai.agents.persistent.models
-
Represents a log output as produced by the Code Interpreter tool and as represented in a streaming run step's delta tool calls collection.
- RunStepDeltaCodeInterpreterOutput - Class in com.azure.ai.agents.persistent.models
-
The abstract base representation of a streaming run step tool call's Code Interpreter tool output.
- RunStepDeltaCodeInterpreterOutput(int) - Constructor for class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterOutput
-
Creates an instance of RunStepDeltaCodeInterpreterOutput class.
- RunStepDeltaCodeInterpreterToolCall - Class in com.azure.ai.agents.persistent.models
-
Represents a Code Interpreter tool call within a streaming run step's tool call details.
- RunStepDeltaDetail - Class in com.azure.ai.agents.persistent.models
-
Represents a single run step detail item in a streaming run step's delta payload.
- RunStepDeltaDetail() - Constructor for class com.azure.ai.agents.persistent.models.RunStepDeltaDetail
-
Creates an instance of RunStepDeltaDetail class.
- RunStepDeltaFileSearchToolCall - Class in com.azure.ai.agents.persistent.models
-
Represents a file search tool call within a streaming run step's tool call details.
- RunStepDeltaFunction - Class in com.azure.ai.agents.persistent.models
-
Represents the function data in a streaming run step delta's function tool call.
- RunStepDeltaFunctionToolCall - Class in com.azure.ai.agents.persistent.models
-
Represents a function tool call within a streaming run step's tool call details.
- RunStepDeltaMessageCreation - Class in com.azure.ai.agents.persistent.models
-
Represents a message creation within a streaming run step delta.
- RunStepDeltaMessageCreationObject - Class in com.azure.ai.agents.persistent.models
-
Represents the data within a streaming run step message creation response object.
- RunStepDeltaToolCall - Class in com.azure.ai.agents.persistent.models
-
The abstract base representation of a single tool call within a streaming run step's delta tool call details.
- RunStepDeltaToolCall(int, String) - Constructor for class com.azure.ai.agents.persistent.models.RunStepDeltaToolCall
-
Creates an instance of RunStepDeltaToolCall class.
- RunStepDeltaToolCallObject - Class in com.azure.ai.agents.persistent.models
-
Represents an invocation of tool calls as part of a streaming run step.
- RunStepDetails - Class in com.azure.ai.agents.persistent.models
-
An abstract representation of the details for a run step.
- RunStepDetails() - Constructor for class com.azure.ai.agents.persistent.models.RunStepDetails
-
Creates an instance of RunStepDetails class.
- RunStepError - Class in com.azure.ai.agents.persistent.models
-
The error information associated with a failed run step.
- RunStepErrorCode - Class in com.azure.ai.agents.persistent.models
-
Possible error code values attributable to a failed run step.
- RunStepErrorCode() - Constructor for class com.azure.ai.agents.persistent.models.RunStepErrorCode
-
Deprecated.Use the
RunStepErrorCode.fromString(String)factory method. - RunStepFileSearchToolCall - Class in com.azure.ai.agents.persistent.models
-
A record of a call to a file search tool, issued by the model in evaluation of a defined tool, that represents executed file search.
- RunStepFileSearchToolCallResult - Class in com.azure.ai.agents.persistent.models
-
File search tool call result.
- RunStepFileSearchToolCallResults - Class in com.azure.ai.agents.persistent.models
-
The results of the file search.
- RunStepFunctionToolCall - Class in com.azure.ai.agents.persistent.models
-
A record of a call to a function tool, issued by the model in evaluation of a defined tool, that represents the inputs and output consumed and emitted by the specified function.
- RunStepFunctionToolCallDetails - Class in com.azure.ai.agents.persistent.models
-
The detailed information about the function called by the model.
- RunStepMessageCreationDetails - Class in com.azure.ai.agents.persistent.models
-
The detailed information associated with a message creation run step.
- RunStepMessageCreationReference - Class in com.azure.ai.agents.persistent.models
-
The details of a message created as a part of a run step.
- RunStepOpenApiToolCall - Class in com.azure.ai.agents.persistent.models
-
A record of a call to an OpenAPI tool, issued by the model in evaluation of a defined tool, that represents executed OpenAPI operations.
- RunStepsAsyncClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the asynchronous PersistentAgentsAdministrationClient type.
- RunStepsClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the synchronous PersistentAgentsAdministrationClient type.
- RunStepStatus - Class in com.azure.ai.agents.persistent.models
-
Possible values for the status of a run step.
- RunStepStatus() - Constructor for class com.azure.ai.agents.persistent.models.RunStepStatus
-
Deprecated.Use the
RunStepStatus.fromString(String)factory method. - RunStepStreamEvent - Class in com.azure.ai.agents.persistent.models
-
Run step operation related streaming events.
- RunStepStreamEvent() - Constructor for class com.azure.ai.agents.persistent.models.RunStepStreamEvent
-
Deprecated.Use the
RunStepStreamEvent.fromString(String)factory method. - RunStepToolCall - Class in com.azure.ai.agents.persistent.models
-
An abstract representation of a detailed tool call as recorded within a run step for an existing run.
- RunStepToolCall(String) - Constructor for class com.azure.ai.agents.persistent.models.RunStepToolCall
-
Creates an instance of RunStepToolCall class.
- RunStepToolCallDetails - Class in com.azure.ai.agents.persistent.models
-
The detailed information associated with a run step calling tools.
- RunStepType - Class in com.azure.ai.agents.persistent.models
-
The possible types of run steps.
- RunStepType() - Constructor for class com.azure.ai.agents.persistent.models.RunStepType
-
Deprecated.Use the
RunStepType.fromString(String)factory method. - RunStreamEvent - Class in com.azure.ai.agents.persistent.models
-
Run operation related streaming events.
- RunStreamEvent() - Constructor for class com.azure.ai.agents.persistent.models.RunStreamEvent
-
Deprecated.Use the
RunStreamEvent.fromString(String)factory method.
S
- Select a service API version - Search tag in Overview
- Section
- SEMANTIC - Static variable in class com.azure.ai.agents.persistent.models.AzureAISearchQueryType
-
Query type `semantic`.
- SERVER_ERROR - Static variable in class com.azure.ai.agents.persistent.models.RunStepErrorCode
-
Represents a server error.
- SERVER_ERROR - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreFileErrorCode
-
An server error occurred.
- Service API versions - Search tag in Overview
- Section
- serviceVersion(AgentsServiceVersion) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClientBuilder
-
Sets Service version.
- setAdditionalInstructions(String) - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Set the additionalInstructions property: Additional instructions to append at the end of the instructions for the run.
- setAdditionalMessages(List<ThreadMessageOptions>) - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Set the additionalMessages property: Adds additional messages to the thread before creating the run.
- setAttachments(List<MessageAttachment>) - Method in class com.azure.ai.agents.persistent.models.ThreadMessageOptions
-
Set the attachments property: A list of files attached to the message, and the tools they should be added to.
- setAzureAISearch(AzureAISearchToolResource) - Method in class com.azure.ai.agents.persistent.models.ToolResources
-
Set the azureAISearch property: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names.
- setCodeInterpreter(CodeInterpreterToolResource) - Method in class com.azure.ai.agents.persistent.models.ToolResources
-
Set the codeInterpreter property: Resources to be used by the `code_interpreter` tool consisting of file IDs.
- setCount(Long) - Method in class com.azure.ai.agents.persistent.models.BingGroundingSearchConfiguration
-
Set the count property: The number of search results to return in the bing api response.
- setDataSource(VectorStoreDataSource) - Method in class com.azure.ai.agents.persistent.models.MessageAttachment
-
Set the dataSource property: Azure asset ID.
- setDataSources(List<VectorStoreDataSource>) - Method in class com.azure.ai.agents.persistent.models.CodeInterpreterToolResource
-
Set the dataSources property: The data sources to be used.
- setDefaultParams(List<String>) - Method in class com.azure.ai.agents.persistent.models.OpenApiFunctionDefinition
-
Set the defaultParams property: List of OpenAPI spec parameters that will use user-provided defaults.
- setDescription(String) - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Set the description property: The description of the new agent.
- setDescription(String) - Method in class com.azure.ai.agents.persistent.models.FunctionDefinition
-
Set the description property: A description of what the function does, used by the model to choose when and how to call the function.
- setDescription(String) - Method in class com.azure.ai.agents.persistent.models.OpenApiFunctionDefinition
-
Set the description property: A description of what the function does, used by the model to choose when and how to call the function.
- setDescription(String) - Method in class com.azure.ai.agents.persistent.models.ResponseFormatJsonSchema
-
Set the description property: A description of what the response format is for, used by the model to determine how to respond in the format.
- setDescription(String) - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Set the description property: The modified description for the agent to use.
- setDetail(ImageDetailLevel) - Method in class com.azure.ai.agents.persistent.models.MessageImageFileParam
-
Set the detail property: Optional detail level for the image (auto, low, or high).
- setDetail(ImageDetailLevel) - Method in class com.azure.ai.agents.persistent.models.MessageImageUrlParam
-
Set the detail property: Optional detail level for the image (auto, low, or high).
- setFileId(String) - Method in class com.azure.ai.agents.persistent.models.MessageAttachment
-
Set the fileId property: The ID of the file to attach to the message.
- setFileIds(List<String>) - Method in class com.azure.ai.agents.persistent.models.CodeInterpreterToolResource
-
Set the fileIds property: A list of file IDs made available to the `code_interpreter` tool.
- setFileSearch(FileSearchToolDefinitionDetails) - Method in class com.azure.ai.agents.persistent.models.FileSearchToolDefinition
-
Set the fileSearch property: Options overrides for the file search tool.
- setFileSearch(FileSearchToolResource) - Method in class com.azure.ai.agents.persistent.models.ToolResources
-
Set the fileSearch property: Resources to be used by the `file_search` tool consisting of vector store IDs.
- setFilter(String) - Method in class com.azure.ai.agents.persistent.models.AISearchIndexResource
-
Set the filter property: filter string for search resource.
- setFreshness(String) - Method in class com.azure.ai.agents.persistent.models.BingGroundingSearchConfiguration
-
Set the freshness property: Filter search results by a specific time range.
- setFunction(FunctionName) - Method in class com.azure.ai.agents.persistent.models.PersistentAgentsNamedToolChoice
-
Set the function property: The name of the function to call.
- setInclude(List<RunAdditionalFieldList>) - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Set the include property: A list of additional fields to include in the response.
- setIndexAssetId(String) - Method in class com.azure.ai.agents.persistent.models.AISearchIndexResource
-
Set the indexAssetId property: Index asset id for search resource.
- setIndexConnectionId(String) - Method in class com.azure.ai.agents.persistent.models.AISearchIndexResource
-
Set the indexConnectionId property: An index connection id in an IndexResource attached to this agent.
- setIndexList(List<AISearchIndexResource>) - Method in class com.azure.ai.agents.persistent.models.AzureAISearchToolResource
-
Set the indexList property: The indices attached to this agent.
- setIndexName(String) - Method in class com.azure.ai.agents.persistent.models.AISearchIndexResource
-
Set the indexName property: The name of an index in an IndexResource attached to this agent.
- setInstructions(String) - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Set the instructions property: The system instructions for the new agent to use.
- setInstructions(String) - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Set the instructions property: The overridden system instructions that the agent should use to run the thread.
- setInstructions(String) - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Set the instructions property: The overridden system instructions the agent should use to run the thread.
- setInstructions(String) - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Set the instructions property: The modified system instructions for the new agent to use.
- setLastMessages(Integer) - Method in class com.azure.ai.agents.persistent.models.TruncationObject
-
Set the lastMessages property: The number of most recent messages from the thread when constructing the context for the run.
- setMarket(String) - Method in class com.azure.ai.agents.persistent.models.BingGroundingSearchConfiguration
-
Set the market property: The market where the results come from.
- setMaxCompletionTokens(Integer) - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Set the maxCompletionTokens property: The maximum number of completion tokens that may be used over the course of the run.
- setMaxCompletionTokens(Integer) - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Set the maxCompletionTokens property: The maximum number of completion tokens that may be used over the course of the run.
- setMaxNumResults(Integer) - Method in class com.azure.ai.agents.persistent.models.FileSearchToolDefinitionDetails
-
Set the maxNumResults property: The maximum number of results the file search tool should output.
- setMaxPromptTokens(Integer) - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Set the maxPromptTokens property: The maximum number of prompt tokens that may be used over the course of the run.
- setMaxPromptTokens(Integer) - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Set the maxPromptTokens property: The maximum number of prompt tokens that may be used over the course of the run.
- setMessages(List<ThreadMessageOptions>) - Method in class com.azure.ai.agents.persistent.models.PersistentAgentThreadCreationOptions
-
Set the messages property: The initial messages to associate with the new thread.
- setMetadata(Map<String, String>) - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Set the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- setMetadata(Map<String, String>) - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Set the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- setMetadata(Map<String, String>) - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Set the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- setMetadata(Map<String, String>) - Method in class com.azure.ai.agents.persistent.models.PersistentAgentThreadCreationOptions
-
Set the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- setMetadata(Map<String, String>) - Method in class com.azure.ai.agents.persistent.models.ThreadMessageOptions
-
Set the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- setMetadata(Map<String, String>) - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Set the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.
- setModel(String) - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Set the model property: The overridden model name that the agent should use to run the thread.
- setModel(String) - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Set the model property: The overridden model that the agent should use to run the thread.
- setModel(String) - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Set the model property: The ID of the model to use.
- setName(String) - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Set the name property: The name of the new agent.
- setName(String) - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Set the name property: The modified name for the agent to use.
- setOutput(String) - Method in class com.azure.ai.agents.persistent.models.ToolOutput
-
Set the output property: The output from the tool to be submitted.
- setParallelToolCalls(Boolean) - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Set the parallelToolCalls property: If `true` functions will run in parallel during tool use.
- setParallelToolCalls(Boolean) - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Set the parallelToolCalls property: If `true` functions will run in parallel during tool use.
- setQueryType(AzureAISearchQueryType) - Method in class com.azure.ai.agents.persistent.models.AISearchIndexResource
-
Set the queryType property: Type of query in an AIIndexResource attached to this agent.
- setRankingOptions(FileSearchRankingOptions) - Method in class com.azure.ai.agents.persistent.models.FileSearchToolDefinitionDetails
-
Set the rankingOptions property: Ranking options for file search.
- setResponseFormat(BinaryData) - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Set the responseFormat property: The response format of the tool calls used by this agent.
- setResponseFormat(BinaryData) - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Set the responseFormat property: Specifies the format that the model must output.
- setResponseFormat(BinaryData) - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Set the responseFormat property: Specifies the format that the model must output.
- setResponseFormat(BinaryData) - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Set the responseFormat property: The response format of the tool calls used by this agent.
- setSetLang(String) - Method in class com.azure.ai.agents.persistent.models.BingGroundingSearchConfiguration
-
Set the setLang property: The language to use for user interface strings when calling Bing API.
- setStream(Boolean) - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Set the stream property: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.
- setStream(Boolean) - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Set the stream property: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.
- setTemperature(Double) - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Set the temperature property: What sampling temperature to use, between 0 and 2.
- setTemperature(Double) - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Set the temperature property: What sampling temperature to use, between 0 and 2.
- setTemperature(Double) - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Set the temperature property: What sampling temperature to use, between 0 and 2.
- setTemperature(Double) - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Set the temperature property: What sampling temperature to use, between 0 and 2.
- setThread(PersistentAgentThreadCreationOptions) - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Set the thread property: The details used to create the new thread.
- setToolCallId(String) - Method in class com.azure.ai.agents.persistent.models.ToolOutput
-
Set the toolCallId property: The ID of the tool call being resolved, as provided in the tool calls of a required action from a run.
- setToolChoice(BinaryData) - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Set the toolChoice property: Controls whether or not and which tool is called by the model.
- setToolChoice(BinaryData) - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Set the toolChoice property: Controls whether or not and which tool is called by the model.
- setToolResources(ToolResources) - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Set the toolResources property: A set of resources that are used by the agent's tools.
- setToolResources(ToolResources) - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Set the toolResources property: Override the tools the agent can use for this run.
- setToolResources(ToolResources) - Method in class com.azure.ai.agents.persistent.models.PersistentAgentThreadCreationOptions
-
Set the toolResources property: A set of resources that are made available to the agent's tools in this thread.
- setToolResources(ToolResources) - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Set the toolResources property: A set of resources that are used by the agent's tools.
- setTools(List<ToolDefinition>) - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Set the tools property: The collection of tools to enable for the new agent.
- setTools(List<ToolDefinition>) - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Set the tools property: The overridden list of enabled tools that the agent should use to run the thread.
- setTools(List<ToolDefinition>) - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Set the tools property: The overridden list of enabled tools the agent should use to run the thread.
- setTools(List<ToolDefinition>) - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Set the tools property: The modified collection of tools to enable for the agent.
- setTopK(Integer) - Method in class com.azure.ai.agents.persistent.models.AISearchIndexResource
-
Set the topK property: Number of documents to retrieve from search and present to the model.
- setTopP(Double) - Method in class com.azure.ai.agents.persistent.models.CreateAgentOptions
-
Set the topP property: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
- setTopP(Double) - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Set the topP property: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
- setTopP(Double) - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Set the topP property: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
- setTopP(Double) - Method in class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Set the topP property: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
- setTruncationStrategy(TruncationObject) - Method in class com.azure.ai.agents.persistent.models.CreateRunOptions
-
Set the truncationStrategy property: The strategy to use for dropping messages as the context windows moves forward.
- setTruncationStrategy(TruncationObject) - Method in class com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions
-
Set the truncationStrategy property: The strategy to use for dropping messages as the context windows moves forward.
- setType(ResponseFormat) - Method in class com.azure.ai.agents.persistent.models.InternalPersistentAgentsResponseFormat
-
Set the type property: Must be one of `text` or `json_object`.
- setVectorStoreIds(List<String>) - Method in class com.azure.ai.agents.persistent.models.FileSearchToolResource
-
Set the vectorStoreIds property: The ID of the vector store attached to this agent.
- setVectorStores(List<VectorStoreConfigurations>) - Method in class com.azure.ai.agents.persistent.models.FileSearchToolResource
-
Set the vectorStores property: The list of vector store configuration objects from Azure.
- SIMPLE - Static variable in class com.azure.ai.agents.persistent.models.AzureAISearchQueryType
-
Query type `simple`.
- STATIC - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyRequestType
-
Static value static for VectorStoreChunkingStrategyRequestType.
- STATIC - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyResponseType
-
Static value static for VectorStoreChunkingStrategyResponseType.
- StreamMessageCreation - Class in com.azure.ai.agents.persistent.models
-
Represents a stream update indicating a message state change, e.g. creation, completion, etc.
- StreamMessageCreation(ThreadMessage, PersistentAgentStreamEvent) - Constructor for class com.azure.ai.agents.persistent.models.StreamMessageCreation
-
Creates a new instance of StreamMessageCreation.
- StreamMessageUpdate - Class in com.azure.ai.agents.persistent.models
-
Represents a stream event indicating an incremental service message update.
- StreamMessageUpdate(MessageDeltaChunk, PersistentAgentStreamEvent) - Constructor for class com.azure.ai.agents.persistent.models.StreamMessageUpdate
-
Creates a new instance of StreamMessageUpdate.
- StreamRequiredAction - Class in com.azure.ai.agents.persistent.models
-
Represents a stream update indicating that input from the user is required.
- StreamRequiredAction(ThreadRun, PersistentAgentStreamEvent) - Constructor for class com.azure.ai.agents.persistent.models.StreamRequiredAction
-
Creates a new instance of StreamRequiredAction.
- StreamRunCreation - Class in com.azure.ai.agents.persistent.models
-
Represents a stream update indicating a change of state in a run step, e.g. creation, completion, etc.
- StreamRunCreation(RunStep, PersistentAgentStreamEvent) - Constructor for class com.azure.ai.agents.persistent.models.StreamRunCreation
-
Creates a new instance of StreamRunCreation.
- StreamRunStepUpdate - Class in com.azure.ai.agents.persistent.models
-
Represents a stream update indicating a change of state in a run step, e.g. creation, completion, etc.
- StreamRunStepUpdate(RunStepDeltaChunk, PersistentAgentStreamEvent) - Constructor for class com.azure.ai.agents.persistent.models.StreamRunStepUpdate
-
Creates a new instance of StreamRunStepUpdate.
- StreamThreadCreation - Class in com.azure.ai.agents.persistent.models
-
Represents a stream update that indicating the creation of a new thread.
- StreamThreadCreation(PersistentAgentStreamEvent, PersistentAgentStreamEvent) - Constructor for class com.azure.ai.agents.persistent.models.StreamThreadCreation
-
Creates a new instance of StreamThreadCreation.
- StreamThreadRunCreation - Class in com.azure.ai.agents.persistent.models
-
Represents a stream update indicating a change of state in a thread run, e.g. creation, completion, etc.
- StreamThreadRunCreation(ThreadRun, PersistentAgentStreamEvent) - Constructor for class com.azure.ai.agents.persistent.models.StreamThreadRunCreation
-
Creates a new instance of StreamThreadRunCreation.
- StreamTypeFactory - Class in com.azure.ai.agents.persistent.models
-
Deserializes the server sent event into the appropriate type.
- StreamTypeFactory() - Constructor for class com.azure.ai.agents.persistent.models.StreamTypeFactory
-
Default constructor for creating a new instance of StreamTypeFactory.
- StreamUpdate - Class in com.azure.ai.agents.persistent.models
-
Parent class for all stream updates types.
- StreamUpdate(PersistentAgentStreamEvent) - Constructor for class com.azure.ai.agents.persistent.models.StreamUpdate
-
We always want to know to which
PersistentAgentStreamEventthis StreamUpdate is associated, therefore we enforce any deriving class to supply it upon construction of a new instance. - SubmitToolOutputsAction - Class in com.azure.ai.agents.persistent.models
-
The details for required tool calls that must be submitted for an agent thread run to continue.
- SubmitToolOutputsDetails - Class in com.azure.ai.agents.persistent.models
-
The details describing tools that should be called to submit tool outputs.
- submitToolOutputsToRun(String, String, List<ToolOutput>) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Submits outputs from tools as requested by tool calls in a run.
- submitToolOutputsToRun(String, String, List<ToolOutput>) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Submits outputs from tools as requested by tool calls in a run.
- submitToolOutputsToRun(String, String, List<ToolOutput>, Boolean) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Submits outputs from tools as requested by tool calls in a run.
- submitToolOutputsToRun(String, String, List<ToolOutput>, Boolean) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Submits outputs from tools as requested by tool calls in a run.
- submitToolOutputsToRunStreaming(String, String, List<ToolOutput>) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Submits outputs from tools as requested by tool calls in a run with streaming updates.
- submitToolOutputsToRunStreaming(String, String, List<ToolOutput>) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Submits outputs from tools as requested by tool calls in a run with streaming updates.
- submitToolOutputsToRunWithResponse(String, String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Submits outputs from tools as requested by tool calls in a run.
- submitToolOutputsToRunWithResponse(String, String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Submits outputs from tools as requested by tool calls in a run.
T
- TEXT - Static variable in class com.azure.ai.agents.persistent.models.MessageBlockType
-
Indicates a block containing text content.
- TEXT - Static variable in class com.azure.ai.agents.persistent.models.ResponseFormat
-
`text` format should be used for requests involving any sort of ToolCall.
- THREAD_CREATED - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a new thread is created.
- THREAD_CREATED - Static variable in class com.azure.ai.agents.persistent.models.ThreadStreamEvent
-
Event sent when a new thread is created.
- THREAD_MESSAGE_COMPLETED - Static variable in class com.azure.ai.agents.persistent.models.MessageStreamEvent
-
Event sent when a message is completed.
- THREAD_MESSAGE_COMPLETED - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a message is completed.
- THREAD_MESSAGE_CREATED - Static variable in class com.azure.ai.agents.persistent.models.MessageStreamEvent
-
Event sent when a new message is created.
- THREAD_MESSAGE_CREATED - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a new message is created.
- THREAD_MESSAGE_DELTA - Static variable in class com.azure.ai.agents.persistent.models.MessageStreamEvent
-
Event sent when a message is being streamed.
- THREAD_MESSAGE_DELTA - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a message is being streamed.
- THREAD_MESSAGE_IN_PROGRESS - Static variable in class com.azure.ai.agents.persistent.models.MessageStreamEvent
-
Event sent when a message moves to `in_progress` status.
- THREAD_MESSAGE_IN_PROGRESS - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a message moves to `in_progress` status.
- THREAD_MESSAGE_INCOMPLETE - Static variable in class com.azure.ai.agents.persistent.models.MessageStreamEvent
-
Event sent before a message is completed.
- THREAD_MESSAGE_INCOMPLETE - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent before a message is completed.
- THREAD_RUN_CANCELLED - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a run is cancelled.
- THREAD_RUN_CANCELLED - Static variable in class com.azure.ai.agents.persistent.models.RunStreamEvent
-
Event sent when a run is cancelled.
- THREAD_RUN_CANCELLING - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a run moves to `cancelling` status.
- THREAD_RUN_CANCELLING - Static variable in class com.azure.ai.agents.persistent.models.RunStreamEvent
-
Event sent when a run moves to `cancelling` status.
- THREAD_RUN_COMPLETED - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a run is completed.
- THREAD_RUN_COMPLETED - Static variable in class com.azure.ai.agents.persistent.models.RunStreamEvent
-
Event sent when a run is completed.
- THREAD_RUN_CREATED - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a new run is created.
- THREAD_RUN_CREATED - Static variable in class com.azure.ai.agents.persistent.models.RunStreamEvent
-
Event sent when a new run is created.
- THREAD_RUN_EXPIRED - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a run is expired.
- THREAD_RUN_EXPIRED - Static variable in class com.azure.ai.agents.persistent.models.RunStreamEvent
-
Event sent when a run is expired.
- THREAD_RUN_FAILED - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a run fails.
- THREAD_RUN_FAILED - Static variable in class com.azure.ai.agents.persistent.models.RunStreamEvent
-
Event sent when a run fails.
- THREAD_RUN_IN_PROGRESS - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a run moves to `in_progress` status.
- THREAD_RUN_IN_PROGRESS - Static variable in class com.azure.ai.agents.persistent.models.RunStreamEvent
-
Event sent when a run moves to `in_progress` status.
- THREAD_RUN_INCOMPLETE - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a run ends incomplete.
- THREAD_RUN_INCOMPLETE - Static variable in class com.azure.ai.agents.persistent.models.RunStreamEvent
-
Event sent when a run ends incomplete.
- THREAD_RUN_QUEUED - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a run moves to `queued` status.
- THREAD_RUN_QUEUED - Static variable in class com.azure.ai.agents.persistent.models.RunStreamEvent
-
Event sent when a run moves to `queued` status.
- THREAD_RUN_REQUIRES_ACTION - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a run moves to `requires_action` status.
- THREAD_RUN_REQUIRES_ACTION - Static variable in class com.azure.ai.agents.persistent.models.RunStreamEvent
-
Event sent when a run moves to `requires_action` status.
- THREAD_RUN_STEP_CANCELLED - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a run step is cancelled.
- THREAD_RUN_STEP_CANCELLED - Static variable in class com.azure.ai.agents.persistent.models.RunStepStreamEvent
-
Event sent when a run step is cancelled.
- THREAD_RUN_STEP_COMPLETED - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a run step is completed.
- THREAD_RUN_STEP_COMPLETED - Static variable in class com.azure.ai.agents.persistent.models.RunStepStreamEvent
-
Event sent when a run step is completed.
- THREAD_RUN_STEP_CREATED - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a new thread run step is created.
- THREAD_RUN_STEP_CREATED - Static variable in class com.azure.ai.agents.persistent.models.RunStepStreamEvent
-
Event sent when a new thread run step is created.
- THREAD_RUN_STEP_DELTA - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a run step is being streamed.
- THREAD_RUN_STEP_DELTA - Static variable in class com.azure.ai.agents.persistent.models.RunStepStreamEvent
-
Event sent when a run step is being streamed.
- THREAD_RUN_STEP_EXPIRED - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a run step is expired.
- THREAD_RUN_STEP_EXPIRED - Static variable in class com.azure.ai.agents.persistent.models.RunStepStreamEvent
-
Event sent when a run step is expired.
- THREAD_RUN_STEP_FAILED - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a run step fails.
- THREAD_RUN_STEP_FAILED - Static variable in class com.azure.ai.agents.persistent.models.RunStepStreamEvent
-
Event sent when a run step fails.
- THREAD_RUN_STEP_IN_PROGRESS - Static variable in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Event sent when a run step moves to `in_progress` status.
- THREAD_RUN_STEP_IN_PROGRESS - Static variable in class com.azure.ai.agents.persistent.models.RunStepStreamEvent
-
Event sent when a run step moves to `in_progress` status.
- ThreadDeletionStatus - Class in com.azure.ai.agents.persistent.models
-
The status of a thread deletion operation.
- ThreadMessage - Class in com.azure.ai.agents.persistent.models
-
A single, existing message within an agent thread.
- ThreadMessageOptions - Class in com.azure.ai.agents.persistent.models
-
A single message within an agent thread, as provided during that thread's creation for its initial state.
- ThreadMessageOptions(MessageRole, BinaryData) - Constructor for class com.azure.ai.agents.persistent.models.ThreadMessageOptions
-
Creates an instance of ThreadMessageOptions class.
- ThreadRun - Class in com.azure.ai.agents.persistent.models
-
Data representing a single evaluation run of an agent thread.
- ThreadsAsyncClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the asynchronous PersistentAgentsAdministrationClient type.
- ThreadsClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the synchronous PersistentAgentsAdministrationClient type.
- ThreadStreamEvent - Class in com.azure.ai.agents.persistent.models
-
Thread operation related streaming events.
- ThreadStreamEvent() - Constructor for class com.azure.ai.agents.persistent.models.ThreadStreamEvent
-
Deprecated.Use the
ThreadStreamEvent.fromString(String)factory method. - toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.AgentDeletionStatus
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.AISearchIndexResource
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.AzureAISearchToolDefinition
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.AzureAISearchToolResource
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.AzureFunctionBinding
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.AzureFunctionDefinition
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.AzureFunctionStorageQueue
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.AzureFunctionToolDefinition
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.BingGroundingSearchConfiguration
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.BingGroundingSearchToolParameters
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.BingGroundingToolDefinition
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.CodeInterpreterToolDefinition
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.CodeInterpreterToolResource
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.ConnectedAgentDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.ConnectedAgentToolDefinition
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.FileDeletionStatus
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.FileInfo
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.FileListResponse
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.FileSearchRankingOptions
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.FileSearchToolCallContent
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.FileSearchToolDefinition
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.FileSearchToolDefinitionDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.FileSearchToolResource
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.FunctionDefinition
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.FunctionName
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.FunctionToolDefinition
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.IncompleteRunDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.InternalPersistentAgentsResponseFormat
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageAttachment
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageContent
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageDelta
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageDeltaChunk
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageDeltaContent
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageDeltaImageFileContent
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageDeltaImageFileContentObject
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextAnnotation
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextContent
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextContentObject
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFileCitationAnnotation
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFileCitationAnnotationObject
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFilePathAnnotation
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextFilePathAnnotationObject
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextUrlCitationAnnotation
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageDeltaTextUrlCitationDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageImageFileContent
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageImageFileDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageImageFileParam
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageImageUrlParam
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageIncompleteDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageInputContentBlock
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageInputImageFileBlock
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageInputImageUrlBlock
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageInputTextBlock
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageTextAnnotation
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageTextContent
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageTextDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageTextFileCitationAnnotation
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageTextFileCitationDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageTextFilePathAnnotation
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageTextFilePathDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageTextUrlCitationAnnotation
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.MessageTextUrlCitationDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.OpenApiAnonymousAuthDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.OpenApiAuthDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.OpenApiConnectionAuthDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.OpenApiConnectionSecurityScheme
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.OpenApiFunctionDefinition
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.OpenApiManagedAuthDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.OpenApiManagedSecurityScheme
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.OpenApiToolDefinition
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.PersistentAgent
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.PersistentAgentsNamedToolChoice
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.PersistentAgentThread
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.PersistentAgentThreadCreationOptions
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RequiredAction
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RequiredFunctionToolCall
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RequiredFunctionToolCallDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RequiredToolCall
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.ResponseFormatJsonSchema
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.ResponseFormatJsonSchemaType
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunCompletionUsage
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunError
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStep
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepAzureAISearchToolCall
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepBingGroundingToolCall
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterImageOutput
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterImageReference
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterLogOutput
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterToolCall
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterToolCallDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepCodeInterpreterToolCallOutput
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepCompletionUsage
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDelta
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaChunk
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterDetailItemObject
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterImageOutput
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterImageOutputObject
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterLogOutput
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterOutput
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaCodeInterpreterToolCall
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaDetail
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaFileSearchToolCall
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaFunction
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaFunctionToolCall
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaMessageCreation
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaMessageCreationObject
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaToolCall
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDeltaToolCallObject
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepError
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepFileSearchToolCall
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepFileSearchToolCallResult
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepFileSearchToolCallResults
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepFunctionToolCall
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepFunctionToolCallDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepMessageCreationDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepMessageCreationReference
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepOpenApiToolCall
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepToolCall
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.RunStepToolCallDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.SubmitToolOutputsAction
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.SubmitToolOutputsDetails
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.ThreadDeletionStatus
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.ThreadMessage
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.ThreadMessageOptions
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.ThreadRun
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.ToolDefinition
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.ToolOutput
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.ToolResources
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.TruncationObject
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStore
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreAutoChunkingStrategyRequest
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreAutoChunkingStrategyResponse
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyRequest
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyResponse
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreConfiguration
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreConfigurations
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreDataSource
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreDeletionStatus
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreExpirationPolicy
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreFile
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileBatch
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileCount
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileDeletionStatus
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreFileError
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreStaticChunkingStrategyOptions
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreStaticChunkingStrategyRequest
- toJson(JsonWriter) - Method in class com.azure.ai.agents.persistent.models.VectorStoreStaticChunkingStrategyResponse
- TOOL_CALLS - Static variable in class com.azure.ai.agents.persistent.models.RunStepType
-
Represents a run step that calls tools.
- ToolDefinition - Class in com.azure.ai.agents.persistent.models
-
An abstract representation of an input tool definition that an agent can use.
- ToolDefinition() - Constructor for class com.azure.ai.agents.persistent.models.ToolDefinition
-
Creates an instance of ToolDefinition class.
- ToolOutput - Class in com.azure.ai.agents.persistent.models
-
The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue.
- ToolOutput() - Constructor for class com.azure.ai.agents.persistent.models.ToolOutput
-
Creates an instance of ToolOutput class.
- ToolResources - Class in com.azure.ai.agents.persistent.models
-
A set of resources that are used by the agent's tools.
- ToolResources() - Constructor for class com.azure.ai.agents.persistent.models.ToolResources
-
Creates an instance of ToolResources class.
- Troubleshooting - Search tag in Overview
- Section
- TruncationObject - Class in com.azure.ai.agents.persistent.models
-
Controls for how a thread will be truncated prior to the run.
- TruncationObject(TruncationStrategy) - Constructor for class com.azure.ai.agents.persistent.models.TruncationObject
-
Creates an instance of TruncationObject class.
- TruncationStrategy - Class in com.azure.ai.agents.persistent.models
-
Possible truncation strategies for the thread.
- TruncationStrategy() - Constructor for class com.azure.ai.agents.persistent.models.TruncationStrategy
-
Deprecated.Use the
TruncationStrategy.fromString(String)factory method.
U
- UNSUPPORTED_FILE - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreFileErrorCode
-
The file is of unsupported type.
- updateAgent(UpdateAgentOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationAsyncClient
-
Modifies an existing agent.
- updateAgent(UpdateAgentOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClient
-
Modifies an existing agent.
- UpdateAgentOptions - Class in com.azure.ai.agents.persistent.models
-
Options for updateAgent API.
- UpdateAgentOptions(String) - Constructor for class com.azure.ai.agents.persistent.models.UpdateAgentOptions
-
Creates an instance of UpdateAgentOptions class.
- updateAgentWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationAsyncClient
-
Modifies an existing agent.
- updateAgentWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.PersistentAgentsAdministrationClient
-
Modifies an existing agent.
- updateMessage(String, String) - Method in class com.azure.ai.agents.persistent.MessagesAsyncClient
-
Modifies an existing message on an existing thread.
- updateMessage(String, String) - Method in class com.azure.ai.agents.persistent.MessagesClient
-
Modifies an existing message on an existing thread.
- updateMessage(String, String, Map<String, String>) - Method in class com.azure.ai.agents.persistent.MessagesAsyncClient
-
Modifies an existing message on an existing thread.
- updateMessage(String, String, Map<String, String>) - Method in class com.azure.ai.agents.persistent.MessagesClient
-
Modifies an existing message on an existing thread.
- updateMessageWithResponse(String, String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.MessagesAsyncClient
-
Modifies an existing message on an existing thread.
- updateMessageWithResponse(String, String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.MessagesClient
-
Modifies an existing message on an existing thread.
- updateRun(String, String) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Modifies an existing thread run.
- updateRun(String, String) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Modifies an existing thread run.
- updateRun(String, String, Map<String, String>) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Modifies an existing thread run.
- updateRun(String, String, Map<String, String>) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Modifies an existing thread run.
- updateRunWithResponse(String, String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.RunsAsyncClient
-
Modifies an existing thread run.
- updateRunWithResponse(String, String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.RunsClient
-
Modifies an existing thread run.
- updateThread(String) - Method in class com.azure.ai.agents.persistent.ThreadsAsyncClient
-
Modifies an existing thread.
- updateThread(String) - Method in class com.azure.ai.agents.persistent.ThreadsClient
-
Modifies an existing thread.
- updateThread(String, ToolResources, Map<String, String>) - Method in class com.azure.ai.agents.persistent.ThreadsAsyncClient
-
Modifies an existing thread.
- updateThread(String, ToolResources, Map<String, String>) - Method in class com.azure.ai.agents.persistent.ThreadsClient
-
Modifies an existing thread.
- updateThreadWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.ThreadsAsyncClient
-
Modifies an existing thread.
- updateThreadWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.agents.persistent.ThreadsClient
-
Modifies an existing thread.
- UPLOADED - Static variable in class com.azure.ai.agents.persistent.models.FileState
-
The file has been uploaded but it's not yet processed.
- URI_ASSET - Static variable in class com.azure.ai.agents.persistent.models.VectorStoreDataSourceAssetType
-
Azure URI.
- USER - Static variable in class com.azure.ai.agents.persistent.models.MessageRole
-
The role representing the end-user.
V
- V1 - Enum constant in enum com.azure.ai.agents.persistent.AgentsServiceVersion
-
Enum value v1.
- V2025_05_01 - Enum constant in enum com.azure.ai.agents.persistent.AgentsServiceVersion
-
Enum value 2025-05-01.
- V2025_05_15_PREVIEW - Enum constant in enum com.azure.ai.agents.persistent.AgentsServiceVersion
-
Enum value 2025-05-15-preview.
- valueOf(String) - Static method in enum com.azure.ai.agents.persistent.AgentsServiceVersion
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.azure.ai.agents.persistent.AgentsServiceVersion
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in class com.azure.ai.agents.persistent.models.AzureAISearchQueryType
-
Gets known AzureAISearchQueryType values.
- values() - Static method in class com.azure.ai.agents.persistent.models.DoneEvent
-
Gets known DoneEvent values.
- values() - Static method in class com.azure.ai.agents.persistent.models.ErrorEvent
-
Gets known ErrorEvent values.
- values() - Static method in class com.azure.ai.agents.persistent.models.FilePurpose
-
Gets known FilePurpose values.
- values() - Static method in class com.azure.ai.agents.persistent.models.FileState
-
Gets known FileState values.
- values() - Static method in class com.azure.ai.agents.persistent.models.ImageDetailLevel
-
Gets known ImageDetailLevel values.
- values() - Static method in class com.azure.ai.agents.persistent.models.IncompleteDetailsReason
-
Gets known IncompleteDetailsReason values.
- values() - Static method in class com.azure.ai.agents.persistent.models.ListSortOrder
-
Gets known ListSortOrder values.
- values() - Static method in class com.azure.ai.agents.persistent.models.MessageBlockType
-
Gets known MessageBlockType values.
- values() - Static method in class com.azure.ai.agents.persistent.models.MessageIncompleteDetailsReason
-
Gets known MessageIncompleteDetailsReason values.
- values() - Static method in class com.azure.ai.agents.persistent.models.MessageRole
-
Gets known MessageRole values.
- values() - Static method in class com.azure.ai.agents.persistent.models.MessageStatus
-
Gets known MessageStatus values.
- values() - Static method in class com.azure.ai.agents.persistent.models.MessageStreamEvent
-
Gets known MessageStreamEvent values.
- values() - Static method in class com.azure.ai.agents.persistent.models.OpenApiAuthType
-
Gets known OpenApiAuthType values.
- values() - Static method in class com.azure.ai.agents.persistent.models.PersistentAgentsNamedToolChoiceType
-
Gets known PersistentAgentsNamedToolChoiceType values.
- values() - Static method in class com.azure.ai.agents.persistent.models.PersistentAgentsResponseFormatMode
-
Gets known PersistentAgentsResponseFormatMode values.
- values() - Static method in class com.azure.ai.agents.persistent.models.PersistentAgentsToolChoiceOptionMode
-
Gets known PersistentAgentsToolChoiceOptionMode values.
- values() - Static method in class com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent
-
Gets known PersistentAgentStreamEvent values.
- values() - Static method in class com.azure.ai.agents.persistent.models.ResponseFormat
-
Gets known ResponseFormat values.
- values() - Static method in class com.azure.ai.agents.persistent.models.RunAdditionalFieldList
-
Gets known RunAdditionalFieldList values.
- values() - Static method in class com.azure.ai.agents.persistent.models.RunStatus
-
Gets known RunStatus values.
- values() - Static method in class com.azure.ai.agents.persistent.models.RunStepErrorCode
-
Gets known RunStepErrorCode values.
- values() - Static method in class com.azure.ai.agents.persistent.models.RunStepStatus
-
Gets known RunStepStatus values.
- values() - Static method in class com.azure.ai.agents.persistent.models.RunStepStreamEvent
-
Gets known RunStepStreamEvent values.
- values() - Static method in class com.azure.ai.agents.persistent.models.RunStepType
-
Gets known RunStepType values.
- values() - Static method in class com.azure.ai.agents.persistent.models.RunStreamEvent
-
Gets known RunStreamEvent values.
- values() - Static method in class com.azure.ai.agents.persistent.models.ThreadStreamEvent
-
Gets known ThreadStreamEvent values.
- values() - Static method in class com.azure.ai.agents.persistent.models.TruncationStrategy
-
Gets known TruncationStrategy values.
- values() - Static method in class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyRequestType
-
Gets known VectorStoreChunkingStrategyRequestType values.
- values() - Static method in class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyResponseType
-
Gets known VectorStoreChunkingStrategyResponseType values.
- values() - Static method in class com.azure.ai.agents.persistent.models.VectorStoreDataSourceAssetType
-
Gets known VectorStoreDataSourceAssetType values.
- values() - Static method in class com.azure.ai.agents.persistent.models.VectorStoreExpirationPolicyAnchor
-
Gets known VectorStoreExpirationPolicyAnchor values.
- values() - Static method in class com.azure.ai.agents.persistent.models.VectorStoreFileBatchStatus
-
Gets known VectorStoreFileBatchStatus values.
- values() - Static method in class com.azure.ai.agents.persistent.models.VectorStoreFileErrorCode
-
Gets known VectorStoreFileErrorCode values.
- values() - Static method in class com.azure.ai.agents.persistent.models.VectorStoreFileStatus
-
Gets known VectorStoreFileStatus values.
- values() - Static method in class com.azure.ai.agents.persistent.models.VectorStoreFileStatusFilter
-
Gets known VectorStoreFileStatusFilter values.
- values() - Static method in class com.azure.ai.agents.persistent.models.VectorStoreStatus
-
Gets known VectorStoreStatus values.
- VECTOR - Static variable in class com.azure.ai.agents.persistent.models.AzureAISearchQueryType
-
Query type `vector`.
- VECTOR_SEMANTIC_HYBRID - Static variable in class com.azure.ai.agents.persistent.models.AzureAISearchQueryType
-
Query type `vector_semantic_hybrid`.
- VECTOR_SIMPLE_HYBRID - Static variable in class com.azure.ai.agents.persistent.models.AzureAISearchQueryType
-
Query type `vector_simple_hybrid`.
- VectorStore - Class in com.azure.ai.agents.persistent.models
-
A vector store is a collection of processed files can be used by the `file_search` tool.
- VectorStoreAutoChunkingStrategyRequest - Class in com.azure.ai.agents.persistent.models
-
The default strategy.
- VectorStoreAutoChunkingStrategyRequest() - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreAutoChunkingStrategyRequest
-
Creates an instance of VectorStoreAutoChunkingStrategyRequest class.
- VectorStoreAutoChunkingStrategyResponse - Class in com.azure.ai.agents.persistent.models
-
This is returned when the chunking strategy is unknown.
- VectorStoreChunkingStrategyRequest - Class in com.azure.ai.agents.persistent.models
-
An abstract representation of a vector store chunking strategy configuration.
- VectorStoreChunkingStrategyRequest() - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyRequest
-
Creates an instance of VectorStoreChunkingStrategyRequest class.
- VectorStoreChunkingStrategyRequestType - Class in com.azure.ai.agents.persistent.models
-
Type of chunking strategy.
- VectorStoreChunkingStrategyRequestType() - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyRequestType
-
Deprecated.Use the
VectorStoreChunkingStrategyRequestType.fromString(String)factory method. - VectorStoreChunkingStrategyResponse - Class in com.azure.ai.agents.persistent.models
-
An abstract representation of a vector store chunking strategy configuration.
- VectorStoreChunkingStrategyResponse() - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyResponse
-
Creates an instance of VectorStoreChunkingStrategyResponse class.
- VectorStoreChunkingStrategyResponseType - Class in com.azure.ai.agents.persistent.models
-
Type of chunking strategy.
- VectorStoreChunkingStrategyResponseType() - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreChunkingStrategyResponseType
-
Deprecated.Use the
VectorStoreChunkingStrategyResponseType.fromString(String)factory method. - VectorStoreConfiguration - Class in com.azure.ai.agents.persistent.models
-
Vector storage configuration is the list of data sources, used when multiple files can be used for the enterprise file search.
- VectorStoreConfiguration(List<VectorStoreDataSource>) - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreConfiguration
-
Creates an instance of VectorStoreConfiguration class.
- VectorStoreConfigurations - Class in com.azure.ai.agents.persistent.models
-
The structure, containing the list of vector storage configurations i.e. the list of azure asset IDs.
- VectorStoreConfigurations(String, VectorStoreConfiguration) - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreConfigurations
-
Creates an instance of VectorStoreConfigurations class.
- VectorStoreDataSource - Class in com.azure.ai.agents.persistent.models
-
The structure, containing Azure asset URI path and the asset type of the file used as a data source for the enterprise file search.
- VectorStoreDataSource(String, VectorStoreDataSourceAssetType) - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreDataSource
-
Creates an instance of VectorStoreDataSource class.
- VectorStoreDataSourceAssetType - Class in com.azure.ai.agents.persistent.models
-
Type of vector storage asset.
- VectorStoreDataSourceAssetType() - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreDataSourceAssetType
-
Deprecated.Use the
VectorStoreDataSourceAssetType.fromString(String)factory method. - VectorStoreDeletionStatus - Class in com.azure.ai.agents.persistent.models
-
Response object for deleting a vector store.
- VectorStoreExpirationPolicy - Class in com.azure.ai.agents.persistent.models
-
The expiration policy for a vector store.
- VectorStoreExpirationPolicy(VectorStoreExpirationPolicyAnchor, int) - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreExpirationPolicy
-
Creates an instance of VectorStoreExpirationPolicy class.
- VectorStoreExpirationPolicyAnchor - Class in com.azure.ai.agents.persistent.models
-
Describes the relationship between the days and the expiration of this vector store.
- VectorStoreExpirationPolicyAnchor() - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreExpirationPolicyAnchor
-
Deprecated.Use the
VectorStoreExpirationPolicyAnchor.fromString(String)factory method. - VectorStoreFile - Class in com.azure.ai.agents.persistent.models
-
Description of a file attached to a vector store.
- VectorStoreFileBatch - Class in com.azure.ai.agents.persistent.models
-
A batch of files attached to a vector store.
- VectorStoreFileBatchesAsyncClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the asynchronous PersistentAgentsAdministrationClient type.
- VectorStoreFileBatchesClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the synchronous PersistentAgentsAdministrationClient type.
- VectorStoreFileBatchStatus - Class in com.azure.ai.agents.persistent.models
-
The status of the vector store file batch.
- VectorStoreFileBatchStatus() - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreFileBatchStatus
-
Deprecated.Use the
VectorStoreFileBatchStatus.fromString(String)factory method. - VectorStoreFileCount - Class in com.azure.ai.agents.persistent.models
-
Counts of files processed or being processed by this vector store grouped by status.
- VectorStoreFileDeletionStatus - Class in com.azure.ai.agents.persistent.models
-
Response object for deleting a vector store file relationship.
- VectorStoreFileError - Class in com.azure.ai.agents.persistent.models
-
Details on the error that may have occurred while processing a file for this vector store.
- VectorStoreFileErrorCode - Class in com.azure.ai.agents.persistent.models
-
Error code variants for vector store file processing.
- VectorStoreFileErrorCode() - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreFileErrorCode
-
Deprecated.Use the
VectorStoreFileErrorCode.fromString(String)factory method. - VectorStoreFilesAsyncClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the asynchronous PersistentAgentsAdministrationClient type.
- VectorStoreFilesClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the synchronous PersistentAgentsAdministrationClient type.
- VectorStoreFileStatus - Class in com.azure.ai.agents.persistent.models
-
Vector store file status.
- VectorStoreFileStatus() - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreFileStatus
-
Deprecated.Use the
VectorStoreFileStatus.fromString(String)factory method. - VectorStoreFileStatusFilter - Class in com.azure.ai.agents.persistent.models
-
Query parameter filter for vector store file retrieval endpoint.
- VectorStoreFileStatusFilter() - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreFileStatusFilter
-
Deprecated.Use the
VectorStoreFileStatusFilter.fromString(String)factory method. - VectorStoresAsyncClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the asynchronous PersistentAgentsAdministrationClient type.
- VectorStoresClient - Class in com.azure.ai.agents.persistent
-
Initializes a new instance of the synchronous PersistentAgentsAdministrationClient type.
- VectorStoreStaticChunkingStrategyOptions - Class in com.azure.ai.agents.persistent.models
-
Options to configure a vector store static chunking strategy.
- VectorStoreStaticChunkingStrategyOptions(int, int) - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreStaticChunkingStrategyOptions
-
Creates an instance of VectorStoreStaticChunkingStrategyOptions class.
- VectorStoreStaticChunkingStrategyRequest - Class in com.azure.ai.agents.persistent.models
-
A statically configured chunking strategy.
- VectorStoreStaticChunkingStrategyRequest(VectorStoreStaticChunkingStrategyOptions) - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreStaticChunkingStrategyRequest
-
Creates an instance of VectorStoreStaticChunkingStrategyRequest class.
- VectorStoreStaticChunkingStrategyResponse - Class in com.azure.ai.agents.persistent.models
-
A statically configured chunking strategy.
- VectorStoreStatus - Class in com.azure.ai.agents.persistent.models
-
Vector store possible status.
- VectorStoreStatus() - Constructor for class com.azure.ai.agents.persistent.models.VectorStoreStatus
-
Deprecated.Use the
VectorStoreStatus.fromString(String)factory method. - VISION - Static variable in class com.azure.ai.agents.persistent.models.FilePurpose
-
Indicates a file is used as input to a vision operation.
All Classes and Interfaces|All Packages
AzureAISearchQueryType.fromString(String)factory method.