Azure.AI.Projects Namespace

Classes

Agent	Represents an agent that can call the model and use tools.
AgentFile	Represents an agent that can call the model and use tools.
AgentPageableListOfVectorStore	The response data for a requested list of items.
AgentPageableListOfVectorStoreFile	The response data for a requested list of items.
AgentsApiResponseFormat	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.
AgentsClient	The Agents sub-client.
AgentsNamedToolChoice	Specifies a tool the model should use. Use to force the model to call a specific tool.
AgentThread	Information about a single thread associated with an agent.
AgentThreadCreationOptions	The details used to create a new agent thread.
AIClientModelFactory
AIProjectClient	The AzureAI service client.
AIProjectClientOptions	Client options for AIProjectClient.
AIProjectsModelFactory	Model factory for models.
ApplicationInsightsConfiguration	Data Source for Application Insights.
AzureAISearchResource	A set of index resources used by the azure_ai_search tool.
AzureAISearchToolDefinition	The input definition information for an Azure AI search tool as used to configure an agent.
BingGroundingToolDefinition	The input definition information for a bing grounding search tool as used to configure an agent.
CodeInterpreterToolDefinition	The input definition information for a code interpreter tool as used to configure an agent.
CodeInterpreterToolResource	A set of resources that are used by the code_interpreter tool.
ConnectionProperties	Connection properties Please note ConnectionProperties 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 ConnectionPropertiesApiKeyAuth.
ConnectionPropertiesApiKeyAuth	Connection properties for connections with API key authentication.
ConnectionResponse	Response from the listSecrets operation.
ConnectionsClient	The Endpoints sub-client.
CredentialsApiKeyAuth	The credentials needed for API key authentication.
CronTrigger	Cron Trigger Definition.
Dataset	Dataset as source for evaluation.
Evaluation	Evaluation Definition.
EvaluationSchedule	Evaluation Schedule Definition.
EvaluationsClient	The Evaluations sub-client.
EvaluatorConfiguration	Evaluator Configuration.
FileSearchRankingOptions	Ranking options for file search.
FileSearchToolDefinition	The input definition information for a file search tool as used to configure an agent.
FileSearchToolDefinitionDetails	Options overrides for the file search tool.
FileSearchToolResource	A set of resources that are used by the file_search tool.
FunctionName	The function name that will be used, if using the function tool.
FunctionToolDefinition	The input definition information for a function tool as used to configure an agent.
GetWorkspaceResponse	Response from the Workspace - Get operation.
IndexResource	A Index resource.
InputData	Abstract data class for input data configuration. Please note InputData 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 ApplicationInsightsConfiguration and Dataset.
ListConnectionsResponse	Response from the list operation.
MessageAttachment	This describes to which tools a file has been attached.
MessageContent	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.
MessageContentUpdate	Represents a streaming update to ThreadMessage content as part of the Assistants API.
MessageDelta	Represents the typed 'delta' payload within a streaming message delta chunk.
MessageDeltaChunk	Represents a message delta i.e. any changed fields on a message during streaming.
MessageDeltaContent	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.
MessageDeltaImageFileContent	Represents a streamed image file content part within a streaming message delta chunk.
MessageDeltaImageFileContentObject	Represents the 'image_file' payload within streaming image file content.
MessageDeltaTextAnnotation	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 and MessageDeltaTextFilePathAnnotation.
MessageDeltaTextContent	Represents a streamed text content part within a streaming message delta chunk.
MessageDeltaTextContentObject	Represents the data of a streamed text content part within a streaming message delta chunk.
MessageDeltaTextFileCitationAnnotation	Represents a streamed file citation applied to a streaming text content part.
MessageDeltaTextFileCitationAnnotationObject	Represents the data of a streamed file citation as applied to a streaming text content part.
MessageDeltaTextFilePathAnnotation	Represents a streamed file path annotation applied to a streaming text content part.
MessageDeltaTextFilePathAnnotationObject	Represents the data of a streamed file path annotation as applied to a streaming text content part.
MessageImageFileContent	A representation of image file content in a thread message.
MessageIncompleteDetails	Information providing additional detail about a message entering an incomplete status.
MessageStatusUpdate	The update type presented when the status of a message changes.
MessageTextAnnotation	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 and MessageTextFilePathAnnotation.
MessageTextContent	A representation of a textual item of thread message content.
MessageTextFileCitationAnnotation	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.
MessageTextFilePathAnnotation	A citation within the message that points to a file located at a specific path.
MicrosoftFabricToolDefinition	The input definition information for a Microsoft Fabric tool as used to configure an agent.
PageableList<T>	Represents a pageable list of data items with item ID cursors representing the start and end of the current page.
RecurrenceSchedule	RecurrenceSchedule Definition.
RecurrenceTrigger	Recurrence Trigger Definition.
RequiredAction	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.
RequiredActionUpdate	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.
RequiredFunctionToolCall	A representation of a requested call to a function tool, needed by the model to continue evaluation of a run.
RequiredToolCall	An abstract, base representation for a tool call that an Assistants API run requires outputs from in order to continue.
RunCompletionUsage	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.).
RunError	The details of an error as encountered by an agent thread run.
RunStep	Detailed information about a single step of an agent thread run.
RunStepAzureAISearchToolCall	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.
RunStepBingGroundingToolCall	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.
RunStepCodeInterpreterImageOutput	A representation of an image output emitted by a code interpreter tool in response to a tool call by the model.
RunStepCodeInterpreterImageReference	An image reference emitted by a code interpreter tool in response to a tool call by the model.
RunStepCodeInterpreterLogOutput	A representation of a log output emitted by a code interpreter tool in response to a tool call by the model.
RunStepCodeInterpreterToolCall	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.
RunStepCodeInterpreterToolCallOutput	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.
RunStepCompletionUsage	Usage statistics related to the run step.
RunStepDelta	Represents the delta payload in a streaming run step delta chunk.
RunStepDeltaChunk	Represents a run step delta i.e. any changed fields on a run step during streaming.
RunStepDeltaCodeInterpreterDetailItemObject	Represents the Code Interpreter tool call data in a streaming run step's tool calls.
RunStepDeltaCodeInterpreterImageOutput	Represents an image output as produced the Code interpreter tool and as represented in a streaming run step's delta tool calls collection.
RunStepDeltaCodeInterpreterImageOutputObject	Represents the data for a streaming run step's Code Interpreter tool call image output.
RunStepDeltaCodeInterpreterLogOutput	Represents a log output as produced by the Code Interpreter tool and as represented in a streaming run step's delta tool calls collection.
RunStepDeltaCodeInterpreterOutput	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.
RunStepDeltaCodeInterpreterToolCall	Represents a Code Interpreter tool call within a streaming run step's tool call details.
RunStepDeltaDetail	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.
RunStepDeltaFileSearchToolCall	Represents a file search tool call within a streaming run step's tool call details.
RunStepDeltaFunction	Represents the function data in a streaming run step delta's function tool call.
RunStepDeltaFunctionToolCall	Represents a function tool call within a streaming run step's tool call details.
RunStepDeltaMessageCreation	Represents a message creation within a streaming run step delta.
RunStepDeltaMessageCreationObject	Represents the data within a streaming run step message creation response object.
RunStepDeltaToolCall	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.
RunStepDeltaToolCallObject	Represents an invocation of tool calls as part of a streaming run step.
RunStepDetails	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.
RunStepDetailsUpdate	The update type presented when run step details, including tool call progress, have changed.
RunStepError	The error information associated with a failed run step.
RunStepFileSearchToolCall	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.
RunStepFunctionToolCall	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.
RunStepMessageCreationDetails	The detailed information associated with a message creation run step.
RunStepMessageCreationReference	The details of a message created as a part of a run step.
RunStepMicrosoftFabricToolCall	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.
RunStepSharepointToolCall	A record of a call to a SharePoint tool, issued by the model in evaluation of a defined tool, that represents executed SharePoint actions.
RunStepToolCall	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, RunStepBingGroundingToolCall, RunStepCodeInterpreterToolCall, RunStepFileSearchToolCall, RunStepFunctionToolCall, RunStepMicrosoftFabricToolCall and RunStepSharepointToolCall.
RunStepToolCallDetails	The detailed information associated with a run step calling tools.
RunStepUpdate	The update type presented when the status of a run step changes.
RunUpdate	The update type presented when the status of a ThreadRun has changed.
SharepointToolDefinition	The input definition information for a sharepoint tool as used to configure an agent.
StreamingUpdate	Represents a single item of streamed Assistants API data.
StreamingUpdate<T>	Represents a single item of streamed data that encapsulates an underlying response value type.
SubmitToolOutputsAction	The details for required tool calls that must be submitted for an agent thread run to continue.
SystemData	Metadata pertaining to creation and last modification of the resource.
TelemetryClient	The Evaluations sub-client.
TextAnnotationUpdate
ThreadMessage	A single, existing message within an agent thread.
ThreadMessageOptions	A single message within an agent thread, as provided during that thread's creation for its initial state.
ThreadRun	Data representing a single evaluation run of an agent thread.
ThreadUpdate	The update type presented when a streamed event indicates a thread was created.
ToolConnection	A connection resource.
ToolConnectionList	A set of connection resources currently used by either the bing_grounding, microsoft_fabric, or sharepoint_grounding tools.
ToolDefinition	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, BingGroundingToolDefinition, CodeInterpreterToolDefinition, FileSearchToolDefinition, FunctionToolDefinition, MicrosoftFabricToolDefinition and SharepointToolDefinition.
ToolOutput	The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue.
ToolResources	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.
Trigger	Abstract data class for input data configuration. Please note Trigger 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 CronTrigger and RecurrenceTrigger.
TruncationObject	Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.
UpdateCodeInterpreterToolResourceOptions	Request object to update code_interpreted tool resources.
UpdateFileSearchToolResourceOptions	Request object to update file_search tool resources.
UpdateToolResourcesOptions	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.
VectorStore	A vector store is a collection of processed files can be used by the file_search tool.
VectorStoreAutoChunkingStrategyRequest	The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.
VectorStoreAutoChunkingStrategyResponse	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.
VectorStoreChunkingStrategyRequest	An abstract representation of a vector store chunking strategy configuration. Please note VectorStoreChunkingStrategyRequest 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 VectorStoreAutoChunkingStrategyRequest and VectorStoreStaticChunkingStrategyRequest.
VectorStoreChunkingStrategyResponse	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.
VectorStoreConfiguration	Vector storage configuration is the list of data sources, used when multiple files can be used for the enterprise file search.
VectorStoreConfigurations	The structure, containing the list of vector storage configurations i.e. the list of azure asset IDs.
VectorStoreDataSource	The structure, containing Azure asset URI path and the asset type of the file used as a data source for the enterprise file search.
VectorStoreDeletionStatus	Response object for deleting a vector store.
VectorStoreExpirationPolicy	The expiration policy for a vector store.
VectorStoreFile	Description of a file attached to a vector store.
VectorStoreFileBatch	A batch of files attached to a vector store.
VectorStoreFileCount	Counts of files processed or being processed by this vector store grouped by status.
VectorStoreFileDeletionStatus	Response object for deleting a vector store file relationship.
VectorStoreFileError	Details on the error that may have ocurred while processing a file for this vector store.
VectorStoreStaticChunkingStrategyOptions	Options to configure a vector store static chunking strategy.
VectorStoreStaticChunkingStrategyRequest	A statically configured chunking strategy.
VectorStoreStaticChunkingStrategyResponse	A statically configured chunking strategy.
WorkspaceProperties	workspace properties.

