Azure Functions 用の Azure OpenAI 埋め込み入力バインド

Warning

Azure Functions用のAzure OpenAI拡張は2027年4月20日に廃止されます。 プレビュー拡張バンドルバージョン4.60.0以降には拡張が含まれていません。

状況に応じて、OpenAI、Microsoft Foundry、またはAzure AI 検索のSDKに直接移行してください。 既存のアプリは、host.jsonでバージョン範囲を[4.*, 4.60.0)に設定することで、4.60.0以前のプレビュー拡張機能バンドルバージョンを利用できます。 .NETアプリは対応するAzure OpenAI拡張機能のNuGetパッケージを直接使用し続けられます。 古いバンドルをピン留めすることも、NuGetパッケージの使用を継続しても、2027年4月20日以降のサポートは延長されません。

Azure OpenAI 埋め込み入力バインドを使用すると、入力の埋め込みを生成できます。 このバインドを使用して、ファイルまたは生のテキスト入力から埋め込みを生成できます。

Azure OpenAI 拡張機能のセットアップと構成の詳細については、Azure Functions 用の Azure OpenAI 拡張機能に関する記事を参照してください。 Azure OpenAI Service での埋め込みの詳細については、「Azure OpenAI Service での埋め込みについて理解する」を参照してください。

注

リファレンスと例は、Node.js v4 モデルに対してのみ提供されています。

注

リファレンスと例は、Python v2 モデルに対してのみ提供されます。

注

両方の C# プロセス モデルがサポートされていますが、 isolated worker モデル 例のみが提供されます。

例

このバインドに関しては現在、Goのサポートは利用できません。

この例では、生のテキスト文字列の埋め込みを生成する方法を示します。

internal class EmbeddingsRequest
{
    [JsonPropertyName("rawText")]
    public string? RawText { get; set; }

    [JsonPropertyName("fileName")]
    public string? FileName { get; set; }

    [JsonPropertyName("url")]
    public string? Url { get; set; }
}

/// <summary>
/// Example showing how to use the <see cref="EmbeddingsAttribute"/> input binding to generate embeddings 
/// for a raw text string.
/// </summary>
[Function(nameof(GenerateEmbeddings_Http_RequestAsync))]
public async Task GenerateEmbeddings_Http_RequestAsync(
    [HttpTrigger(AuthorizationLevel.Function, "post", Route = "embeddings")] HttpRequestData req,
    [EmbeddingsInput("{rawText}", InputType.RawText, EmbeddingsModel = "%EMBEDDING_MODEL_DEPLOYMENT_NAME%", AIConnectionName = "AzureOpenAI")] EmbeddingsContext embeddings)
{
    using StreamReader reader = new(req.Body);
    string request = await reader.ReadToEndAsync();

    EmbeddingsRequest? requestBody = JsonSerializer.Deserialize<EmbeddingsRequest>(request);

    this.logger.LogInformation(
        "Received {count} embedding(s) for input text containing {length} characters.",
        embeddings.Count,
        requestBody?.RawText?.Length);

    // TODO: Store the embeddings into a database or other storage.
}

この例は、関数でアクセス可能なファイルの埋め込みを生成する方法を示しています。

OPENAI_EMBEDDINGS_FILE_PATH_ROOTを設定し、そのフォルダに対してパスを渡します。

[Function(nameof(GetEmbeddings_Http_FilePath))]
public async Task GetEmbeddings_Http_FilePath(
    [HttpTrigger(AuthorizationLevel.Function, "post", Route = "embeddings-from-file")] HttpRequestData req,
    [EmbeddingsInput("{fileName}", InputType.FilePath, MaxChunkLength = 512, EmbeddingsModel = "%EMBEDDING_MODEL_DEPLOYMENT_NAME%", AIConnectionName = "AzureOpenAI")] EmbeddingsContext embeddings)
{
    using StreamReader reader = new(req.Body);
    string request = await reader.ReadToEndAsync();

    EmbeddingsRequest? requestBody = JsonSerializer.Deserialize<EmbeddingsRequest>(request);
    this.logger.LogInformation(
        "Received {count} embedding(s) for input file '{path}'.",
        embeddings.Count,
        requestBody?.FileName);

    // TODO: Store the embeddings into a database or other storage.
}

