AgentsClient Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The Agents sub-client.
public class AgentsClient
type AgentsClient = class
Public Class AgentsClient
- Inheritance
-
AgentsClient
Constructors
AgentsClient() |
Initializes a new instance of AgentsClient for mocking. |
AgentsClient(String, TokenCredential, AIProjectClientOptions) |
Initializes a new instance of AzureAIClient. |
AgentsClient(String, TokenCredential) |
Initializes a new instance of AzureAIClient. |
AgentsClient(Uri, String, String, String, TokenCredential, AIProjectClientOptions) |
Initializes a new instance of AzureAIClient. |
AgentsClient(Uri, String, String, String, TokenCredential) |
Initializes a new instance of AzureAIClient. |
Properties
Pipeline |
The HTTP pipeline for sending and receiving REST requests and responses. |
Methods
CancelRun(String, String, CancellationToken) |
Cancels a run of an in progress thread. |
CancelRun(String, String, RequestContext) |
[Protocol Method] Cancels a run of an in progress thread.
|
CancelRunAsync(String, String, CancellationToken) |
Cancels a run of an in progress thread. |
CancelRunAsync(String, String, RequestContext) |
[Protocol Method] Cancels a run of an in progress thread.
|
CancelVectorStoreFileBatch(String, String, CancellationToken) |
Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible. |
CancelVectorStoreFileBatch(String, String, RequestContext) |
[Protocol Method] Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
|
CancelVectorStoreFileBatchAsync(String, String, CancellationToken) |
Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible. |
CancelVectorStoreFileBatchAsync(String, String, RequestContext) |
[Protocol Method] Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
|
CreateAgent(RequestContent, RequestContext) |
[Protocol Method] Creates a new agent.
|
CreateAgent(String, String, String, String, IEnumerable<ToolDefinition>, ToolResources, Nullable<Single>, Nullable<Single>, BinaryData, IReadOnlyDictionary<String,String>, CancellationToken) |
Creates a new agent. |
CreateAgentAsync(RequestContent, RequestContext) |
[Protocol Method] Creates a new agent.
|
CreateAgentAsync(String, String, String, String, IEnumerable<ToolDefinition>, ToolResources, Nullable<Single>, Nullable<Single>, BinaryData, IReadOnlyDictionary<String,String>, CancellationToken) |
Creates a new agent. |
CreateMessage(String, MessageRole, String, IEnumerable<MessageAttachment>, IReadOnlyDictionary<String,String>, CancellationToken) |
Creates a new message on a specified thread. |
CreateMessage(String, RequestContent, RequestContext) |
[Protocol Method] Creates a new message on a specified thread.
|
CreateMessageAsync(String, MessageRole, String, IEnumerable<MessageAttachment>, IReadOnlyDictionary<String,String>, CancellationToken) |
Creates a new message on a specified thread. |
CreateMessageAsync(String, RequestContent, RequestContext) |
[Protocol Method] Creates a new message on a specified thread.
|
CreateRun(AgentThread, Agent, CancellationToken) |
Creates a new run of the specified thread using a specified agent. |
CreateRun(String, RequestContent, RequestContext) |
[Protocol Method] Creates a new run for an agent thread.
|
CreateRun(String, String, String, String, String, IEnumerable<ThreadMessage>, IEnumerable<ToolDefinition>, Nullable<Boolean>, Nullable<Single>, Nullable<Single>, Nullable<Int32>, Nullable<Int32>, TruncationObject, BinaryData, BinaryData, IReadOnlyDictionary<String,String>, CancellationToken) |
Creates a new run for an agent thread. |
CreateRunAsync(AgentThread, Agent, CancellationToken) |
Creates a new run of the specified thread using a specified agent. |
CreateRunAsync(String, RequestContent, RequestContext) |
[Protocol Method] Creates a new run for an agent thread.
|
CreateRunAsync(String, String, String, String, String, IEnumerable<ThreadMessage>, IEnumerable<ToolDefinition>, Nullable<Boolean>, Nullable<Single>, Nullable<Single>, Nullable<Int32>, Nullable<Int32>, TruncationObject, BinaryData, BinaryData, IReadOnlyDictionary<String,String>, CancellationToken) |
Creates a new run for an agent thread. |
CreateRunStreaming(String, String, String, String, String, IEnumerable<ThreadMessage>, IEnumerable<ToolDefinition>, Nullable<Single>, Nullable<Single>, Nullable<Int32>, Nullable<Int32>, TruncationObject, BinaryData, BinaryData, IReadOnlyDictionary<String,String>, CancellationToken) |
Begins a new streaming ThreadRun that evaluates a AgentThread using a specified Agent. |
CreateRunStreamingAsync(String, String, String, String, String, IEnumerable<ThreadMessage>, IEnumerable<ToolDefinition>, Nullable<Single>, Nullable<Single>, Nullable<Int32>, Nullable<Int32>, TruncationObject, BinaryData, BinaryData, IReadOnlyDictionary<String,String>, CancellationToken) |
Begins a new streaming ThreadRun that evaluates a AgentThread using a specified Agent. |
CreateThread(IEnumerable<ThreadMessageOptions>, ToolResources, IReadOnlyDictionary<String,String>, CancellationToken) |
Creates a new thread. Threads contain messages and can be run by agents. |
CreateThread(RequestContent, RequestContext) |
[Protocol Method] Creates a new thread. Threads contain messages and can be run by agents.
|
CreateThreadAndRun(RequestContent, RequestContext) |
[Protocol Method] Creates a new agent thread and immediately starts a run using that new thread.
|
CreateThreadAndRun(String, AgentThreadCreationOptions, String, String, IEnumerable<ToolDefinition>, UpdateToolResourcesOptions, Nullable<Boolean>, Nullable<Single>, Nullable<Single>, Nullable<Int32>, Nullable<Int32>, TruncationObject, BinaryData, BinaryData, IReadOnlyDictionary<String, String>, CancellationToken) |
Creates a new agent thread and immediately starts a run using that new thread. |
CreateThreadAndRunAsync(RequestContent, RequestContext) |
[Protocol Method] Creates a new agent thread and immediately starts a run using that new thread.
|
CreateThreadAndRunAsync(String, AgentThreadCreationOptions, String, String, IEnumerable<ToolDefinition>, UpdateToolResourcesOptions, Nullable<Boolean>, Nullable<Single>, Nullable<Single>, Nullable<Int32>, Nullable<Int32>, TruncationObject, BinaryData, BinaryData, IReadOnlyDictionary<String, String>, CancellationToken) |
Creates a new agent thread and immediately starts a run using that new thread. |
CreateThreadAsync(IEnumerable<ThreadMessageOptions>, ToolResources, IReadOnlyDictionary<String,String>, CancellationToken) |
Creates a new thread. Threads contain messages and can be run by agents. |
CreateThreadAsync(RequestContent, RequestContext) |
[Protocol Method] Creates a new thread. Threads contain messages and can be run by agents.
|
CreateVectorStore(IEnumerable<String>, String, VectorStoreConfiguration, VectorStoreExpirationPolicy, VectorStoreChunkingStrategyRequest, IReadOnlyDictionary<String,String>, CancellationToken) |
Creates a vector store. |
CreateVectorStore(RequestContent, RequestContext) |
[Protocol Method] Creates a vector store.
|
CreateVectorStoreAsync(IEnumerable<String>, String, VectorStoreConfiguration, VectorStoreExpirationPolicy, VectorStoreChunkingStrategyRequest, IReadOnlyDictionary<String,String>, CancellationToken) |
Creates a vector store. |
CreateVectorStoreAsync(RequestContent, RequestContext) |
[Protocol Method] Creates a vector store.
|
CreateVectorStoreFile(String, RequestContent, RequestContext) |
[Protocol Method] Create a vector store file by attaching a file to a vector store.
|
CreateVectorStoreFile(String, String, IEnumerable<VectorStoreDataSource>, VectorStoreChunkingStrategyRequest, CancellationToken) |
Create a vector store file by attaching a file to a vector store. |
CreateVectorStoreFileAsync(String, RequestContent, RequestContext) |
[Protocol Method] Create a vector store file by attaching a file to a vector store.
|
CreateVectorStoreFileAsync(String, String, IEnumerable<VectorStoreDataSource>, VectorStoreChunkingStrategyRequest, CancellationToken) |
Create a vector store file by attaching a file to a vector store. |
CreateVectorStoreFileBatch(String, IEnumerable<String>, IEnumerable<VectorStoreDataSource>, VectorStoreChunkingStrategyRequest, CancellationToken) |
Create a vector store file batch. |
CreateVectorStoreFileBatch(String, RequestContent, RequestContext) |
[Protocol Method] Create a vector store file batch.
|
CreateVectorStoreFileBatchAsync(String, IEnumerable<String>, IEnumerable<VectorStoreDataSource>, VectorStoreChunkingStrategyRequest, CancellationToken) |
Create a vector store file batch. |
CreateVectorStoreFileBatchAsync(String, RequestContent, RequestContext) |
[Protocol Method] Create a vector store file batch.
|
DeleteAgent(String, CancellationToken) |
Deletes an agent. |
DeleteAgentAsync(String, CancellationToken) |
Deletes an agent. |
DeleteFile(String, CancellationToken) |
Delete a previously uploaded file. |
DeleteFileAsync(String, CancellationToken) |
Delete a previously uploaded file. |
DeleteThread(String, CancellationToken) |
Deletes a thread. |
DeleteThreadAsync(String, CancellationToken) |
Deletes a thread. |
DeleteVectorStore(String, CancellationToken) |
Deletes the vector store object matching the specified ID. |
DeleteVectorStore(String, RequestContext) |
[Protocol Method] Deletes the vector store object matching the specified ID.
|
DeleteVectorStoreAsync(String, CancellationToken) |
Deletes the vector store object matching the specified ID. |
DeleteVectorStoreAsync(String, RequestContext) |
[Protocol Method] Deletes the vector store object matching the specified ID.
|
DeleteVectorStoreFile(String, String, CancellationToken) |
Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint. |
DeleteVectorStoreFile(String, String, RequestContext) |
[Protocol Method] Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.
|
DeleteVectorStoreFileAsync(String, String, CancellationToken) |
Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint. |
DeleteVectorStoreFileAsync(String, String, RequestContext) |
[Protocol Method] Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.
|
GetAgent(String, CancellationToken) |
Retrieves an existing agent. |
GetAgent(String, RequestContext) |
[Protocol Method] Retrieves an existing agent.
|
GetAgentAsync(String, CancellationToken) |
Retrieves an existing agent. |
GetAgentAsync(String, RequestContext) |
[Protocol Method] Retrieves an existing agent.
|
GetAgents(Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Gets a list of agents that were previously created. |
GetAgentsAsync(Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Gets a list of agents that were previously created. |
GetFile(String, CancellationToken) |
Returns information about a specific file. Does not retrieve file content. |
GetFile(String, RequestContext) |
[Protocol Method] Returns information about a specific file. Does not retrieve file content.
|
GetFileAsync(String, CancellationToken) |
Returns information about a specific file. Does not retrieve file content. |
GetFileAsync(String, RequestContext) |
[Protocol Method] Returns information about a specific file. Does not retrieve file content.
|
GetFileContent(String, CancellationToken) |
Retrieves the raw content of a specific file. |
GetFileContent(String, RequestContext) |
[Protocol Method] Retrieves the raw content of a specific file.
|
GetFileContentAsync(String, CancellationToken) |
Retrieves the raw content of a specific file. |
GetFileContentAsync(String, RequestContext) |
[Protocol Method] Retrieves the raw content of a specific file.
|
GetFiles(Nullable<AgentFilePurpose>, CancellationToken) |
Returns a list of files that belong to the user's organization. |
GetFilesAsync(Nullable<AgentFilePurpose>, CancellationToken) |
Returns a list of files that belong to the user's organization. |
GetMessage(String, String, CancellationToken) |
Gets an existing message from an existing thread. |
GetMessage(String, String, RequestContext) |
[Protocol Method] Gets an existing message from an existing thread.
|
GetMessageAsync(String, String, CancellationToken) |
Gets an existing message from an existing thread. |
GetMessageAsync(String, String, RequestContext) |
[Protocol Method] Gets an existing message from an existing thread.
|
GetMessages(String, String, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Gets a list of messages that exist on a thread. |
GetMessagesAsync(String, String, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Gets a list of messages that exist on a thread. |
GetRun(String, String, CancellationToken) |
Gets an existing run from an existing thread. |
GetRun(String, String, RequestContext) |
[Protocol Method] Gets an existing run from an existing thread.
|
GetRunAsync(String, String, CancellationToken) |
Gets an existing run from an existing thread. |
GetRunAsync(String, String, RequestContext) |
[Protocol Method] Gets an existing run from an existing thread.
|
GetRuns(String, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Gets a list of runs for a specified thread. |
GetRunsAsync(String, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Gets a list of runs for a specified thread. |
GetRunStep(String, String, String, CancellationToken) |
Gets a single run step from a thread run. |
GetRunStep(String, String, String, RequestContext) |
[Protocol Method] Gets a single run step from a thread run.
|
GetRunStepAsync(String, String, String, CancellationToken) |
Gets a single run step from a thread run. |
GetRunStepAsync(String, String, String, RequestContext) |
[Protocol Method] Gets a single run step from a thread run.
|
GetRunSteps(String, String, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Gets a list of run steps from a thread run. |
GetRunSteps(ThreadRun, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Returns a list of run steps associated an agent thread run. |
GetRunStepsAsync(String, String, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Gets a list of run steps from a thread run. |
GetRunStepsAsync(ThreadRun, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Returns a list of run steps associated an agent thread run. |
GetThread(String, CancellationToken) |
Gets information about an existing thread. |
GetThread(String, RequestContext) |
[Protocol Method] Gets information about an existing thread.
|
GetThreadAsync(String, CancellationToken) |
Gets information about an existing thread. |
GetThreadAsync(String, RequestContext) |
[Protocol Method] Gets information about an existing thread.
|
GetVectorStore(String, CancellationToken) |
Returns the vector store object matching the specified ID. |
GetVectorStore(String, RequestContext) |
[Protocol Method] Returns the vector store object matching the specified ID.
|
GetVectorStoreAsync(String, CancellationToken) |
Returns the vector store object matching the specified ID. |
GetVectorStoreAsync(String, RequestContext) |
[Protocol Method] Returns the vector store object matching the specified ID.
|
GetVectorStoreFile(String, String, CancellationToken) |
Retrieves a vector store file. |
GetVectorStoreFile(String, String, RequestContext) |
[Protocol Method] Retrieves a vector store file.
|
GetVectorStoreFileAsync(String, String, CancellationToken) |
Retrieves a vector store file. |
GetVectorStoreFileAsync(String, String, RequestContext) |
[Protocol Method] Retrieves a vector store file.
|
GetVectorStoreFileBatch(String, String, CancellationToken) |
Retrieve a vector store file batch. |
GetVectorStoreFileBatch(String, String, RequestContext) |
[Protocol Method] Retrieve a vector store file batch.
|
GetVectorStoreFileBatchAsync(String, String, CancellationToken) |
Retrieve a vector store file batch. |
GetVectorStoreFileBatchAsync(String, String, RequestContext) |
[Protocol Method] Retrieve a vector store file batch.
|
GetVectorStoreFileBatchFiles(String, String, Nullable<VectorStoreFileStatusFilter>, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Returns a list of vector store files in a batch. |
GetVectorStoreFileBatchFiles(String, String, String, Nullable<Int32>, String, String, String, RequestContext) |
[Protocol Method] Returns a list of vector store files in a batch.
|
GetVectorStoreFileBatchFilesAsync(String, String, Nullable<VectorStoreFileStatusFilter>, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Returns a list of vector store files in a batch. |
GetVectorStoreFileBatchFilesAsync(String, String, String, Nullable<Int32>, String, String, String, RequestContext) |
[Protocol Method] Returns a list of vector store files in a batch.
|
GetVectorStoreFiles(String, Nullable<VectorStoreFileStatusFilter>, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Returns a list of vector store files. |
GetVectorStoreFiles(String, String, Nullable<Int32>, String, String, String, RequestContext) |
[Protocol Method] Returns a list of vector store files.
|
GetVectorStoreFilesAsync(String, Nullable<VectorStoreFileStatusFilter>, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Returns a list of vector store files. |
GetVectorStoreFilesAsync(String, String, Nullable<Int32>, String, String, String, RequestContext) |
[Protocol Method] Returns a list of vector store files.
|
GetVectorStores(Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Returns a list of vector stores. |
GetVectorStores(Nullable<Int32>, String, String, String, RequestContext) |
[Protocol Method] Returns a list of vector stores.
|
GetVectorStoresAsync(Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Returns a list of vector stores. |
GetVectorStoresAsync(Nullable<Int32>, String, String, String, RequestContext) |
[Protocol Method] Returns a list of vector stores.
|
ModifyVectorStore(String, RequestContent, RequestContext) |
[Protocol Method] The ID of the vector store to modify.
|
ModifyVectorStore(String, String, VectorStoreExpirationPolicy, IReadOnlyDictionary<String,String>, CancellationToken) |
The ID of the vector store to modify. |
ModifyVectorStoreAsync(String, RequestContent, RequestContext) |
[Protocol Method] The ID of the vector store to modify.
|
ModifyVectorStoreAsync(String, String, VectorStoreExpirationPolicy, IReadOnlyDictionary<String,String>, CancellationToken) |
The ID of the vector store to modify. |
SubmitToolOutputsToRun(String, String, IEnumerable<ToolOutput>, Nullable<Boolean>, CancellationToken) |
Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'. |
SubmitToolOutputsToRun(String, String, RequestContent, RequestContext) |
[Protocol Method] Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.
|
SubmitToolOutputsToRun(ThreadRun, IEnumerable<ToolOutput>, CancellationToken) |
Submits outputs from tool calls as requested by a run with a status of 'requires_action' with required_action.type of 'submit_tool_outputs'. |
SubmitToolOutputsToRunAsync(String, String, IEnumerable<ToolOutput>, Nullable<Boolean>, CancellationToken) |
Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'. |
SubmitToolOutputsToRunAsync(String, String, RequestContent, RequestContext) |
[Protocol Method] Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.
|
SubmitToolOutputsToRunAsync(ThreadRun, IEnumerable<ToolOutput>, CancellationToken) |
Submits outputs from tool calls as requested by a run with a status of 'requires_action' with required_action.type of 'submit_tool_outputs'. |
UpdateAgent(String, RequestContent, RequestContext) |
[Protocol Method] Modifies an existing agent.
|
UpdateAgent(String, String, String, String, String, IEnumerable<ToolDefinition>, ToolResources, Nullable<Single>, Nullable<Single>, BinaryData, IReadOnlyDictionary<String,String>, CancellationToken) |
Modifies an existing agent. |
UpdateAgentAsync(String, RequestContent, RequestContext) |
[Protocol Method] Modifies an existing agent.
|
UpdateAgentAsync(String, String, String, String, String, IEnumerable<ToolDefinition>, ToolResources, Nullable<Single>, Nullable<Single>, BinaryData, IReadOnlyDictionary<String,String>, CancellationToken) |
Modifies an existing agent. |
UpdateMessage(String, String, IReadOnlyDictionary<String,String>, CancellationToken) |
Modifies an existing message on an existing thread. |
UpdateMessage(String, String, RequestContent, RequestContext) |
[Protocol Method] Modifies an existing message on an existing thread.
|
UpdateMessageAsync(String, String, IReadOnlyDictionary<String,String>, CancellationToken) |
Modifies an existing message on an existing thread. |
UpdateMessageAsync(String, String, RequestContent, RequestContext) |
[Protocol Method] Modifies an existing message on an existing thread.
|
UpdateRun(String, String, IReadOnlyDictionary<String,String>, CancellationToken) |
Modifies an existing thread run. |
UpdateRun(String, String, RequestContent, RequestContext) |
[Protocol Method] Modifies an existing thread run.
|
UpdateRunAsync(String, String, IReadOnlyDictionary<String,String>, CancellationToken) |
Modifies an existing thread run. |
UpdateRunAsync(String, String, RequestContent, RequestContext) |
[Protocol Method] Modifies an existing thread run.
|
UpdateThread(String, RequestContent, RequestContext) |
[Protocol Method] Modifies an existing thread.
|
UpdateThread(String, ToolResources, IReadOnlyDictionary<String,String>, CancellationToken) |
Modifies an existing thread. |
UpdateThreadAsync(String, RequestContent, RequestContext) |
[Protocol Method] Modifies an existing thread.
|
UpdateThreadAsync(String, ToolResources, IReadOnlyDictionary<String,String>, CancellationToken) |
Modifies an existing thread. |
UploadFile(RequestContent, String, RequestContext) |
[Protocol Method] Uploads a file for use by other operations.
|
UploadFile(Stream, AgentFilePurpose, String, CancellationToken) |
Uploads a file for use by other operations. |
UploadFile(String, AgentFilePurpose, CancellationToken) |
Uploads a file from a local file path accessible to File. |
UploadFileAsync(RequestContent, String, RequestContext) |
[Protocol Method] Uploads a file for use by other operations.
|
UploadFileAsync(Stream, AgentFilePurpose, String, CancellationToken) |
Uploads a file for use by other operations. |
UploadFileAsync(String, AgentFilePurpose, CancellationToken) |
Uploads a file from a local file path accessible to File. |
Applies to
Azure SDK for .NET