Azure OpenAI セキュリティビルディングブロックの使い始め方

• Python Quartopenai パッケージと Responses API を使用してユーザー メッセージへの応答を生成するアプリ。
• ReadableStreamを介してJSON Linesを使用してバックエンドからの応答をストリーミングする基本的な HTML/JavaScript フロントエンド。

• Azure.AI.OpenAI NuGet パッケージを使用してユーザー メッセージに応答を生成する Blazor Web アプリ。

• OpenAI npm パッケージを使用してユーザー メッセージへの応答を生成する TypeScript Web アプリ。

サンプル リポジトリのコストの詳細についてはを参照してください。

サンプル リポジトリのコストの詳細についてはを参照してください。

サンプル リポジトリのコストの詳細についてはを参照してください。

サンプル コードの探索

OpenAI と Azure OpenAI Service は common Python クライアント ライブラリ に依存していますが、Azure OpenAI エンドポイントを使用する場合は、小さなコード変更が必要です。 このサンプルでは、Microsoft Entra IDを使用してキーレス認証を構成し、Azure OpenAI と通信する方法を見てみましょう。

マネージド ID を使用した認証の構成

このサンプルでは、 src/quartapp/chat.py ファイルはキーレス認証の構成から始まります。

次のスニペットでは、azure.identity.aio モジュールを使用して、非同期Microsoft Entra認証フローを作成します。

次のコード スニペットでは、 AZURE_CLIENT_IDazd 環境変数を使用して、ユーザー割り当てマネージド ID を使用して認証できる ManagedIdentityCredential インスタンスを作成します。

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

次のコード スニペットでは、AZURE_TENANT_IDazd リソース環境変数を使用して、現在のMicrosoft Entra テナントで認証できる AzureDeveloperCliCredential インスタンスを作成します。

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

Azure Identity クライアント ライブラリには、Azure Core ライブラリの TokenCredential プロトコルを実装する credentials パブリック クラスが用意されています。 資格情報は、Microsoft Entra IDからアクセス トークンを取得するための個別の認証フローを表します。 これらの資格情報を連結することにより、試行される一連の認証メカニズムを順序付けたシーケンスを形成できます。

次のスニペットでは、ChainedTokenCredentialとManagedIdentityCredentialを使用してAzureDeveloperCliCredentialを作成します。

• ManagedIdentityCredentialは、Azure Functions、Azure App Service、およびAzure Container Appsに使用されます。 ユーザー割り当てマネージド ID は、 client_id を ManagedIdentityCredentialに渡すことによってサポートされます。
• AzureDeveloperCliCredentialはローカル開発に使用されます。 以前は、使用するMicrosoft Entra テナントに基づいて設定されています。

azure_credential = ChainedTokenCredential(
    user_assigned_managed_identity_credential,
    azure_dev_cli_credential
)

次のコード スニペットは、選択したAzure資格情報に基づいて、Azure OpenAI トークン プロバイダーを取得します。 この値は、2 つの引数を使用して azure.identity.aio.get_bearer_token_provider を呼び出すことによって取得されます。

• azure_credential: 要求を認証するために先ほど作成した ChainedTokenCredential インスタンス。

• https://cognitiveservices.azure.com/.default: 1 つ以上のベアラー トークン スコープが必要です。 この場合、Azure Cognitive Services エンドポイント。

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

次の行は、必要なAZURE_OPENAI_ENDPOINTとAZURE_OPENAI_CHAT_DEPLOYMENT、azdプロビジョニング中に設定される 2 つのazd環境変数を確認します。 値が存在しない場合、エラーがスローされます。

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

このスニペットは、Azureの /openai/v1/ エンドポイントに対して OpenAI クライアントを初期化し、トークン プロバイダーを api_key として渡します。 v1 エンドポイントで api_version は必要ありません。

bp.openai_client = AsyncOpenAI(
    base_url=f"{openai_endpoint.rstrip('/')}/openai/v1/",
    api_key=token_provider,
)

次の行は、API 呼び出しで使用Azure OpenAI モデルのデプロイ名を設定します。

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

この関数が完了すると、クライアントは適切に構成され、Azure OpenAI サービスと対話する準備が整います。

OpenAI Responses API を使用して応答をストリーム配信する

response_streamは、ルート内の Responses API ストリーミング呼び出しを処理します。 フロントエンドは Responses 型の input 項目を直接送信し、バックエンドはそれらを responses.stream()に転送します。