Structs

AgentFilePurpose	The possible values denoting the intended usage of a file.
AgentPageableListOfVectorStoreFileObject	The OpenAIPageableListOfVectorStoreFile_object.
AgentPageableListOfVectorStoreObject	The OpenAIPageableListOfVectorStore_object.
AgentsApiResponseFormatMode	Represents the mode in which the model will handle the return format of a tool call.
AgentsApiToolChoiceOptionMode	Specifies how the tool choice will be used.
AgentsNamedToolChoiceType	Available tool types for agents named tools.
AgentStreamEvent	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.
ApiResponseFormat	Possible API response formats.
DoneEvent	Terminal event indicating the successful end of a stream.
ErrorEvent	Terminal event indicating a server side error while streaming.
FileState	The state of the file.
Frequency	Frequency of the schedule - day, week, month, hour, minute.
IncompleteRunDetails	The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.
ListSortOrder	The available sorting options when requesting a list of response objects.
MessageDeltaChunkObject	The MessageDeltaChunk_object.
MessageIncompleteDetailsReason	A set of reasons describing why a message is marked as incomplete.
MessageRole	The possible values for roles attributed to messages in a thread.
MessageStatus	The possible execution status values for a thread message.
MessageStreamEvent	Message operation related streaming events.
RunStatus	Possible values for the status of an agent thread run.
RunStepDeltaChunkObject	The RunStepDeltaChunk_object.
RunStepErrorCode	Possible error code values attributable to a failed run step.
RunStepStatus	Possible values for the status of a run step.
RunStepStreamEvent	Run step operation related streaming events.
RunStepType	The possible types of run steps.
RunStreamEvent	Run operation related streaming events.
ThreadStreamEvent	Thread operation related streaming events.
TruncationStrategy	Possible truncation strategies for the thread.
VectorStoreDeletionStatusObject	The VectorStoreDeletionStatus_object.
VectorStoreExpirationPolicyAnchor	Describes the relationship between the days and the expiration of this vector store.
VectorStoreFileBatchObject	The VectorStoreFileBatch_object.
VectorStoreFileBatchStatus	The status of the vector store file batch.
VectorStoreFileDeletionStatusObject	The VectorStoreFileDeletionStatus_object.
VectorStoreFileErrorCode	Error code variants for vector store file processing.
VectorStoreFileObject	The VectorStoreFile_object.
VectorStoreFileStatus	Vector store file status.
VectorStoreFileStatusFilter	Query parameter filter for vector store file retrieval endpoint.
VectorStoreObject	The VectorStore_object.
VectorStoreStatus	Vector store possible status.
WeekDays	WeekDay of the schedule - Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.

Enums

AIProjectClientOptions.ServiceVersion	The version of the service to use.
AuthenticationType	Authentication type used by Azure AI service to connect to another service.
ConnectionType	The Type (or category) of the connection.
StreamingUpdateReason	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.
VectorStoreDataSourceAssetType	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.