Azure.AI.Agents.Persistent Namespace

A AI Search Index resource.

Context class which will be filled in by the System.ClientModel.SourceGeneration. For more information see 'https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/System.ClientModel/src/docs/ModelReaderWriterContext.md'

The input definition information for an Azure AI search tool as used to configure an agent.

A set of index resources used by the azure_ai_search tool.

The structure for keeping storage queue name and URI.

The structure for keeping storage queue name and URI.

The input definition information for a azure function tool as used to configure an agent.

A bing custom search configuration.

The input definition information for a Bing custom search tool as used to configure an agent.

The bing custom search tool parameters.

Search configuration for Bing Grounding.

The bing grounding search tool parameters.

The input definition information for a bing grounding search tool as used to configure an agent.

The input definition information for a code interpreter tool as used to configure an agent.

A set of resources that are used by the code_interpreter tool.

Information for connecting one agent to another as a tool.

The input definition information for a connected agent tool which defines a ___domain specific sub-agent.

The fabric data agent tool parameters.

Ranking options for file search.

The file search result content object.

The input definition information for a file search tool as used to configure an agent.

Options overrides for the file search tool.

A set of resources that are used by the file_search tool.

The input definition information for a function tool as used to configure an agent.

Details on why the run is incomplete. Will be null if the run is not incomplete.

This describes to which tools a file has been attached.

An abstract representation of a single item of thread message content. Please note MessageContent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include MessageImageFileContent and MessageTextContent.

Represents a streaming update to PersistentThreadMessage content as part of the Agents API.

Represents the typed 'delta' payload within a streaming message delta chunk.

Represents a message delta i.e. any changed fields on a message during streaming.

The abstract base representation of a partial streamed message content payload. Please note MessageDeltaContent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include MessageDeltaImageFileContent and MessageDeltaTextContent.

Represents a streamed image file content part within a streaming message delta chunk.

Represents the 'image_file' payload within streaming image file content.

The abstract base representation of a streamed text content part's text annotation. Please note MessageDeltaTextAnnotation is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include MessageDeltaTextFileCitationAnnotation, MessageDeltaTextFilePathAnnotation and MessageDeltaTextUriCitationAnnotation.

Represents a streamed text content part within a streaming message delta chunk.

Represents the data of a streamed text content part within a streaming message delta chunk.

Represents a streamed file citation applied to a streaming text content part.

Represents the data of a streamed file citation as applied to a streaming text content part.

Represents a streamed file path annotation applied to a streaming text content part.

Represents the data of a streamed file path annotation as applied to a streaming text content part.

A citation within the message that points to a specific URL associated with the message. Generated when the agent uses tools such as 'bing_grounding' to search the Internet.

A representation of a URL citation, as used in text thread message content.

A representation of image file content in a thread message.

Defines how an internally uploaded image file is referenced when creating an image-file block.

Defines how an external image URL is referenced when creating an image-URL block.

Information providing additional detail about a message entering an incomplete status.

Defines a single content block when creating a message. The 'type' field determines whether it is text, an image file, or an external image URL, etc. Please note MessageInputContentBlock is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include MessageInputImageFileBlock, MessageInputImageUriBlock and MessageInputTextBlock.

An image-file block in a new message, referencing an internally uploaded image by file ID.

An image-URL block in a new message, referencing an external image by URL.

A text block in a new message, containing plain text content.

The update type presented when the status of a message changes.

An abstract representation of an annotation to text thread message content. Please note MessageTextAnnotation is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include MessageTextFileCitationAnnotation, MessageTextFilePathAnnotation and MessageTextUriCitationAnnotation.

A representation of a textual item of thread message content.

A citation within the message that points to a specific quote from a specific File associated with the agent or the message. Generated when the agent uses the 'file_search' tool to search files.

A citation within the message that points to a file located at a specific path.

A citation within the message that points to a specific URL associated with the message. Generated when the agent uses tools such as 'bing_grounding' to search the Internet.

A representation of a URL citation, as used in text thread message content.

The input definition information for a Microsoft Fabric tool as used to configure an agent.

Security details for OpenApi anonymous authentication.

authentication details for OpenApiFunctionDefinition Please note OpenApiAuthDetails is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include OpenApiAnonymousAuthDetails, OpenApiConnectionAuthDetails and OpenApiManagedAuthDetails.

Security details for OpenApi connection authentication.

Security scheme for OpenApi managed_identity authentication.

The input definition information for an openapi function.

Security details for OpenApi managed_identity authentication.

Security scheme for OpenApi managed_identity authentication.

The input definition information for an OpenAPI tool as used to configure an agent.