async def response_stream():
    try:
        async with bp.openai_client.responses.stream(
            model=bp.openai_model,
            input=request_input,
            store=False,
        ) as openai_stream:
            async for event in openai_stream:
                yield json.dumps(event.model_dump(), ensure_ascii=False) + "\n"
    except Exception as e:
        current_app.logger.exception("Responses stream failed")
        yield json.dumps({"error": str(e)}, ensure_ascii=False) + "\n"

サンプル コードの検証

.NETアプリケーションは、Azure OpenAIサービスと通信するためにAzure.AI.OpenAIクライアントライブラリに依存しています。このクライアントライブラリはOpenAIライブラリに依存しています。 サンプル アプリでは、Microsoft Entra IDを使用してキーレス認証を構成し、Azure OpenAI と通信します。

認証とサービスの登録を構成する

このサンプルでは、キーレス認証は program.cs ファイルで構成されています。 次のコード スニペットでは、AZURE_CLIENT_IDによって設定されたazd環境変数を使用して、ユーザー割り当てマネージド ID を使用して認証できる ManagedIdentityCredential インスタンスを作成します。

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

次のコード スニペットでは、AZURE_TENANT_IDによって設定されたazd環境変数を使用して、にサインインしたアカウントを使用してローカルで認証できる azd インスタンスを作成します。

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

Azure Identity クライアント ライブラリには、Azure Core ライブラリの TokenCredential プロトコルを実装する資格情報クラスが用意されています。 資格情報は、Microsoft Entra IDからアクセス トークンを取得するための個別の認証フローを表します。 これらの資格情報は、 ChainedTokenCredential を使用して連結して、試行する一連の順序付けされた認証メカニズムを形成できます。

次のスニペットは、依存関係挿入のAzureOpenAIClientを登録し、ChainedTokenCredentialとManagedIdentityCredentialを使用してAzureDeveloperCliCredentialを作成します。

• ManagedIdentityCredentialは、Azure Functions、Azure App Service、およびAzure Container Appsに使用されます。 ユーザーが割り当てたマネージド ID は、AZURE_CLIENT_IDをManagedIdentityCredentialに提供することでサポートされます。
• AzureDeveloperCliCredentialはローカル開発に使用されます。 以前は、使用するMicrosoft Entra テナントに基づいて設定されています。

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

Azure OpenAI クライアントを使用してチャットの完了を取得する

Blazor Web アプリは、登録された AzureOpenAIClient を Home.Razor コンポーネントの上部に挿入します。

@inject AzureOpenAIClient azureOpenAIClient

ユーザーがフォームを提出すると、AzureOpenAIClient はプロンプトを OpenAI モデルに送信し、補完を生成します。

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));

サンプル コードの検証

OpenAI とAzure OpenAI Serviceは openai (共通の JavaScript クライアント ライブラリ) に依存していますが、Azure OpenAI エンドポイントを使用する場合は、小さなコード変更が必要です。 このサンプルでは、Microsoft Entra IDを使用してキーレス認証を構成し、Azure OpenAI と通信する方法を見てみましょう。

各環境のキーレス認証

Azure Identity クライアント ライブラリには、Azure Core ライブラリの TokenCredential プロトコルを実装する資格情報クラスが用意されています。 資格情報は、Microsoft Entra IDからアクセス トークンを取得するための個別の認証フローを表します。 これらの資格情報は ChainedTokenCredential を使用して連結して、試行される一連の認証メカニズムを順序付けして形成できます。 これにより、運用環境とローカル開発環境の両方に同じコードをデプロイできます。

マネージド ID を使用した認証の構成

このサンプルでは、./src/azure-authentication.ts は、Azure OpenAI に対してキーレス認証を提供するためのいくつかの機能を提供します。

最初の関数 getChainedCredential() は、チェーンで最初に見つかった有効なAzure資格情報を返します。

function getChainedCredential() {

    return new ChainedTokenCredential(
        new ManagedIdentityCredential(process.env.AZURE_CLIENT_ID!), 
        new AzureDeveloperCliCredential({
            tenantId: process.env.AZURE_TENANT_ID! ? process.env.AZURE_TENANT_ID! : undefined
          })
    );
}

• ManagedIdentityCredential が最初に試行されます。 運用環境のランタイムでAZURE_CLIENT_ID環境変数を使用して設定され、ユーザー割り当てマネージド ID を使用して認証できます。
• AzureDeveloperCliCredential が 2 番目に試行されます。 これは、開発者が azd auth login を使用して Azure Developer CLI でサインインするときに設定されます。