この例では、生のテキスト文字列の埋め込みを生成する方法を示します。

@FunctionName("GenerateEmbeddingsHttpRequest")
public HttpResponseMessage generateEmbeddingsHttpRequest(
        @HttpTrigger(
            name = "req", 
            methods = {HttpMethod.POST},
            authLevel = AuthorizationLevel.FUNCTION,
            route = "embeddings")
        HttpRequestMessage<EmbeddingsRequest> request,
        @EmbeddingsInput(name = "Embeddings", input = "{RawText}", inputType = InputType.RawText, embeddingsModel = "%EMBEDDING_MODEL_DEPLOYMENT_NAME%", aiConnectionName = "AzureOpenAI") String embeddingsContext,
        final ExecutionContext context) {

    if (request.getBody() == null) 
    {
        throw new IllegalArgumentException(
                "Invalid request body. Make sure that you pass in {\"rawText\": value } as the request body.");
    }

    JSONObject embeddingsContextJsonObject = new JSONObject(embeddingsContext);

    context.getLogger().info(String.format("Received %d embedding(s) for input text containing %s characters.",
            embeddingsContextJsonObject.get("count"),
            request.getBody().getRawText().length()));

    // TODO: Store the embeddings into a database or other storage.
    return request.createResponseBuilder(HttpStatus.ACCEPTED)
            .header("Content-Type", "application/json")
            .build();
}

この例は、関数でアクセス可能なファイルの埋め込みを生成する方法を示しています。

OPENAI_EMBEDDINGS_FILE_PATH_ROOTを設定し、そのフォルダに対してパスを渡します。

@FunctionName("GenerateEmbeddingsHttpFilePath")
public HttpResponseMessage generateEmbeddingsHttpFilePath(
    @HttpTrigger(
        name = "req", 
        methods = {HttpMethod.POST},
        authLevel = AuthorizationLevel.FUNCTION,
        route = "embeddings-from-file")
    HttpRequestMessage<EmbeddingsRequest> request,
    @EmbeddingsInput(name = "Embeddings", input = "{FileName}", inputType = InputType.FilePath, maxChunkLength = 512, embeddingsModel = "%EMBEDDING_MODEL_DEPLOYMENT_NAME%", aiConnectionName = "AzureOpenAI") String embeddingsContext,
    final ExecutionContext context) {

    if (request.getBody() == null) 
    {
        throw new IllegalArgumentException(
                "Invalid request body. Make sure that you pass in {\"fileName\": value } as the request body.");
    }

    JSONObject embeddingsContextJsonObject = new JSONObject(embeddingsContext);

    context.getLogger().info(String.format("Received %d embedding(s) for input file %s.",
            embeddingsContextJsonObject.get("count"),
            request.getBody().getFileName()));

    // TODO: Store the embeddings into a database or other storage.
    return request.createResponseBuilder(HttpStatus.ACCEPTED)
            .header("Content-Type", "application/json")
            .build();
}

この例では、生のテキスト文字列の埋め込みを生成する方法を示します。

const embeddingsHttpInput = input.generic({
    input: '{rawText}',
    inputType: 'RawText',
    type: 'embeddings',
    embeddingsModel: '%EMBEDDING_MODEL_DEPLOYMENT_NAME%',
    aiConnectionName: 'AzureOpenAI',
})

