Introdução ao bloco de construção de segurança do Azure OpenAI

• O Microsoft AI Chat Protocol fornece contratos de API padronizados em soluções e idiomas de IA. O aplicativo de bate-papo está em conformidade com o Microsoft AI Chat Protocol, que permite que o aplicativo de avaliações seja executado em qualquer aplicativo de bate-papo que esteja em conformidade com o protocolo.
• Um Python Quart que usa o openai pacote para gerar respostas a mensagens do usuário.
• Um frontend HTML/JavaScript básico que transmite respostas do back-end usando linhas JSON em um ReadableStream.

• Um aplicativo Web Blazor que usa o pacote Azure.AI.OpenAI NuGet para gerar respostas às mensagens do usuário.

Explorando o código de exemplo

Embora o OpenAI e o Serviço OpenAI do Azure dependam de uma biblioteca de cliente Python comum, pequenas alterações de código são necessárias ao usar pontos de extremidade do Azure OpenAI. Vamos ver como este exemplo configura a autenticação sem chave com o Microsoft Entra ID e se comunica com o Azure OpenAI.

Configurar autenticação com identidade gerenciada

Neste exemplo, o arquivo começa com a src\quartapp\chat.py configuração da autenticação sem chave.

O trecho a seguir usa o módulo azure.identity.aio para criar um fluxo de autenticação assíncrono do Microsoft Entra.

O trecho de código a seguir usa a AZURE_CLIENT_ID azd variável de ambiente para criar uma instância ManagedIdentityCredential capaz de autenticar por meio da identidade gerenciada atribuída pelo usuário.

user_assigned_managed_identity_credential = ManagedIdentityCredential(client_id=os.getenv("AZURE_CLIENT_ID")) 

O trecho de código a seguir usa AZURE_TENANT_ID azd a variável de ambiente de recursos para criar uma instância AzureDeveloperCliCredential capaz de autenticar com o locatário atual do Microsoft Entra.

azure_dev_cli_credential = AzureDeveloperCliCredential(tenant_id=os.getenv("AZURE_TENANT_ID"), process_timeout=60)  

A biblioteca de cliente do Azure Identity fornece credenciais — classes públicas que implementam o protocolo TokenCredential da biblioteca do Azure Core. Uma credencial representa um fluxo de autenticação distinto para adquirir um token de acesso do Microsoft Entra ID. Essas credenciais podem ser encadeadas para formar uma sequência ordenada de mecanismos de autenticação a serem tentados.

O trecho a seguir cria um ChainedTokenCredential usando a ManagedIdentityCredential e um AzureDeveloperCliCredential:

• O ManagedIdentityCredential é usado para o Azure Functions e o Serviço de Aplicativo do Azure. Uma identidade gerenciada atribuída pelo usuário é suportada passando o client_id para ManagedIdentityCredential.
• O AzureDeveloperCliCredential é usado para o desenvolvimento local. Ele foi definido anteriormente com base no locatário do Microsoft Entra a ser usado.

azure_credential = ChainedTokenCredential(
    user_assigned_managed_identity_credential,
    azure_dev_cli_credential
)

O trecho de código a seguir obtém o provedor de token OpenAI do Azure com base na credencial do Azure selecionada. Esse valor é obtido chamando o azure.identity.aio.get_bearer_token_provider com dois argumentos:

• azure_credential: A ChainedTokenCredential instância criada anteriormente para autenticar a solicitação.

• https://cognitiveservices.azure.com/.default: Necessário um ou mais escopos de token de portador. Nesse caso, o ponto de extremidade dos Serviços Cognitivos do Azure.

token_provider = get_bearer_token_provider(
    azure_credential, "https://cognitiveservices.azure.com/.default"
)

As linhas a seguir verificam as variáveis de ambiente necessárias AZURE_OPENAI_ENDPOINT e AZURE_OPENAI_CHATGPT_DEPLOYMENT azd de recursos, que são provisionadas durante azd a implantação do aplicativo. Um erro é lançado se um valor não estiver presente.

if not os.getenv("AZURE_OPENAI_ENDPOINT"):
    raise ValueError("AZURE_OPENAI_ENDPOINT is required for Azure OpenAI")
if not os.getenv("AZURE_OPENAI_CHATGPT_DEPLOYMENT"):
    raise ValueError("AZURE_OPENAI_CHATGPT_DEPLOYMENT is required for Azure OpenAI")

Este trecho inicializa o cliente OpenAI do Azure, definindo os api_versionparâmetros , azure_endpointe azure_ad_token_provider (client_args):

