Azure Functions 用の Azure OpenAI 拡張機能

重要

Azure Functions 用の Azure OpenAI 拡張機能は現在、プレビュー段階です。

Azure Functions 用の Azure OpenAI 拡張機能には、 Foundry Models の Azure OpenAI の機能と動作を関数コードの実行に簡単に統合できる一連のトリガーとバインドが実装されています。

Azure Functions は、他の Azure サービスと簡単に接続するための一連のトリガーとバインドを提供するイベントドリブンのコンピューティング サービスです。

Azure OpenAI と Functions の統合により、以下を可能にする関数を構築できます。

アクション トリガー/バインドの種類
コンテンツの入力候補に標準のテキスト プロンプトを使用する Azure OpenAI テキスト入力候補の入力バインド
関数を呼び出すアシスタント要求に応答する Azure OpenAI アシスタント トリガー
アシスタントを作成する Azure OpenAI アシスタント作成の出力バインド
アシスタントにメッセージを送信する Azure OpenAI アシスタント ポストの入力バインド
アシスタントの履歴を取得する Azure OpenAI アシスタント クエリの入力バインド
テキスト埋め込みを読み取る Azure OpenAI 埋め込みの入力バインド
ベクトル データベースに書き込む Azure OpenAI 埋め込みストアの入力バインド
ベクトル データベースから読み取る Azure OpenAI セマンティック検索の入力バインド

拡張機能のインストール

インストールする拡張機能 NuGet パッケージは、関数アプリで使用している C# モード (インプロセスまたは分離ワーカー プロセス) によって異なります。

Microsoft.Azure.Functions.Worker.Extensions.OpenAI NuGet パッケージをインストールして、プロジェクトに Azure OpenAI 拡張機能を追加します。これは、.NET CLI を使用して行うことができます。

dotnet add package Microsoft.Azure.Functions.Worker.Extensions.OpenAI  --prerelease

ベクトル データベースを使用してコンテンツを保存する場合は、次の NuGet パッケージの少なくとも 1 つをインストールする必要もあります。

バンドルのインストール

プレビュー拡張子は、OpenAI拡張を含む4.xバンドルのプレビュー版を対象とした host.json ファイル内の以下のコードを追加または置き換えすることで追加できます。

{
  "version": "2.0",
  "extensionBundle": {
    "id": "Microsoft.Azure.Functions.ExtensionBundle.Preview",
    "version": "[4.*, 5.0.0)"
  }
}

Goは現在この機能に対応していません。

接続

Azure OpenAIのバインディング拡張を使うには、OpenAIモデル定義への接続を指定する必要があります。 以下のいずれかの方法を使って、バインディング内でOpenAIモデル接続を設定します。

  • AIConnectionName bindingプロパティ(OpenAI Azure推奨)を使いましょう。
  • OpenAI Azureのアプリ設定でAZURE_OPENAI_ENDPOINTAZURE_OPENAI_KEYを設定してください。
  • アプリの設定で Open_API_Key だけに設定してください( https://api.openai.com用)。

接続の設定方法は、モデルAPIと認証方法の両方に依存し、以下の表に示されています:

認証/モデルAPI Azure OpenAI OpenAI(https://api.openai.com)
マネージド・アイデンティティ接続 AIConnectionName サポートしていません
Key Vault 参照 AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key
アプリ設定リファレンス AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key
共有シークレット AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key

管理型アイデンティティベースの接続と AIConnectionName プロパティを活用してください。

AIConnectionNameを使う場合、このプロパティ設定の値は接続の種類によって異なります。

  • マネージド・アイデンティティ接続:AIConnectionNameプロパティ<CONNECTION_NAME_PREFIX>は、複数の設定群が共有するものであり、これらが共同でOpenAIへのアイデンティティベースの接続を定義しますAzure。 詳細については、「 同一性接続の定義」を参照してください。
  • Key Vault参照:AIConnectionNameプロパティ設定は、APIキーが中央管理されている場所へのAzure Key Vault参照を返します。 詳細については、「Key Vault connectionsの定義」をご覧ください。
  • App Configuration reference:AIConnectionNameプロパティ設定はAPIキーまたはKey Vault参照を返すAzure App Configuration参照を返します。 詳細については、接続記事のAzure App Configurationをご覧ください。
  • APIキー: AIConnectionName プロパティ設定はエンドポイントとキーを含むアプリ設定に解決されます。 共有鍵は漏洩する可能性があるため、可能な限り管理型ID接続を使用してください。 詳細については、「 接続の定義」を参照してください。

バインディング接続について詳しく知りたい方は、「Azure Functionsの接続管理」をご覧ください。

OpenAIのバインディングには、OpenAIとの接続を定義するアプリ設定群のAIConnectionNameを指定するための<ConnectionNamePrefix>プロパティAzure含まれています。

設定の名前 説明
<CONNECTION_NAME_PREFIX>__endpoint Azure OpenAIサービスのURIエンドポイントを設定します。 この設定は常に必須です。
<CONNECTION_NAME_PREFIX>__clientId アクセス トークンを取得するときに使用する特定のユーザー割り当て ID を設定します。 <CONNECTION_NAME_PREFIX>__credentialmanagedidentity に設定する必要があります。 このプロパティは、アプリケーションに割り当てられたユーザー割り当て ID に相当するクライアント ID を受け取ります。 リソース ID とクライアント ID の両方を指定することは無効です。 このプロパティを指定しない場合は、システムが割り当てたアイデンティティが使われます。 このプロパティは、 を設定しないとき、credentialで異なる方法で使用されます。
<CONNECTION_NAME_PREFIX>__credential 接続のアクセス トークンを取得する方法を定義します。 マネージド ID 認証には managedidentity を使用します。 この値は、ホスティング環境でマネージド ID が使用できる場合にのみ有効です。
<CONNECTION_NAME_PREFIX>__managedIdentityResourceId credentialmanagedidentityに設定されている場合、このプロパティでトークンを取得する際に使用するリソース識別子を指定します。 プロパティは、ユーザー定義マネージド ID のリソース ID に対応するリソース識別子を受け取ります。 リソース ID とクライアント ID の両方を指定することは無効です。 どちらかを指定しなければ、システムが割り当てたアイデンティティが使われます。 このプロパティは、 を設定しないとき、credentialで異なる方法で使用されます。
<CONNECTION_NAME_PREFIX>__key 鍵ベースの認証を用いて、Azure OpenAIサービスのエンドポイントにアクセスするために必要な共有秘密鍵を設定します。 セキュリティのベストプラクティスとして、認証には必ず管理されたIDと共にMicrosoft Entra IDを使用してください。

AIConnectionNameプロパティをmyAzureOpenAIに設定する際は、以下の管理されたID接続設定を考慮してください。

  • myAzureOpenAI__endpoint=https://contoso.openai.azure.com/
  • myAzureOpenAI__credential=managedidentity
  • myAzureOpenAI__clientId=aaaaaaaa-bbbb-cccc-1111-222222222222

実行時には、ホストはこれらの設定を単一の myAzureOpenAI 設定として解釈します。

"myAzureOpenAI":
{
    "endpoint": "https://contoso.openai.azure.com/",
    "credential": "managedidentity",
    "clientId": "aaaaaaaa-bbbb-cccc-1111-222222222222"
}

マネージドIDを使う場合は、必ず Cognitive Services OpenAIユーザー ロールに自分のIDを追加してください。

ローカルで動作する場合は、これらの設定を local.settings.json プロジェクトファイルに追加してください。 詳細については、「 ID ベースの接続を使用したローカル開発」を参照してください。

詳細については、アプリケーション設定の操作に関する記事を参照してください。