app.http('generateEmbeddings', {
    methods: ['POST'],
    route: 'embeddings',
    authLevel: 'function',
    extraInputs: [embeddingsHttpInput],
    handler: async (request, context) => {
        let requestBody = await request.json();
        let response = context.extraInputs.get(embeddingsHttpInput);

        context.log(
            `Received ${response.count} embedding(s) for input text containing ${requestBody.rawText?.length ?? 0} characters.`
        );
        
        // TODO: Store the embeddings into a database or other storage.

        return {status: 202}
    }
});
interface EmbeddingsHttpRequest {
    rawText?: string;
}

const embeddingsHttpInput = input.generic({
    input: '{rawText}',
    inputType: 'RawText',
    type: 'embeddings',
    embeddingsModel: '%EMBEDDING_MODEL_DEPLOYMENT_NAME%',
    aiConnectionName: 'AzureOpenAI',
})

app.http('generateEmbeddings', {
    methods: ['POST'],
    route: 'embeddings',
    authLevel: 'function',
    extraInputs: [embeddingsHttpInput],
    handler: async (request, context) => {
        let requestBody: EmbeddingsHttpRequest = await request.json();
        let response: any = context.extraInputs.get(embeddingsHttpInput);

        context.log(
            `Received ${response.count} embedding(s) for input text containing ${requestBody.rawText?.length ?? 0} characters.`
        );
        
        // TODO: Store the embeddings into a database or other storage.

        return {status: 202}
    }
});

この例は、関数でアクセス可能なファイルの埋め込みを生成する方法を示しています。

OPENAI_EMBEDDINGS_FILE_PATH_ROOTを設定し、そのフォルダに対してパスを渡します。


const embeddingsFilePathInput = input.generic({
    input: '{fileName}',
    inputType: 'FilePath',
    type: 'embeddings',
    maxChunkLength: 512,
    embeddingsModel: '%EMBEDDING_MODEL_DEPLOYMENT_NAME%',
    aiConnectionName: 'AzureOpenAI',
})

app.http('getEmbeddingsFilePath', {
    methods: ['POST'],
    route: 'embeddings-from-file',
    authLevel: 'function',
    extraInputs: [embeddingsFilePathInput],
    handler: async (request, context) => {
        let requestBody = await request.json();
        let response = context.extraInputs.get(embeddingsFilePathInput);

        context.log(
            `Received ${response.count} embedding(s) for input file ${requestBody.fileName}.`
        );
        
        // TODO: Store the embeddings into a database or other storage.

        return {status: 202}
    }
});

interface EmbeddingsFilePath {
    fileName?: string;
}

const embeddingsFilePathInput = input.generic({
    input: '{fileName}',
    inputType: 'FilePath',
    type: 'embeddings',
    maxChunkLength: 512,
    embeddingsModel: '%EMBEDDING_MODEL_DEPLOYMENT_NAME%',
    aiConnectionName: 'AzureOpenAI',
})

app.http('getEmbeddingsFilePath', {
    methods: ['POST'],
    route: 'embeddings-from-file',
    authLevel: 'function',
    extraInputs: [embeddingsFilePathInput],
    handler: async (request, context) => {
        let requestBody: EmbeddingsFilePath = await request.json();
        let response: any = context.extraInputs.get(embeddingsFilePathInput);

        context.log(
            `Received ${response.count} embedding(s) for input file ${requestBody.fileName}.`
        );
        
        // TODO: Store the embeddings into a database or other storage.

        return {status: 202}
    }
});

この例では、生のテキスト文字列の埋め込みを生成する方法を示します。

埋め込みを生成するための function.json ファイルを次に示します。

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "Request",
      "route": "embeddings",
      "methods": [
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    },
    {
      "name": "Embeddings",
      "type": "embeddings",
      "direction": "in",
      "inputType": "RawText",
      "input": "{rawText}",
      "embeddingsModel": "%EMBEDDING_MODEL_DEPLOYMENT_NAME%",
      "aiConnectionName": "AzureOpenAI"
    }
  ]
}

function.json ファイルのプロパティについて詳しくは、「構成」セクションをご覧ください。

using namespace System.Net

param($Request, $TriggerMetadata, $Embeddings)

