@azure/ai-projects package

The Azure AI Projects client

Represents a set of tools with their definitions and resources.

Utility class for creating various tools.

The options for the AIProjectsClient

The status of an agent deletion operation.

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.

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

The details used to create a new agent thread.

Information about a single thread associated with an agent.

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.

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.

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

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

Agents Interface Contains operations for creating, listing, updating, and deleting agents, threads, runs, messages, and files.

A set of index resources used by the azure_ai_search tool.

A set of index resources used by the azure_ai_search tool.

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

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

The structure for keeping storage queue name and URI.

The structure for keeping storage queue name and URI.

The definition of Azure function.

The definition of Azure function.

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.

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

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

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

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

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

Optional parameters for canceling a run.

Optional parameters for canceling a vector store file batch.

The input definition information for a code interpreter 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.

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

Connections Interface for managing connections.

Optional parameters for creating agent.

The request details to use when creating a new agent.

Optional parameters for creating an agent thread.

The details used when creating and immediately running a new agent thread.

the optional parameters for the Azure AI Search tool

Optional parameters for creating a message.

The details used when creating a new run of an agent thread.

Optional parameters for creating a vector store file batch.

Request object for creating a vector store file batch.

Optional parameters for creating a vector store file.

Request object for creating a vector store file.

Optional parameters creating vector store.

The credentials needed for API key authentication

The credentials needed for Shared Access Signatures (SAS) authentication

Optional parameters for deleting agent.

Optional parameters for deleting an agent thread.

Optional parameters for deleting a file.

Optional parameters for deleting a vector store file.

Optional parameters for deleting a vector store.

A status response from a file deletion operation.

The response data from a file list operation.

Ranking options for file search.

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.

Options overrides for the file search tool.

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

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

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

Filter by file status.

The input definition information for a function.

The input definition information for a function.

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

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.

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

Optional parameters for getting agent.

Optional parameters for getting an agent thread.

Get connection optional parameters.

Response from the listSecrets operation

Get connection with secrets optional parameters.

Optional parameters for getting file content.

Optional parameters for getting a file.

Optional parameters for getting a run.

Optional parameters for getting an run step.

Optional parameters for getting a vector store file batch.

Optional parameters for getting a vector store file.

Optional parameters for getting a vector store.

Get workspace optional parameters.

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

A Index resource.

A Index resource.

Connection properties for connections with AAD authentication (aka Entra ID passthrough)

Connection properties for connections with API key authentication

Connection properties

Connection properties for connections with SAS authentication

Optional parameters for deleting an agent thread.

Optional parameters for listing agents.

List connections optional parameters.

Optional parameters for listing files.

Optional parameters for listing messages.

Request options for list requests.

Optional parameters for listing run queries.

Optional parameters for listing run steps.

Optional parameters for listing vector store file batches.

Optional parameters for listing vector store files.

Optional parameters for listing vector stores.

This describes to which tools a file has been attached.

This describes to which tools a file has been attached.

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 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 representation of the URL used for the text citation.

Creation-time image-file block.

A representation of image file content in a thread message.

An image reference, as represented in thread message content.

Parameter for an image file (by ID) at creation time.

Creation-time image-URL block.

Parameter for an external image URL at creation time.

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

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

Creation-time text block.

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.

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

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

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

The response data for a requested list of items.

The response data for a requested list of items.

The response data for a requested list of items.

The response data for a requested list of items.

The response data for a requested list of items.

The response data for a requested list of items.

The response data for a requested list of items.

Security details for OpenApi anonymous authentication

Security details for OpenApi anonymous authentication

authentication details for OpenApiFunctionDefinition

authentication details for OpenApiFunctionDefinition

Security details for OpenApi connection authentication

Security details for OpenApi connection authentication

Security scheme for OpenApi managed_identity authentication

Security scheme for OpenApi managed_identity authentication

The input definition information for an openapi function.

The input definition information for an openapi function.

Security details for OpenApi managed_identity authentication

Security details for OpenApi managed_identity authentication

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

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

Options for configuring polling behavior.

Optional parameters configuring polling behavior.

The optional parameters for the client

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

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.

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

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.

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

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.

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.

The detailed information about a code interpreter invocation 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.

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.

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

The abstract base representation of a single tool call within a streaming run step's delta tool call details.

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.

The detailed information about the function called by the model.

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.

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

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

The detailed information associated with a run step calling tools.

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

The input definition information for a search configuration.

The array of search configurations used by the bing custom search tool.

