Azure.AI.OpenAI (.NET)
Biblioteca de cliente para o serviço Azure OpenAI que fornece acesso a modelos OpenAI, incluindo GPT-4, GPT-4o, embeddings, DALL-E e Whisper.
Instalação
dotnet add package Azure.AI.OpenAI
dotnet add package OpenAI
Versão Atual: 2.1.0 (estável)
Variáveis de Ambiente
AZURE_OPENAI_ENDPOINT=https://<resource-name>.openai.azure.com
AZURE_OPENAI_API_KEY=<api-key>
AZURE_OPENAI_DEPLOYMENT_NAME=gpt-4o-mini
AZURE_TOKEN_CREDENTIALS=prod
Hierarquia de Clientes
AzureOpenAIClient (nível superior)
├── GetChatClient(deploymentName) → ChatClient
├── GetEmbeddingClient(deploymentName) → EmbeddingClient
├── GetImageClient(deploymentName) → ImageClient
├── GetAudioClient(deploymentName) → AudioClient
└── GetAssistantClient() → AssistantClient
Autenticação
Autenticação via Chave de API
using Azure;
using Azure.AI.OpenAI;
AzureOpenAIClient client = new(
new Uri(Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT")!),
new AzureKeyCredential(Environment.GetEnvironmentVariable("AZURE_OPENAI_API_KEY")!));
Token de Credencial Microsoft Entra
using Azure.Identity;
using Azure.AI.OpenAI;
var credential = new DefaultAzureCredential(
DefaultAzureCredential.DefaultEnvironmentVariableName
);
AzureOpenAIClient client = new(
new Uri(Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT")!),
credential);
Usando o SDK OpenAI Diretamente com Azure
using Azure.Identity;
using OpenAI;
using OpenAI.Chat;
using System.ClientModel.Primitives;
#pragma warning disable OPENAI001
BearerTokenPolicy tokenPolicy = new(
new DefaultAzureCredential(),
"https://cognitiveservices.azure.com/.default");
ChatClient client = new(
model: "gpt-4o-mini",
authenticationPolicy: tokenPolicy,
options: new OpenAIClientOptions()
{
Endpoint = new Uri("https://YOUR-RESOURCE.openai.azure.com/openai/v1")
});
Completions de Chat
Chat Básico
using Azure.AI.OpenAI;
using OpenAI.Chat;
AzureOpenAIClient azureClient = new(
new Uri(endpoint),
new DefaultAzureCredential());
ChatClient chatClient = azureClient.GetChatClient("gpt-4o-mini");
ChatCompletion completion = chatClient.CompleteChat(
[
new SystemChatMessage("Você é um assistente útil."),
new UserChatMessage("O que é Azure OpenAI?")
]);
Console.WriteLine(completion.Content[0].Text);
Chat Assíncrono
ChatCompletion completion = await chatClient.CompleteChatAsync(
[
new SystemChatMessage("Você é um assistente útil."),
new UserChatMessage("Explique computação em nuvem em termos simples.")
]);
Console.WriteLine($"Resposta: {completion.Content[0].Text}");
Console.WriteLine($"Tokens usados: {completion.Usage.TotalTokenCount}");
Chat com Streaming
await foreach (StreamingChatCompletionUpdate update
in chatClient.CompleteChatStreamingAsync(messages))
{
if (update.ContentUpdate.Count > 0)
{
Console.Write(update.ContentUpdate[0].Text);
}
}
Chat com Opções
ChatCompletionOptions options = new()
{
MaxOutputTokenCount = 1000,
Temperature = 0.7f,
TopP = 0.95f,
FrequencyPenalty = 0,
PresencePenalty = 0
};
ChatCompletion completion = await chatClient.CompleteChatAsync(messages, options);
Conversa de Múltiplas Interações
List<ChatMessage> messages = new()
{
new SystemChatMessage("Você é um assistente útil."),
new UserChatMessage("Oi, pode me ajudar?"),
new AssistantChatMessage("Claro! Com o que você precisa de ajuda?"),
new UserChatMessage("Qual é a capital da França?")
};
ChatCompletion completion = await chatClient.CompleteChatAsync(messages);
messages.Add(new AssistantChatMessage(completion.Content[0].Text));
Saídas Estruturadas (JSON Schema)
using System.Text.Json;
ChatCompletionOptions options = new()
{
ResponseFormat = ChatResponseFormat.CreateJsonSchemaFormat(
jsonSchemaFormatName: "raciocinio_matematico",
jsonSchema: BinaryData.FromBytes("""
{
"type": "object",
"properties": {
"passos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"explicacao": { "type": "string" },
"resultado": { "type": "string" }
},
"required": ["explicacao", "resultado"],
"additionalProperties": false
}
},
"resposta_final": { "type": "string" }
},
"required": ["passos", "resposta_final"],
"additionalProperties": false
}
"""u8.ToArray()),
jsonSchemaIsStrict: true)
};
ChatCompletion completion = await chatClient.CompleteChatAsync(
[new UserChatMessage("Como resolver 8x + 7 = -23?")],
options);
using JsonDocument json = JsonDocument.Parse(completion.Content[0].Text);
Console.WriteLine($"Resposta: {json.RootElement.GetProperty("resposta_final")}");
Modelos de Raciocínio (o1, o4-mini)
ChatCompletionOptions options = new()
{
ReasoningEffortLevel = ChatReasoningEffortLevel.Low,
MaxOutputTokenCount = 100000
};
ChatCompletion completion = await chatClient.CompleteChatAsync(
[
new DeveloperChatMessage("Você é um assistente útil"),
new UserChatMessage("Explique a teoria da relatividade")
], options);
Integração Azure AI Search (RAG)
using Azure.AI.OpenAI.Chat;
#pragma warning disable AOAI001
ChatCompletionOptions options = new();
options.AddDataSource(new AzureSearchChatDataSource()
{
Endpoint = new Uri(searchEndpoint),
IndexName = searchIndex,
Authentication = DataSourceAuthentication.FromApiKey(searchKey)
});
ChatCompletion completion = await chatClient.CompleteChatAsync(
[new UserChatMessage("Quais planos de saúde estão disponíveis?")],
options);
ChatMessageContext context = completion.GetMessageContext();
if (context?.Intent is not null)
{
Console.WriteLine($"Intenção: {context.Intent}");
}
foreach (ChatCitation citation in context?.Citations ?? [])
{
Console.WriteLine($"Citação: {citation.Content}");
}
Embeddings
using OpenAI.Embeddings;
EmbeddingClient embeddingClient = azureClient.GetEmbeddingClient("text-embedding-ada-002");
OpenAIEmbedding embedding = await embeddingClient.GenerateEmbeddingAsync("Olá, mundo!");
ReadOnlyMemory<float> vector = embedding.ToFloats();
Console.WriteLine($"Dimensões do embedding: {vector.Length}");
Embeddings em Lote
List<string> inputs = new()
{
"Texto do primeiro documento",
"Texto do segundo documento",
"Texto do terceiro documento"
};
OpenAIEmbeddingCollection embeddings = await embeddingClient.GenerateEmbeddingsAsync(inputs);
foreach (OpenAIEmbedding emb in embeddings)
{
Console.WriteLine($"Índice {emb.Index}: {emb.ToFloats().Length} dimensões");
}
Geração de Imagens (DALL-E)
using OpenAI.Images;
ImageClient imageClient = azureClient.GetImageClient("dall-e-3");
GeneratedImage image = await imageClient.GenerateImageAsync(
"Um horizonte de cidade futurista ao pôr do sol",
new ImageGenerationOptions
{
Size = GeneratedImageSize.W1024xH1024,
Quality = GeneratedImageQuality.High,
Style = GeneratedImageStyle.Vivid
});
Console.WriteLine($"URL da imagem: {image.ImageUri}");
Áudio (Whisper)
Transcrição
using OpenAI.Audio;
AudioClient audioClient = azureClient.GetAudioClient("whisper");
AudioTranscription transcription = await audioClient.TranscribeAudioAsync(
"audio.mp3",
new AudioTranscriptionOptions
{
ResponseFormat = AudioTranscriptionFormat.Verbose,
Language = "pt"
});
Console.WriteLine(transcription.Text);
Texto-para-Fala
BinaryData speech = await audioClient.GenerateSpeechAsync(
"Olá, bem-vindo ao Azure OpenAI!",
GeneratedSpeechVoice.Alloy,
new SpeechGenerationOptions
{
SpeedRatio = 1.0f,
ResponseFormat = GeneratedSpeechFormat.Mp3
});
await File.WriteAllBytesAsync("output.mp3", speech.ToArray());
Chamada de Função (Ferramentas)
ChatTool getCurrentWeatherTool = ChatTool.CreateFunctionTool(
functionName: "obter_clima_atual",
functionDescription: "Obter o clima atual em uma determinada localização",
functionParameters: BinaryData.FromString("""
{
"type": "object",
"properties": {
"localizacao": {
"type": "string",
"description": "A cidade e estado, ex. São Paulo, SP"
},
"unidade": {
"type": "string",
"enum": ["celsius", "fahrenheit"]
}
},
"required": ["localizacao"]
}
"""));
ChatCompletionOptions options = new()
{
Tools = { getCurrentWeatherTool }
};
ChatCompletion completion = await chatClient.CompleteChatAsync(
[new UserChatMessage("Como está o clima em Seattle?")],
options);
if (completion.FinishReason == ChatFinishReason.ToolCalls)
{
foreach (ChatToolCall toolCall in completion.ToolCalls)
{
Console.WriteLine($"Função: {toolCall.FunctionName}");
Console.WriteLine($"Argumentos: {toolCall.FunctionArguments}");
}
}
Referência de Tipos Principais
| Tipo | Propósito |
|---|
AzureOpenAIClient | Cliente de nível superior para Azure OpenAI |
ChatClient | Completions de chat |
EmbeddingClient | Embeddings de texto |
ImageClient | Geração de imagens (DALL-E) |
AudioClient | Transcrição de áudio/TTS |
ChatCompletion | Resposta do chat |
ChatCompletionOptions | Configuração da requisição |
StreamingChatCompletionUpdate | Fragmento da resposta em streaming |
ChatMessage | Tipo base de mensagem |
SystemChatMessage | Prompt do sistema |
UserChatMessage | Entrada do usuário |
AssistantChatMessage | Resposta do assistente |
DeveloperChatMessage | Mensagem do desenvolvedor (modelos de raciocínio) |
ChatTool | Definição de função/ferramenta |
ChatToolCall | Solicitação de invocação de ferramenta |
Melhores Práticas
- Use Entra ID em produção — Evite chaves de API; use
DefaultAzureCredential
- Reutilize instâncias de cliente — Crie uma vez, compartilhe entre requisições
- Lide com limites de taxa — Implemente backoff exponencial para erros 429
- Faça streaming para respostas longas — Use
CompleteChatStreamingAsync para melhor experiência do usuário
- Defina timeouts adequados — Completions longas podem precisar de timeouts estendidos
- Use saídas estruturadas — O esquema JSON garante um formato de resposta consistente
- Monitore o uso de tokens — Acompanhe
completion.Usage para gerenciamento de custos
- Valide chamadas de ferramenta — Sempre valide os argumentos da função antes da execução
Tratamento de Erros
using Azure;
try
{
ChatCompletion completion = await chatClient.CompleteChatAsync(messages);
}
catch (RequestFailedException ex) when (ex.Status == 429)
{
Console.WriteLine("Limite de taxa excedido. Repetir após atraso.");
await Task.Delay(TimeSpan.FromSeconds(10));
}
catch (RequestFailedException ex) when (ex.Status == 400)
{
Console.WriteLine($"Requisição inválida: {ex.Message}");
}
catch (RequestFailedException ex)
{
Console.WriteLine($"Erro do Azure OpenAI: {ex.Status} - {ex.Message}");
}
SDKs Relacionados
| SDK | Propósito | Instalação |
|---|
Azure.AI.OpenAI | Cliente Azure OpenAI (este SDK) | dotnet add package Azure.AI.OpenAI |
OpenAI | Compatibilidade OpenAI | dotnet add package OpenAI |
Azure.Identity | Autenticação | dotnet add package Azure.Identity |
Azure.Search.Documents | AI Search para RAG | dotnet add package Azure.Search.Documents |
Links de Referência