Azure.AI.OpenAI Namespace

Classes

AudioTranscription	Result information for an operation that transcribed spoken audio into written text.
AudioTranscriptionOptions	The configuration information for an audio transcription request.
AudioTranscriptionSegment	Extended information about a single segment of transcribed audio data. Segments generally represent roughly 5-10 seconds of speech. Segment boundaries typically occur between words but not necessarily sentences.
AudioTranscriptionWord	Extended information about a single transcribed word, as provided on responses when the 'word' timestamp granularity is provided.
AudioTranslation	Result information for an operation that translated spoken audio into written text.
AudioTranslationOptions	The configuration information for an audio translation request.
AudioTranslationSegment	Extended information about a single segment of translated audio data. Segments generally represent roughly 5-10 seconds of speech. Segment boundaries typically occur between words but not necessarily sentences.
AzureChatEnhancementConfiguration	A representation of the available Azure OpenAI enhancement configurations.
AzureChatEnhancements	Represents the output results of Azure enhancements to chat completions, as configured via the matching input provided in the request.
AzureChatExtensionConfiguration	A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat completions request that should use Azure OpenAI chat extensions to augment the response behavior. The use of this configuration is compatible only with Azure OpenAI. Please note AzureChatExtensionConfiguration 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 AzureCosmosDBChatExtensionConfiguration, AzureMachineLearningIndexChatExtensionConfiguration, AzureSearchChatExtensionConfiguration, ElasticsearchChatExtensionConfiguration and PineconeChatExtensionConfiguration.
AzureChatExtensionDataSourceResponseCitation	A single instance of additional context information available when Azure OpenAI chat extensions are involved in the generation of a corresponding chat completions response. This context information is only populated when using an Azure OpenAI request configured to use a matching extension.
AzureChatExtensionsMessageContext	A representation of the additional context information available when Azure OpenAI chat extensions are involved in the generation of a corresponding chat completions response. This context information is only populated when using an Azure OpenAI request configured to use a matching extension.
AzureChatExtensionsOptions	An abstraction of additional settings used by chat completions to supplement standard behavior with capabilities from configured Azure OpenAI extensions. These capabilities are specific to Azure OpenAI and chat completions requests configured to use them will require use with with that service endpoint.
AzureChatGroundingEnhancementConfiguration	A representation of the available options for the Azure OpenAI grounding enhancement.
AzureChatOCREnhancementConfiguration	A representation of the available options for the Azure OpenAI optical character recognition (OCR) enhancement.
AzureCosmosDBChatExtensionConfiguration	A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat extension.
AzureCosmosDBFieldMappingOptions	Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource.
AzureGroundingEnhancement	The grounding enhancement that returns the bounding box of the objects detected in the image.
AzureGroundingEnhancementCoordinatePoint	A representation of a single polygon point as used by the Azure grounding enhancement.
AzureGroundingEnhancementLine	A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.
AzureGroundingEnhancementLineSpan	A span object that represents a detected object and its bounding box information.
AzureMachineLearningIndexChatExtensionConfiguration	A specific representation of configurable options for Azure Machine Learning vector index when using it as an Azure OpenAI chat extension.
AzureOpenAIModelFactory	Model factory for models.
AzureSearchChatExtensionConfiguration	A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat extension.
AzureSearchIndexFieldMappingOptions	Optional settings to control how fields are processed when using a configured Azure Search resource.
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.
ChatChoiceLogProbabilityInfo	Log probability information for a choice, as requested via 'logprobs' and 'top_logprobs'.
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.
ChatCompletionsFunctionToolCall	A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents a function invocation needed for a subsequent chat completions request to resolve.
ChatCompletionsFunctionToolDefinition	The definition information for a chat completions function tool that can call a function in response to a tool call.
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	An abstract representation of a response format configuration usable by Chat Completions. Can be used to enable JSON mode. 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..
ChatCompletionsToolCall	An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested chat completion. Please note ChatCompletionsToolCall 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 ChatCompletionsFunctionToolCall.
ChatCompletionsToolChoice	Represents an optional control that specifies which, if any, tools may be called by the model while processing a chat completions request.
ChatCompletionsToolDefinition	An abstract representation of a tool that can be used by the model to improve a chat completions response. Please note ChatCompletionsToolDefinition 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 ChatCompletionsFunctionToolDefinition.
ChatFinishDetails	An abstract representation of structured information about why a chat completions response terminated. Please note ChatFinishDetails 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 MaxTokensFinishDetails and StopFinishDetails.
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.
ChatMessageImageUrl	An internet location from which the model may retrieve an image.
ChatMessageTextContentItem	A structured chat content item containing plain text.
ChatRequestAssistantMessage	A request chat message representing response or action from the assistant.
ChatRequestFunctionMessage	A request chat message representing requested output from a configured function.
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, ChatRequestFunctionMessage, 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.
ChatTokenLogProbabilityInfo	A representation of the log probability information for a single message content token.
ChatTokenLogProbabilityResult	A representation of the log probability information for a single content token, including a list of most likely tokens if 'top_logprobs' were requested.
Choice	The representation of a single prompt completion as part of an overall 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.
Completions	Representation of the response data from a completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
CompletionsLogProbabilityModel	Representation of a log probabilities model for a completions generation.
CompletionsOptions	The configuration information for a completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
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.
ContentFilterBlocklistIdResult	Represents the outcome of an evaluation against a custom blocklist as performed by content filtering.
ContentFilterCitedDetectionResult	Represents the outcome of a detection operation against protected resources as performed by content filtering.
ContentFilterDetailedResults	Represents a structured collection of result details for content filtering.
ContentFilterDetectionResult	Represents the outcome of a detection operation performed by content filtering.
ContentFilterResult	Information about filtered content severity level and if it has been filtered or not.
ContentFilterResultDetailsForPrompt	Information about content filtering evaluated against input data to Azure OpenAI.
ContentFilterResultsForChoice	Information about content filtering evaluated against generated model output.
ContentFilterResultsForPrompt	Content filtering results for a single prompt in the request.
ElasticsearchChatExtensionConfiguration	A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat extension.
ElasticsearchIndexFieldMappingOptions	Optional settings to control how fields are processed when using a configured Elasticsearch® resource.
EmbeddingItem	Representation of a single embeddings relatedness comparison.
Embeddings	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.
EmbeddingsOptions	The configuration information for 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.
ImageGenerationContentFilterResults	Describes the content filtering result for the image generation request.
ImageGenerationData	A representation of a single generated image, provided as either base64-encoded data or as a URL from which the image may be retrieved.
ImageGenerationOptions	Represents the request data used to generate images.
ImageGenerationPromptFilterResults	Describes the content filtering results for the prompt of a image generation request.
ImageGenerations	The result of a successful image generation operation.
MaxTokensFinishDetails	A structured representation of a stop reason that signifies a token limit was reached before the model could naturally complete.
OnYourDataAccessTokenAuthenticationOptions	The authentication options for Azure OpenAI On Your Data when using access token.
OnYourDataApiKeyAuthenticationOptions	The authentication options for Azure OpenAI On Your Data when using an API key.
OnYourDataAuthenticationOptions	The authentication options for Azure OpenAI On Your Data. Please note OnYourDataAuthenticationOptions 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 OnYourDataAccessTokenAuthenticationOptions, OnYourDataApiKeyAuthenticationOptions, OnYourDataConnectionStringAuthenticationOptions, OnYourDataEncodedApiKeyAuthenticationOptions, OnYourDataKeyAndKeyIdAuthenticationOptions, OnYourDataSystemAssignedManagedIdentityAuthenticationOptions and OnYourDataUserAssignedManagedIdentityAuthenticationOptions.
OnYourDataConnectionStringAuthenticationOptions	The authentication options for Azure OpenAI On Your Data when using a connection string.
OnYourDataDeploymentNameVectorizationSource	The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based on an internal embeddings model deployment name in the same Azure OpenAI resource.
OnYourDataEncodedApiKeyAuthenticationOptions	The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.
OnYourDataEndpointVectorizationSource	The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based on a public Azure OpenAI endpoint call for embeddings.
OnYourDataKeyAndKeyIdAuthenticationOptions	The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.
OnYourDataModelIdVectorizationSource	The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based on a search service model ID. Currently only supported by Elasticsearch®.
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions	The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.
OnYourDataUserAssignedManagedIdentityAuthenticationOptions	The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.
OnYourDataVectorizationSource	An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search. Please note OnYourDataVectorizationSource 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 OnYourDataDeploymentNameVectorizationSource, OnYourDataEndpointVectorizationSource and OnYourDataModelIdVectorizationSource.
OpenAIClient	The OpenAI service client.
OpenAIClientOptions	Client options for OpenAIClient.
PineconeChatExtensionConfiguration	A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat extension.
PineconeFieldMappingOptions	Optional settings to control how fields are processed when using a configured Pinecone resource.
SpeechGenerationOptions	A representation of the request options that control the behavior of a text-to-speech operation.
StopFinishDetails	A structured representation of a stop reason that signifies natural termination by the model.
StreamingChatCompletionsUpdate	Represents an incremental update to a streamed Chat Completions response.
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

AudioTranscriptionFormat	Defines available options for the underlying response format of output transcription information.
AudioTranslationFormat	Defines available options for the underlying response format of output translation information.
AzureSearchQueryType	The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI chat extension.
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.
ContentFilterSeverity	Ratings for the intensity and risk level of harmful content.
ElasticsearchQueryType	The type of Elasticsearch® retrieval query that should be executed when using it as an Azure OpenAI chat extension.
ImageGenerationQuality	An image generation configuration that specifies how the model should prioritize quality, cost, and speed. Only configurable with dall-e-3 models.
ImageGenerationStyle	An image generation configuration that specifies how the model should incorporate realism and other visual characteristics. Only configurable with dall-e-3 models.
ImageSize	The desired size of generated images.
SpeechGenerationResponseFormat	The supported audio output formats for text-to-speech.
SpeechVoice	The available voices for text-to-speech.

Enums

AudioTimestampGranularity	Specifies the available audio timestamp granularities when providing timing information in transcription operations.
OpenAIClientOptions.ServiceVersion	The version of the service to use.