Package com.azure.ai.agents.persistent.models
package com.azure.ai.agents.persistent.models
Package containing the data models for Agents.
-
ClassesClassDescriptionThe status of an agent deletion operation.A AI Search Index resource.Available query types for Azure AI Search tool.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.Options for createAgent API.Options for createRun API.Options for createThreadAndRun API.Terminal event indicating the successful end of a stream.Terminal event indicating a server side error while streaming.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.The possible values denoting the intended usage of a file.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 state of the file.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.Specifies an image's detail level.The reason why the run is incomplete.Details on why the run is incomplete.An object describing the expected output of the model.The available sorting options when requesting a list of response objects.This describes to which tools a file has been attached.Specifies the kind of content block within a message.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.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.A set of reasons describing why a message is marked as incomplete.Defines a single content block when creating a message.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 possible values for roles attributed to messages in a thread.The possible execution status values for a thread message.Message operation related streaming events.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.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.A representation of a URL citation, as used in text thread message content.Security details for OpenApi anonymous authentication.authentication details for OpenApiFunctionDefinition.Authentication type for OpenApi endpoint.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.A class that handles the deserialization of server sent events.Specifies a tool the model should use.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).Information about a single thread associated with an agent.The details used to create a new agent thread.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.Possible API response formats.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`.A list of additional fields to include in the response.Usage statistics related to the run.The details of an error as encountered by an agent thread run.Possible values for the status of 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.Possible error code values attributable to 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.Possible values for the status of a run step.Run step operation related streaming events.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.The possible types of run steps.Run operation related streaming events.Represents a stream update indicating a message state change, e.g. creation, completion, etc.Represents a stream event indicating an incremental service message update.Represents a stream update indicating that input from the user is required.Represents a stream update indicating a change of state in a run step, e.g. creation, completion, etc.Represents a stream update indicating a change of state in a run step, e.g. creation, completion, etc.Represents a stream update that indicating the creation of a new thread.Represents a stream update indicating a change of state in a thread run, e.g. creation, completion, etc.Deserializes the server sent event into the appropriate type.Parent class for all stream updates types.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.Thread operation related streaming events.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.Controls for how a thread will be truncated prior to the run.Possible truncation strategies for the thread.Options for updateAgent API.A vector store is a collection of processed files can be used by the `file_search` tool.The default strategy.This is returned when the chunking strategy is unknown.An abstract representation of a vector store chunking strategy configuration.Type of chunking strategy.An abstract representation of a vector store chunking strategy configuration.Type of chunking strategy.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.Type of vector storage asset.Response object for deleting a vector store.The expiration policy for a vector store.Describes the relationship between the days and the expiration of this vector store.Description of a file attached to a vector store.A batch of files attached to a vector store.The status of the vector store file batch.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.Error code variants for vector store file processing.Vector store file status.Query parameter filter for vector store file retrieval endpoint.Options to configure a vector store static chunking strategy.A statically configured chunking strategy.A statically configured chunking strategy.Vector store possible status.