Azure.AI.Inference Namespace

Classes

AIInferenceModelFactory	Model factory for models.
AzureAIInferenceClientOptions	Client options for Azure.AI.Inference library clients.
ChatChoice	The representation of a single prompt completion as part of an overall chat completions request. Generally, n choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated.
ChatCompletions	Representation of the response data from a chat completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
ChatCompletionsClient	The ChatCompletions service client.
ChatCompletionsNamedToolChoice	A tool selection of a specific, named function tool that will limit chat completions to using the named function.
ChatCompletionsNamedToolChoiceFunction	A tool selection of a specific, named function tool that will limit chat completions to using the named function.
ChatCompletionsOptions	The configuration information for a chat completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
ChatCompletionsResponseFormat	Represents the format that the model must output. Use this to enable JSON mode instead of the default text mode. Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON via a system or user message. Please note ChatCompletionsResponseFormat 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 ChatCompletionsResponseFormatJSON and ChatCompletionsResponseFormatText.
ChatCompletionsResponseFormatJSON	A response format for Chat Completions that restricts responses to emitting valid JSON objects. Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON via a system or user message.
ChatCompletionsResponseFormatText	A response format for Chat Completions that emits text responses. This is the default response format.
ChatCompletionsToolCall	A function tool call requested by the AI model.
ChatCompletionsToolChoice	Represents an optional control that specifies which, if any, tools may be called by the model while processing a chat completions request.
ChatCompletionsToolDefinition	The definition of a chat completions tool that can call a function.
ChatMessageContentItem	An abstract representation of a structured content item within a chat message. Please note ChatMessageContentItem 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 ChatMessageImageContentItem and ChatMessageTextContentItem.
ChatMessageImageContentItem	A structured chat content item containing an image reference.
ChatMessageTextContentItem	A structured chat content item containing plain text.
ChatRequestAssistantMessage	A request chat message representing response or action from the assistant.
ChatRequestMessage	An abstract representation of a chat message as provided in a request. Please note ChatRequestMessage 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 ChatRequestAssistantMessage, ChatRequestSystemMessage, ChatRequestToolMessage and ChatRequestUserMessage.
ChatRequestSystemMessage	A request chat message containing system instructions that influence how the model will generate a chat completions response.
ChatRequestToolMessage	A request chat message representing requested output from a configured tool.
ChatRequestUserMessage	A request chat message representing user input to the assistant.
ChatResponseMessage	A representation of a chat message as received in a response.
CompletionsUsage	Representation of the token counts processed for a completions request. Counts consider all tokens across prompts, choices, choice alternates, best_of generations, and other consumers.
EmbeddingItem	Representation of a single embeddings relatedness comparison.
EmbeddingsClient	The Embeddings service client.
EmbeddingsOptions	The configuration information for an embeddings request.
EmbeddingsResult	Representation of the response data from an embeddings request. Embeddings measure the relatedness of text strings and are commonly used for search, clustering, recommendations, and other similar scenarios.
EmbeddingsUsage	Measurement of the amount of tokens used in this request and response.
FunctionCall	The name and arguments of a function that should be called, as generated by the model.
FunctionDefinition	The definition of a caller-specified function that chat completions may invoke in response to matching user input.
ModelInfo	Represents some basic information about the AI model.
StreamingChatChoiceUpdate	Represents an update to a single prompt completion when the service is streaming updates using Server Sent Events (SSE). Generally, n choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated.
StreamingChatCompletionsUpdate	Represents an incremental update to a streamed Chat Completions response.
StreamingChatResponseMessageUpdate	A representation of a chat message update as received in a streaming response.
StreamingChatResponseToolCallUpdate	An update to the function tool call information requested by the AI model.
StreamingFunctionToolCallUpdate	Represents an incremental update to a streaming function tool call that is part of a streaming chat completions choice.
StreamingResponse<T>	Represents an operation response with streaming content that can be deserialized and enumerated while the response is still being received.
StreamingToolCallUpdate	Represents an incremental update to a streaming tool call that is part of a streaming chat completions choice.

Structs

ChatCompletionsNamedToolChoiceType	The ChatCompletionsNamedToolChoice_type.
ChatCompletionsToolCallType	The ChatCompletionsToolCall_type.
ChatCompletionsToolChoicePreset	Represents a generic policy for how a chat completions tool may be selected.
ChatCompletionsToolDefinitionType	The ChatCompletionsToolDefinition_type.
ChatMessageImageDetailLevel	A representation of the possible image detail levels for image-based chat completions message content.
ChatRole	A description of the intended purpose of a message within a chat completions interaction.
CompletionsFinishReason	Representation of the manner in which a completions response concluded.
EmbeddingEncodingFormat	The format of the embeddings result. Returns a 422 error if the model doesn't support the value or parameter.
EmbeddingInputType	Represents the input types used for embedding search.
ExtraParameters	Controls what happens if extra parameters, undefined by the REST API, are passed in the JSON request payload.
ModelType	The type of AI model.

Enums

AzureAIInferenceClientOptions.ServiceVersion

The version of the service to use.