Represents an agent that can call the model and use tools.

Represents an agent that can call the model and use tools.

The PersistentAgentsAdministration service client.

Client options for PersistentAgentsAdministrationClient.

The Azure AI Agents Persistent extensions.

A collection of file‐related operations under /files.

The function name that will be used, if using the function tool.

Model factory for models.

Specifies a tool the model should use. Use to force the model to call a specific tool.

A vector store is a collection of processed files can be used by the file_search tool.

Information about a single thread associated with an agent.

The details used to create a new agent thread.

A single, existing message within an agent thread.

An abstract representation of a required action for an agent thread run to continue. Please note RequiredAction is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SubmitToolOutputsAction.

The update type presented when the status of a ThreadRun has changed to requires_action, indicating that tool output submission or another intervention is needed for the run to continue.

A representation of a requested call to a function tool, needed by the model to continue evaluation of a run.

An abstract, base representation for a tool call that an Agents API run requires outputs from in order to continue.

A description of what the response format is for, used by the model to determine how to respond in the format.

The type of response format being defined: json_schema.

Usage statistics related to the run. This value will be null if the run is not in a terminal state (i.e. in_progress, queued, etc.).

The details of an error as encountered by an agent thread run.

Detailed information about a single step of an agent thread run.

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.

A record of a call to a bing custom search tool, issued by the model in evaluation of a defined tool, that represents executed search with bing custom search.

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.

A representation of an image output emitted by a code interpreter tool in response to a tool call by the model.

An image reference emitted by a code interpreter tool in response to a tool call by the model.

A representation of a log output emitted by a code interpreter tool in response to a tool call by the model.

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.

An abstract representation of an emitted output from a code interpreter tool. Please note RunStepCodeInterpreterToolCallOutput is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include RunStepCodeInterpreterImageOutput and RunStepCodeInterpreterLogOutput.

Usage statistics related to the run step.

Represents the delta payload in a streaming run step delta chunk.

Represents a run step delta i.e. any changed fields on a run step during streaming.

Represents the Code Interpreter tool call data in a streaming run step's tool calls.

Represents an image output as produced the Code interpreter tool and as represented in a streaming run step's delta tool calls collection.

Represents the data for a streaming run step's Code Interpreter tool call image output.

Represents a log output as produced by the Code Interpreter tool and as represented in a streaming run step's delta tool calls collection.

The abstract base representation of a streaming run step tool call's Code Interpreter tool output. Please note RunStepDeltaCodeInterpreterOutput is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include RunStepDeltaCodeInterpreterImageOutput and RunStepDeltaCodeInterpreterLogOutput.

Represents a Code Interpreter tool call within a streaming run step's tool call details.

Represents a single run step detail item in a streaming run step's delta payload. Please note RunStepDeltaDetail is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include RunStepDeltaMessageCreation and RunStepDeltaToolCallObject.

Represents a file search tool call within a streaming run step's tool call details.

Represents the function data in a streaming run step delta's function tool call.

Represents a function tool call within a streaming run step's tool call details.

Represents a message creation within a streaming run step delta.

Represents the data within a streaming run step message creation response object.

The abstract base representation of a single tool call within a streaming run step's delta tool call details. Please note RunStepDeltaToolCall is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include RunStepDeltaCodeInterpreterToolCall, RunStepDeltaFileSearchToolCall and RunStepDeltaFunctionToolCall.

Represents an invocation of tool calls as part of a streaming run step.

An abstract representation of the details for a run step. Please note RunStepDetails is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include RunStepMessageCreationDetails and RunStepToolCallDetails.

The update type presented when run step details, including tool call progress, have changed.

The error information associated with a failed run step.

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.

File search tool call result.

The results of the file search.

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.

The detailed information associated with a message creation run step.

The details of a message created as a part of a run step.

A record of a call to a Microsoft Fabric tool, issued by the model in evaluation of a defined tool, that represents executed Microsoft Fabric operations.

A record of a call to an OpenAPI tool, issued by the model in evaluation of a defined tool, that represents executed OpenAPI operations.

A record of a call to a SharePoint tool, issued by the model in evaluation of a defined tool, that represents executed SharePoint actions.

An abstract representation of a detailed tool call as recorded within a run step for an existing run. Please note RunStepToolCall is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include RunStepAzureAISearchToolCall, RunStepBingCustomSearchToolCall, RunStepBingGroundingToolCall, RunStepCodeInterpreterToolCall, RunStepMicrosoftFabricToolCall, RunStepFileSearchToolCall, RunStepFunctionToolCall, RunStepOpenAPIToolCall and RunStepSharepointToolCall.