$input = $Request.Body.RawText

Write-Host "Received $($Embeddings.Count) embedding(s) for input text containing $($input.Length) characters."

Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
        StatusCode = [HttpStatusCode]::Accepted
})

この例では、生のテキスト文字列の埋め込みを生成する方法を示します。

@app.function_name("GenerateEmbeddingsHttpRequest")
@app.route(route="embeddings", methods=["POST"])
@app.embeddings_input(
    arg_name="embeddings",
    input="{rawText}",
    input_type="rawText",
    embeddings_model="%EMBEDDING_MODEL_DEPLOYMENT_NAME%",
    ai_connection_name="AzureOpenAI",
)
def generate_embeddings_http_request(
    req: func.HttpRequest, embeddings: str
) -> func.HttpResponse:
    user_message = req.get_json()
    embeddings_json = json.loads(embeddings)
    embeddings_request = {"raw_text": user_message.get("rawText")}
    logging.info(
        f'Received {embeddings_json.get("count")} embedding(s) for input text '
        f'containing {len(embeddings_request.get("raw_text"))} characters.'
    )
    # TODO: Store the embeddings into a database or other storage.
    return func.HttpResponse(status_code=200)

属性

EmbeddingsInput 属性を適用して、これらのパラメーターをサポートする埋め込み入力バインドを定義します。

パラメーター 説明
入力 埋め込みを生成する入力文字列。
AIConnectionName 省略可。 AI サービス接続設定の構成セクションの名前を取得または設定します。 Azure OpenAI の場合: 指定した場合は、この構成セクションで "Endpoint" と "Key" の値を探します。 指定されていない場合、またはセクションが存在しない場合は、環境変数 (AZURE_OPENAI_ENDPOINTとAZURE_OPENAI_KEY) にフォールバックします。 ユーザー割り当てマネージド ID 認証の場合、このプロパティは必須です。 OpenAI サービス (Azure 以外) の場合は、OPENAI_API_KEY環境変数を設定します。
EmbeddingsModel 省略可。 使用するモデルの ID。既定値は text-embedding-ada-002 です。 既存のデータベースのモデルは変更しないでください。 詳細については、「使用」を参照してください。
MaxChunkLength 省略可。 入力のチャンキングに使用される文字の最大数。 詳細については、「使用」を参照してください。
MaxOverlap 省略可。 チャンク間で重複する文字の最大数を取得または設定します。
InputType 省略可。 入力の種類: RawText、 FilePath、または Url。 FilePathおよびUrlについては、「ファイルおよびURL入力の制限」を参照してください。

注釈

EmbeddingsInput 注釈を使用すると、これらのパラメーターをサポートする埋め込み入力バインドを定義できます。

要素 説明
名前 入力バインドの名前を取得または設定します。
インプット 埋め込みを生成する入力文字列。
aiConnectionName 省略可。 AI サービス接続設定の構成セクションの名前を取得または設定します。 Azure OpenAI の場合: 指定した場合は、この構成セクションで "Endpoint" と "Key" の値を探します。 指定されていない場合、またはセクションが存在しない場合は、環境変数 (AZURE_OPENAI_ENDPOINTとAZURE_OPENAI_KEY) にフォールバックします。 ユーザー割り当てマネージド ID 認証の場合、このプロパティは必須です。 OpenAI サービス (Azure 以外) の場合は、OPENAI_API_KEY環境変数を設定します。
embeddingsModel 省略可。 使用するモデルの ID。既定値は text-embedding-ada-002 です。 既存のデータベースのモデルは変更しないでください。 詳細については、「使用」を参照してください。
maxChunkLength 省略可。 入力のチャンキングに使用される文字の最大数。 詳細については、「使用」を参照してください。
maxOverlap 省略可。 チャンク間で重複する文字の最大数を取得または設定します。
inputType 省略可。 入力の種類: RawText、 FilePath、または Url。 FilePathおよびUrlについては、「ファイルおよびURL入力の制限」を参照してください。