bp.openai_client = AsyncAzureOpenAI(
    api_version=os.getenv("AZURE_OPENAI_API_VERSION") or "2024-02-15-preview",
    azure_endpoint=os.getenv("AZURE_OPENAI_ENDPOINT"),
    azure_ad_token_provider=token_provider,
)  

A linha a seguir define o nome de implantação do modelo OpenAI do Azure para uso em chamadas de API:

bp.openai_model = os.getenv("AZURE_OPENAI_CHATGPT_DEPLOYMENT")

Quando essa função for concluída, o cliente estará configurado corretamente e pronto para interagir com os serviços do Azure OpenAI.

Fluxo de resposta usando o OpenAI Client e o modelo

O response_stream lida com a chamada de conclusão do chat na rota. O trecho de código a seguir mostra como openai_client e model são usados.

async def response_stream():
    # This sends all messages, so API request may exceed token limits
    all_messages = [
        {"role": "system", "content": "You are a helpful assistant."},
    ] + request_messages

    chat_coroutine = bp.openai_client.chat.completions.create(
        # Azure Open AI takes the deployment name as the model name
        model=bp.openai_model,
        messages=all_messages,
        stream=True,
    )

Explore o código de exemplo

Os aplicativos .NET dependem da biblioteca de cliente Azure.AI.OpenAI para se comunicar com os serviços OpenAI do Azure, que depende da biblioteca OpenAI . O aplicativo de exemplo configura a autenticação sem chave usando o Microsoft Entra ID para se comunicar com o Azure OpenAI.

Configurar autenticação e registro de serviço

Neste exemplo, a autenticação sem chave é configurada program.cs no arquivo. O trecho de código a seguir usa a AZURE_CLIENT_ID variável de ambiente definida por azd para criar uma instância ManagedIdentityCredential capaz de autenticar por meio da identidade gerenciada atribuída pelo usuário.

var userAssignedIdentityCredential = 
    new ManagedIdentityCredential(builder.Configuration.GetValue<string>("AZURE_CLIENT_ID"));

O trecho de código a seguir usa a AZURE_TENANT_ID variável de ambiente definida por azd para criar uma instância AzureDeveloperCliCredential capaz de autenticar localmente usando a conta conectada ao azd.

var azureDevCliCredential = new AzureDeveloperCliCredential(
    new AzureDeveloperCliCredentialOptions()
    { 
        TenantId = builder.Configuration.GetValue<string>("AZURE_TENANT_ID") 
    });

A biblioteca de cliente do Azure Identity fornece classes de credenciais que implementam o protocolo TokenCredential da biblioteca do Azure Core. Uma credencial representa um fluxo de autenticação distinto para adquirir um token de acesso do Microsoft Entra ID. Essas credenciais podem ser encadeadas usando ChainedTokenCredential para formar uma sequência ordenada de mecanismos de autenticação a serem tentados.

O trecho a seguir registra o AzureOpenAIClient para injeção de dependência e cria um ChainedTokenCredential usando a ManagedIdentityCredential e um AzureDeveloperCliCredential:

• O ManagedIdentityCredential é usado para o Azure Functions e o Serviço de Aplicativo do Azure. Uma identidade gerenciada atribuída pelo usuário é suportada usando o AZURE_CLIENT_ID que foi fornecido ao ManagedIdentityCredential.
• O AzureDeveloperCliCredential é usado para o desenvolvimento local. Ele foi definido anteriormente com base no locatário do Microsoft Entra a ser usado.

builder.Services.AddAzureClients(
    clientBuilder => {
        clientBuilder.AddClient<AzureOpenAIClient, AzureOpenAIClientOptions>((options, _, _)
            => new AzureOpenAIClient(
                new Uri(endpoint),
                new ChainedTokenCredential(
                    userAssignedIdentityCredential, azureDevCliCredential), options));
    });

Obter conclusão de chat usando o cliente OpenAI do Azure

O aplicativo web Blazor injeta o registrado AzureOpenAIClient na parte superior do Home.Razor componente:

@inject AzureOpenAIClient azureOpenAIClient

Quando o usuário envia o formulário, o AzureOpenAIClient envia seu prompt para o modelo OpenAI para gerar uma conclusão:

ChatClient chatClient = azureOpenAIClient.GetChatClient("gpt-4o-mini");

messages.Add(new UserChatMessage(model.UserMessage));

ChatCompletion completion = await chatClient.CompleteChatAsync(messages);
    messages.Add(new SystemChatMessage(completion.Content[0].Text));