AzureOpenAIClient Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The top-level client for the Azure OpenAI service.
public class AzureOpenAIClient : OpenAI.OpenAIClient
type AzureOpenAIClient = class
inherit OpenAIClient
Public Class AzureOpenAIClient
Inherits OpenAIClient
- Inheritance
-
OpenAI.OpenAIClientAzureOpenAIClient
Remarks
For scenario-specific operations, create a corresponding client using the matching method on this type, e.g. GetChatClient(String).
Constructors
AzureOpenAIClient() |
Creates a new instance of AzureOpenAIClient for mocking. |
AzureOpenAIClient(ClientPipeline, Uri, AzureOpenAIClientOptions) |
Creates a new instance of AzureOpenAIClient. |
AzureOpenAIClient(Uri, ApiKeyCredential, AzureOpenAIClientOptions) |
Creates a new instance of AzureOpenAIClient that will connect to a specified Azure OpenAI service resource endpoint using an API key. |
AzureOpenAIClient(Uri, ApiKeyCredential) |
Creates a new instance of AzureOpenAIClient that will connect to a specified Azure OpenAI service resource endpoint using an API key. |
AzureOpenAIClient(Uri, TokenCredential, AzureOpenAIClientOptions) |
Creates a new instance of AzureOpenAIClient that will connect to an Azure OpenAI service resource using token authentication, including for tokens issued via managed identity. |
AzureOpenAIClient(Uri, TokenCredential) |
Creates a new instance of AzureOpenAIClient that will connect to an Azure OpenAI service resource using token authentication, including for tokens issued via managed identity. |
Methods
GetAudioClient(String) |
Gets a new OpenAI.Audio.AudioClient instance configured for audio operation use with the Azure OpenAI service. |
GetBatchClient(String) |
Gets a new OpenAI.Batch.BatchClient instance configured for batch operation use with the Azure OpenAI service. |
GetChatClient(String) |
Gets a new OpenAI.Chat.ChatClient instance configured for chat completion operation use with the Azure OpenAI service. |
GetEmbeddingClient(String) |
Gets a new OpenAI.Embeddings.EmbeddingClient instance configured for embedding operation use with the Azure OpenAI service. |
GetImageClient(String) |
Gets a new OpenAI.Images.ImageClient instance configured for image operation use with the Azure OpenAI service. |
GetOpenAIFileClient() |
Gets a new OpenAI.Files.OpenAIFileClient instance configured for file operation use with the Azure OpenAI service. |
GetRealtimeConversationClient(String) |
Applies to
Azure SDK for .NET