デコレーター

プレビュー中に、入力バインドを generic_input_binding 型の embeddings バインド (これらのパラメーターをサポートします) として定義します。embeddings デコレーターではこれらのパラメーターをサポートします。

パラメーター 説明
arg_name バインド パラメーターを表す変数の名前。
インプット 埋め込みを生成する入力文字列。
ai_connection_name 省略可。 AI サービス接続設定の構成セクションの名前を取得または設定します。 Azure OpenAI の場合: 指定した場合は、この構成セクションで "Endpoint" と "Key" の値を探します。 指定されていない場合、またはセクションが存在しない場合は、環境変数 (AZURE_OPENAI_ENDPOINTとAZURE_OPENAI_KEY) にフォールバックします。 ユーザー割り当てマネージド ID 認証の場合、このプロパティは必須です。 OpenAI サービス (Azure 以外) の場合は、OPENAI_API_KEY環境変数を設定します。
embeddings_model 省略可。 使用するモデルの ID。既定値は text-embedding-ada-002 です。 既存のデータベースのモデルは変更しないでください。 詳細については、「使用」を参照してください。
maxChunkLength 省略可。 入力のチャンキングに使用される文字の最大数。 詳細については、「使用」を参照してください。
max_overlap 省略可。 チャンク間で重複する文字の最大数を取得または設定します。
input_type 入力の種類: RawText、 FilePath、または Url。 FilePathおよびUrlについては、「ファイルおよびURL入力の制限」を参照してください。

構成

このバインドでは、function.json ファイルで設定したこれらの構成プロパティをサポートします。

プロパティ 説明
タイプ EmbeddingsInputである必要があります。
方向 inである必要があります。
名前 入力バインドの名前。
インプット 埋め込みを生成する入力文字列。
aiConnectionName 省略可。 AI サービス接続設定の構成セクションの名前を取得または設定します。 Azure OpenAI の場合: 指定した場合は、この構成セクションで "Endpoint" と "Key" の値を探します。 指定されていない場合、またはセクションが存在しない場合は、環境変数 (AZURE_OPENAI_ENDPOINTとAZURE_OPENAI_KEY) にフォールバックします。 ユーザー割り当てマネージド ID 認証の場合、このプロパティは必須です。 OpenAI サービス (Azure 以外) の場合は、OPENAI_API_KEY環境変数を設定します。
embeddingsModel 省略可。 使用するモデルの ID。既定値は text-embedding-ada-002 です。 既存のデータベースのモデルは変更しないでください。 詳細については、「使用」を参照してください。
maxChunkLength 省略可。 入力のチャンキングに使用される文字の最大数。 詳細については、「使用」を参照してください。
maxOverlap 省略可。 チャンク間で重複する文字の最大数を取得または設定します。
inputType 省略可。 入力の種類: RawText、 FilePath、または Url。 FilePathおよびUrlについては、「ファイルおよびURL入力の制限」を参照してください。

構成

このバインドでは、コードで定義されている、これらのプロパティをサポートします。

プロパティ 説明
インプット 埋め込みを生成する入力文字列。
aiConnectionName 省略可。 AI サービス接続設定の構成セクションの名前を取得または設定します。 Azure OpenAI の場合: 指定した場合は、この構成セクションで "Endpoint" と "Key" の値を探します。 指定されていない場合、またはセクションが存在しない場合は、環境変数 (AZURE_OPENAI_ENDPOINTとAZURE_OPENAI_KEY) にフォールバックします。 ユーザー割り当てマネージド ID 認証の場合、このプロパティは必須です。 OpenAI サービス (Azure 以外) の場合は、OPENAI_API_KEY環境変数を設定します。
embeddingsModel 省略可。 使用するモデルの ID。既定値は text-embedding-ada-002 です。 既存のデータベースのモデルは変更しないでください。 詳細については、「使用」を参照してください。
maxChunkLength 省略可。 入力のチャンキングに使用される文字の最大数。 詳細については、「使用」を参照してください。
maxOverlap 省略可。 チャンク間で重複する文字の最大数を取得または設定します。
inputType 省略可。 入力の種類: RawText、 FilePath、または Url。 FilePathおよびUrlについては、「ファイルおよびURL入力の制限」を参照してください。