OpenAI のベアラー トークンを取得する

./src/azure-authentication.ts の 2 番目の関数は getTokenProvider() です。これは、Azure Cognitive Services エンドポイントをスコープとするベアラー トークンを提供するコールバックを返します。

function getTokenProvider(): () => Promise<string> {
    const credential  = getChainedCredential();
    const scope = "https://cognitiveservices.azure.com/.default";
    return getBearerTokenProvider(credential, scope);
}

上記のコード スニペットでは、 getBearerTokenProvider を使用して資格情報とスコープを取得し、ベアラー トークンを提供するコールバックを返します。

Azure OpenAI クライアントを認証する

./src/azure-authentication.ts の 3 番目の関数は getOpenAiClient() であり、Azure OpenAI クライアントを返します。

export function getOpenAiClient(): AzureOpenAI | undefined{
    try {

        if (!process.env.AZURE_OPENAI_ENDPOINT) {
            throw new Error("AZURE_OPENAI_ENDPOINT is required for Azure OpenAI");
        }
        if (!process.env.AZURE_OPENAI_CHAT_DEPLOYMENT) {
            throw new Error("AZURE_OPENAI_CHAT_DEPLOYMENT is required for Azure OpenAI");
        }

        const options = { 
            azureADTokenProvider: getTokenProvider(), 
            deployment: process.env.AZURE_OPENAI_CHAT_DEPLOYMENT!, 
            apiVersion: process.env.AZURE_OPENAI_API_VERSION! || "2024-02-15-preview",
            endpoint: process.env.AZURE_OPENAI_ENDPOINT!
        }

        // Create the Asynchronous Azure OpenAI client
        return new AzureOpenAI (options);

    } catch (error) {
        console.error('Error getting Azure OpenAI client: ', error);
    }
}

このコードは、正しくスコープ指定されたトークンを含むオプションを受け取り、 AzureOpenAI クライアントを作成します

Azure OpenAI を使用してチャットの回答をストリーム配信する

./src/openai-chat-api.ts で次の Fastify ルート ハンドラーを使用して、OpenAI Azureにメッセージを送信し、応答をストリーミングします。

import { FastifyReply, FastifyRequest } from 'fastify';
import { AzureOpenAI } from "openai";
import { getOpenAiClient } from './azure-authentication.js';
import { ChatCompletionChunk, ChatCompletionMessageParam } from 'openai/resources/chat/completions';

interface ChatRequestBody {
    messages: ChatCompletionMessageParam [];
  }

export async function chatRoute (request: FastifyRequest<{ Body: ChatRequestBody }>, reply: FastifyReply) {

    const requestMessages: ChatCompletionMessageParam[] = request?.body?.messages;
    const openaiClient: AzureOpenAI | undefined = getOpenAiClient();

    if (!openaiClient) {
      throw new Error("Azure OpenAI client is not configured");
    }

    const allMessages = [
      { role: "system", content: "You are a helpful assistant."},
      ...requestMessages
    ] as ChatCompletionMessageParam [];

    const chatCompletionChunks = await openaiClient.chat.completions.create({
      // Azure Open AI takes the deployment name as the model name
      model: process.env.AZURE_OPENAI_CHAT_DEPLOYMENT_MODEL || "gpt-4o-mini",
      messages: allMessages,
      stream: true

    })
    reply.raw.setHeader('Content-Type', 'text/html; charset=utf-8');
    reply.raw.setHeader('Cache-Control', 'no-cache');
    reply.raw.setHeader('Connection', 'keep-alive');
    reply.raw.flushHeaders();

    for await (const chunk of chatCompletionChunks as AsyncIterable<ChatCompletionChunk>) {
      for (const choice of chunk.choices) {
        reply.raw.write(JSON.stringify(choice) + "\n")
      }
    }

    reply.raw.end()

}

この関数は、以前のメッセージを含むチャット会話を取得し、Azure OpenAI に送信します。 ストリーム チャンクは OpenAI Azureから返されるため、クライアントに送信されます。

問題が解決しない場合は、リポジトリの Issues に問題を記録します。

次のステップ

問題が解決しない場合は、リポジトリの Issues に問題を記録します。

問題が解決しない場合は、リポジトリの Issues に問題を記録します。