@azure/ai-agents package

Represents a set of tools with their definitions and resources.

Utility class for creating various tools.

A AI Search Index resource.

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

The status of an agent deletion operation.

Describes the error information returned by the agents API.

Each event in a server-sent events stream has an event and data property: * *

Example

• 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.

Represents a stream of agent event message.

Information about a single thread associated with an agent.

The details used to create a new agent thread.

Error payload returned by the agents API.

Optional parameters for the client.

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

An object describing the expected output of the model. If json_object only function type tools are allowed to be passed to the Run. If text the model can return text or any value needed.

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 definition of Azure function.

The structure for keeping storage queue name and URI.

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

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

Optional parameters.

Optional parameters.

Optional parameters.

A status response from a file deletion operation.

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

The response data from a file list operation.

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.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Files operations.

Optional parameters.

The input definition information for a function.

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

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

Optional parameters.

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

Optional parameters.

This describes to which tools a file has been attached.

An abstract representation of a single item of thread message content.

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.

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.

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.

An image reference, as represented in thread message content.

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.

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.

An abstract representation of an annotation to text thread message content.

A representation of a textual item of thread message content.

The text and associated annotations for a single item of agent 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 representation of a file-based text citation, as used in a file-based annotation of text thread message content.

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

An encapsulation of an image file ID, as used by message image content.

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.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Messages operations.

Optional parameters.

Security details for OpenApi anonymous authentication

authentication details for OpenApiFunctionDefinition

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.

Options for the byPage method

An interface that allows async iterable iteration both to completion and by page.

Options for configuring polling behavior.

Optional parameters configuring polling behavior.

An abstract representation of a required action for an agent thread run to continue.

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

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.

An abstract representation of a tool invocation needed by the model to continue a run.

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 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.

The detailed information about a code interpreter invocation by the model.

An abstract representation of an emitted output from a code interpreter tool.

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.

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.

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.

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

An abstract representation of the details for a run step.

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 about the function called by the model.

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 an OpenAPI tool, issued by the model in evaluation of a defined tool, that represents executed OpenAPI operations.

An abstract representation of a detailed tool call as recorded within a run step for an existing run.

The detailed information associated with a run step calling tools.

Optional parameters.

Optional parameters.

Interface representing a RunSteps operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Runs operations.

Optional parameters.

Optional parameters.

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

The details describing tools that should be called to submit tool outputs.

The status of a thread deletion operation.

A single, existing message within an agent thread.

A single message within an agent thread, as provided during that thread's creation for its initial state.

Data representing a single evaluation run of an agent thread.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Threads operations.

Optional parameters.

An abstract representation of an input tool definition that an agent can use.

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.

Optional parameters.

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

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.

An abstract representation of a vector store chunking strategy configuration.

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.

Response object for deleting a vector store.

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.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a VectorStoreFileBatches operations.

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

Response object for deleting a vector store file relationship.

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

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a VectorStoreFiles operations.

Options to configure a vector store static chunking strategy.

A statically configured chunking strategy.

A statically configured chunking strategy.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a VectorStores operations.

Represents a stream event data in the agent.

Agent run response with support to stream.

Alias for AgentStreamEvent

Available tool types for agents named tools.

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

Alias for AgentsResponseFormatOption

Alias for AgentsToolChoiceOption

Specifies how the tool choice will be used

Available query types for Azure AI Search tool.

An interface that describes a page of results.

Valid values for the contents of a binary file.

The possible values denoting the intended usage of a file.

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.

Alias for MessageAttachmentToolDefinition

Specifies the kind of content block within a message. Could be text, an image file, an external image URL, or an unknown future type.

Alias for MessageContentUnion

Alias for MessageDeltaContentUnion

Alias for MessageDeltaTextAnnotationUnion

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

Alias for MessageInputContent

Alias for MessageInputContentBlockUnion

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

The possible execution status values for a thread message.

Alias for MessageTextAnnotationUnion

Alias for OpenApiAuthDetailsUnion

Authentication type for OpenApi endpoint. Allowed types are:

• Anonymous (no authentication required)
• Connection (requires connection_id to endpoint, as setup in AI Foundry)
• Managed_Identity (requires audience for identity based auth)

Alias for RequiredActionUnion

Alias for RequiredToolCallUnion

Possible API response formats.

A list of additional fields to include in the response.

Possible values for the status of an agent thread run.

Alias for RunStepCodeInterpreterToolCallOutputUnion

Alias for RunStepDeltaCodeInterpreterOutputUnion

Alias for RunStepDeltaDetailUnion

Alias for RunStepDeltaToolCallUnion

Alias for RunStepDetailsUnion

Possible error code values attributable to a failed run step.

Possible values for the status of a run step.

Alias for RunStepToolCallUnion

The possible types of run steps.

Alias for ToolDefinitionUnion

Possible truncation strategies for the thread.

Type of chunking strategy

Alias for VectorStoreChunkingStrategyRequestUnion

Type of chunking strategy

Alias for VectorStoreChunkingStrategyResponseUnion

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

The status of the vector store file batch.

Error code variants for vector store file processing

Vector store file status

Query parameter filter for vector store file retrieval endpoint

Vector store possible status

Terminal event indicating the successful end of a stream.

Terminal event indicating a server side error while streaming.

Azure AI Agents API versions

Message operation related streaming events

Run step operation related streaming events

Run operation related streaming events

Thread operation related streaming events

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.

Types of connection tools used to configure an agent

Determines if the given output is of the specified type.