An array of connection resources currently used by the bing_custom_search tool.

The connection information for a search configuration. This is used by the bing_custom_search tool.

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

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

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.

Optional parameters for submitting tool outputs to a run.

Telemetry operations

Telemetry options

The status of a thread deletion operation.

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

A single, existing message within an agent thread.

Data representing a single evaluation run of an agent thread.

A connection resource.

A set of connection resources currently used by either the bing_grounding, fabric_dataagent, or sharepoint_grounding tools.

A set of connection resources currently used by either the bing_grounding, fabric_dataagent, or sharepoint_grounding tools.

A connection resource.

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

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.

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.

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 for updating agent.

The request details to use when modifying an existing agent.

Optional parameters for updating an agent thread.

The details used to update an existing agent thread

Request object to update code_interpreted tool resources.

Request object to update code_interpreted tool resources.

Request object to update file_search tool resources.

Request object to update file_search tool resources.

Optional parameters for updating a message.

Optional parameters for updating a run.

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

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

Optional parameters for updating a vector store.

Optional parameters for uploading a file.

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.

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

The expiration policy for 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.

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

Description of a file attached to a vector store.

Request object for creating a vector store.

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

Options to configure a vector store static chunking strategy.

Options to configure a vector store static chunking strategy.

A statically configured chunking strategy.

A statically configured chunking strategy.

Request object for updating a vector store.

Represents a stream event data in the agent.

Agent run response with support to stream.

Represents the type of an agent stream event.

Alias for AgentsApiResponseFormatMode

Alias for AgentsApiResponseFormatModeOutput

Alias for AgentsApiResponseFormatOption

Alias for AgentsApiResponseFormatOptionOutput

Alias for AgentsApiToolChoiceOption

Alias for AgentsApiToolChoiceOptionMode

Alias for AgentsApiToolChoiceOptionModeOutput

Alias for AgentsApiToolChoiceOptionOutput

Alias for AgentsNamedToolChoiceType

Alias for AgentsNamedToolChoiceTypeOutput

Authentication type used by Azure AI service to connect to another service

Alias for AzureAISearchQueryType

Alias for ConnectionType

The Type (or category) of the connection

Optional parameters for creating and running a thread, excluding the assistantId.

Alias for CreateMessageContent

Optional parameters for creating and running a thread, excluding the assistantId.

Alias for FilePurpose

Alias for FilePurposeOutput

Alias for FileStateOutput

Alias for ImageDetailLevel

Alias for IncompleteDetailsReasonOutput

Connection properties

Alias for ListSortOrder

Alias for MessageAttachmentToolDefinition

Alias for MessageAttachmentToolDefinitionOutput

Alias for MessageBlockType

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 abstract representation of a single item of thread message content.

Represents the content of a message delta.

Represents a text annotation within a streamed text content part.

Alias for MessageIncompleteDetailsReasonOutput

Alias for MessageRole

Alias for MessageRoleOutput

Alias for MessageStatusOutput

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

authentication details for OpenApiFunctionDefinition

authentication details for OpenApiFunctionDefinition

Alias for OpenApiAuthType

Alias for OpenApiAuthTypeOutput

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

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

Alias for ResponseFormat

Alias for ResponseFormatOutput

Alias for RunStatusOutput

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

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

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

An abstract representation of the details for a run step.

Alias for RunStepErrorCodeOutput

Alias for RunStepStatusOutput

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

Alias for RunStepTypeOutput

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

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

Alias for TruncationStrategy

Alias for TruncationStrategyOutput

An abstract representation of a vector store chunking strategy configuration.

Alias for VectorStoreChunkingStrategyRequestType

An abstract representation of a vector store chunking strategy configuration.

Alias for VectorStoreChunkingStrategyResponseTypeOutput

Alias for VectorStoreDataSourceAssetType

Alias for VectorStoreDataSourceAssetTypeOutput

Alias for VectorStoreExpirationPolicyAnchor

Alias for VectorStoreExpirationPolicyAnchorOutput

Alias for VectorStoreFileBatchStatusOutput

Alias for VectorStoreFileErrorCodeOutput

Alias for VectorStoreFileStatusFilter

Alias for VectorStoreFileStatusOutput

Alias for VectorStoreStatusOutput

Terminal event indicating the successful end of a stream.

Terminal event indicating a server side error while streaming.

Message operation related streaming events

Run step operation related streaming events

Run operation related streaming events

Thread operation related streaming events

Types of connection tools used to configure an agent

Determines if the given output is of the specified type.