The detailed information associated with a run step calling tools.

The update type presented when the status of a run step changes.

The update type presented when the status of a ThreadRun has changed.

The sharepoint grounding tool parameters.

The input definition information for a sharepoint tool as used to configure an agent.

Represents a single item of streamed Agents API data.

Represents a single item of streamed data that encapsulates an underlying response value type.

The details for required tool calls that must be submitted for an agent thread run to continue.

Represents the options for creating or adding a message in an agent thread. This class provides convenient ways to specify the message role (e.g., user or assistant) and the message content, which can be either plain text or one or more structured content blocks (e.g., text, images).

A collection of message operations under /threads/{threadId}/messages.

Data representing a single evaluation run of an agent thread.

A collection of run operations under /threads/{threadId}/runs.

A collection of thread operations under /threads.

The update type presented when a streamed event indicates a thread was created.

A connection resource.

An abstract representation of an input tool definition that an agent can use. Please note ToolDefinition is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureAISearchToolDefinition, AzureFunctionToolDefinition, BingCustomSearchToolDefinition, BingGroundingToolDefinition, CodeInterpreterToolDefinition, ConnectedAgentToolDefinition, MicrosoftFabricToolDefinition, FileSearchToolDefinition, FunctionToolDefinition, OpenApiToolDefinition and SharepointToolDefinition.

The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue.

A set of resources that are used by the agent's tools. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.

The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.

This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the chunking_strategy concept was introduced in the API.

An abstract representation of a vector store chunking strategy configuration. Please note VectorStoreChunkingStrategy is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include VectorStoreAutoChunkingStrategy and VectorStoreStaticChunkingStrategyRequest.

An abstract representation of a vector store chunking strategy configuration. Please note VectorStoreChunkingStrategyResponse is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include VectorStoreAutoChunkingStrategyResponse and VectorStoreStaticChunkingStrategyResponse.

Vector storage configuration is the list of data sources, used when multiple files can be used for the enterprise file search.

The structure, containing the list of vector storage configurations i.e. the list of azure asset IDs.

The structure, containing Azure asset URI path and the asset type of the file used as a data source for the enterprise file search.

The expiration policy for a vector store.

Description of a file attached to a vector store.

A batch of files attached to a vector store.

Counts of files processed or being processed by this vector store grouped by status.

Details on the error that may have occurred while processing a file for this vector store.

A collection of vector-store operations under /vector_stores.

Options to configure a vector store static chunking strategy.

A statically configured chunking strategy.

A statically configured chunking strategy.

Available query types for Azure AI Search tool.

The AzureFunctionBindingType.

Terminal event indicating the successful end of a stream.

Terminal event indicating a server side error while streaming.

The FileSearchToolCallContentType.

The state of the file.

Specifies an image's detail level. Can be 'auto', 'low', 'high', or an unknown future value.

The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.

The available sorting options when requesting a list of response objects.

The MessageDeltaChunkObject.

A set of reasons describing why a message is marked as incomplete.

The possible values for roles attributed to messages in a thread.

The possible execution status values for a thread message.

Message operation related streaming events.

The possible values denoting the intended usage of a file.

Available tool types for agents named tools.

Represents the mode in which the model will handle the return format of a tool call.

Specifies how the tool choice will be used.

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). For example, we emit thread.run.created when a new run is created, thread.run.completed when a run completes, and so on. When an Agent chooses to create a message during a run, we emit a thread.message.created event, a thread.message.in_progress event, many thread.message.delta events, and finally a thread.message.completed event.

We may add additional events over time, so we recommend handling unknown events gracefully in your code.

The PersistentAgentsVectorStoreObject.

The ResponseFormatJsonSchemaTypeType.

A list of additional fields to include in the response.

Possible values for the status of an agent thread run.

The RunStepDeltaChunkObject.

Possible error code values attributable to a failed run step.

Possible values for the status of a run step.

Run step operation related streaming events.

The possible types of run steps.

Run operation related streaming events.

Thread operation related streaming events.

Possible truncation strategies for the thread.

Type of vector storage asset. Asset type may be a uri_asset, in this case it should contain asset URI ID, in the case of id_asset it should contain the data ID.

Describes the relationship between the days and the expiration of this vector store.

The VectorStoreFileBatchObject.

The status of the vector store file batch.

Error code variants for vector store file processing.

The VectorStoreFileObject.

Vector store file status.

Query parameter filter for vector store file retrieval endpoint.

Vector store possible status.

The version of the service to use.

The collection of values associated with the event names of streaming update payloads. These correspond to the expected downcast data type of the StreamingUpdate as well as to the expected data present in the payload.