Azure.AI.OpenAI.Assistants Namespace

Classes

Assistant	Represents an assistant that can call the model and use tools.
AssistantCreationOptions	The request details to use when creating a new assistant.
AssistantFile	Information about a file attached to an assistant, as used by tools that can read files.
AssistantsClient	Azure OpenAI APIs for Assistants.
AssistantsClientOptions	Client options for AssistantsClient.
AssistantsModelFactory	Model factory for models.
AssistantThread	Information about a single thread associated with an assistant.
AssistantThreadCreationOptions	The details used to create a new assistant thread.
CodeInterpreterToolDefinition	The input definition information for a code interpreter tool as used to configure an assistant.
CreateAndRunThreadOptions	The details used when creating and immediately running a new assistant thread.
CreateRunOptions	The details used when creating a new run of an assistant thread.
FunctionToolDefinition	The input definition information for a function tool as used to configure an assistant.
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.
MessageFile	Information about a file attached to an assistant thread message.
MessageImageFileContent	A representation of image file content in a thread message.
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 assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files.
MessageTextFilePathAnnotation	A citation within the message that points to a file located at a specific path.
OpenAIFile	Represents an assistant that can call the model and use tools.
PageableList<T>	Represents a pageable list of data items with item ID cursors representing the start and end of the current page.
RequiredAction	An abstract representation of a required action for an assistant 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.
RequiredFunctionToolCall	A representation of a requested call to a function tool, needed by the model to continue evaluation of a run.
RequiredToolCall	An abstract representation a a tool invocation needed by the model to continue a run. Please note RequiredToolCall 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 RequiredFunctionToolCall.
RetrievalToolDefinition	The input definition information for a retrieval tool as used to configure an assistant.
RunError	The details of an error as encountered by an assistant thread run.
RunStep	Detailed information about a single step of an assistant thread run.
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.
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.
RunStepError	The error information associated with a failed run step.
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.
RunStepRetrievalToolCall	A record of a call to a retrieval tool, issued by the model in evaluation of a defined tool, that represents executed retrieval 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 RunStepCodeInterpreterToolCall, RunStepFunctionToolCall and RunStepRetrievalToolCall.
RunStepToolCallDetails	The detailed information associated with a run step calling tools.
SubmitToolOutputsAction	The details for required tool calls that must be submitted for an assistant thread run to continue.
ThreadInitializationMessage	A single message within an assistant thread, as provided during that thread's creation for its initial state.
ThreadMessage	A single, existing message within an assistant thread.
ThreadRun	Data representing a single evaluation run of an assistant thread.
ToolDefinition	An abstract representation of an input tool definition that an assistant 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 CodeInterpreterToolDefinition, FunctionToolDefinition and RetrievalToolDefinition.
ToolOutput	The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue.
UpdateAssistantOptions	The request details to use when modifying an existing assistant.

Structs

ListSortOrder	The available sorting options when requesting a list of response objects.
MessageRole	The possible values for roles attributed to messages in a thread.
OpenAIFilePurpose	The possible values denoting the intended usage of a file.
RunStatus	Possible values for the status of an assistant thread run.
RunStepErrorCode	Possible error code values attributable to a failed run step.
RunStepStatus	Possible values for the status of a run step.
RunStepType	The possible types of run steps.

Enums

AssistantsClientOptions.ServiceVersion

The version of the service to use.