完全な例については、セクションの例を参照してください。

使用方法

既定の埋め込み model を変更すると、埋め込みがベクター データベースに保存される方法が変わります。 既定のモデルを変更した場合、以前にベクター データベースに取り込まれた残りのデータと一致していない場合、検索が誤動作し始めるおそれがあります。 埋め込みの既定のモデルは text-embedding-ada-002 です。

入力チャンクの最大文字長を計算する際は、text-embedding-ada-002 などの第 2 世代入力埋め込みモデルで許可される入力トークンの最大数は 8191 であることを考慮してください。 1 つのトークンの長さは約 4 文字 (英語の場合) であり、これは、1 つのチャンクに収まる入力の約 32,000 文字 (英語の場合) に変換されます。

ファイルとURL入力を制限する

これらのアプリケーション設定を使って、バインディングが読み取れるソースを制限してください。 これらの設定は RawText 入力には影響しません。

アプリケーション設定 入力タイプ 説明
OPENAI_EMBEDDINGS_FILE_PATH_ROOT FilePath ファイル入力を設定済みのディレクトリに制限します。 そのディレクトリに対してパスを渡します。 絶対パス、ディレクトリ外のパス、シンボリックリンクやリパースポイントは拒否されます。
OPENAI_EMBEDDINGS_URL_ALLOWED_ORIGINS Url URL入力を https://contoso.com,https://docs.contoso.comのような、カンマ区切られたHTTPSの発信リストに制限します。 各オリジンにはスキーム、ホスト、オプションポートが含まれますが、パス、クエリ、フラグメントは含まれません。 リダイレクトは拒否されます。

Important

inputTypeがFilePathまたはUrlで、リクエストデータやトリガーデータからの入力がある場合は、関数アプリのアプリケーション設定でそれぞれOPENAI_EMBEDDINGS_FILE_PATH_ROOTまたはOPENAI_EMBEDDINGS_URL_ALLOWED_ORIGINSを設定してください。 それ以外のバインディングはアプリが読み取れるファイルを読み取ったり、HTTPS URLを取得したりします。

接続

この接続ガイダンスは、2027年4月20日に廃止されるAzure OpenAI拡張機能を使用している既存アプリに適用されます。 ダイレクトSDKコールに移行する際は、拡張機能のバインディング設定を使うのではなく、選択したSDKの認証および接続ガイダンスに従ってください。

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

  • AIConnectionName bindingプロパティ(OpenAI Azure推奨)を使いましょう。
  • OpenAI Azureのアプリ設定でAZURE_OPENAI_ENDPOINTとAZURE_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>__credential を managedidentity に設定する必要があります。 このプロパティは、アプリケーションに割り当てられたユーザー割り当て ID に相当するクライアント ID を受け取ります。 リソース ID とクライアント ID の両方を指定することは無効です。 このプロパティを指定しない場合は、システムが割り当てたアイデンティティが使われます。 このプロパティは、 を設定しないとき、credentialで異なる方法で使用されます。
<CONNECTION_NAME_PREFIX>__credential 接続のaccess トークンを取得する方法を定義します。 マネージド ID 認証には managedidentity を使用します。 この値は、ホスティング環境でマネージド ID が使用できる場合にのみ有効です。
<CONNECTION_NAME_PREFIX>__managedIdentityResourceId credentialがmanagedidentityに設定されている場合、このプロパティでトークンを取得する際に使用するリソース識別子を指定します。 プロパティは、ユーザー定義マネージド 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": "00001111-aaaa-2222-bbbb-3333cccc4444"
}

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

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

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