Azure OpenAI Semantic Search Input Binding für Azure-Funktionen

Von Bedeutung

Die Azure OpenAI-Erweiterung für Azure Functions befindet sich derzeit in der Vorschau.

Mit der Eingabebindung für die semantische Azure OpenAI-Suche können Sie die semantische Suche für Ihre Einbettungen verwenden.

Informationen zu Einrichtungs- und Konfigurationsdetails der Azure OpenAI-Erweiterung finden Sie unter Azure OpenAI-Erweiterungen für Azure Functions. Weitere Informationen zur semantischen Rangfolge in der Azure KI-Suche finden Sie unter Semantische Rangfolge in der Azure KI-Suche.

Hinweis

Referenzen und Beispiele werden nur für das Node.js v4-Modell bereitgestellt.

Hinweis

Referenzen und Beispiele werden nur für das Python v2-Modell bereitgestellt.

Hinweis

Während beide C#-Prozessmodelle unterstützt werden, werden nur Isolierte Arbeitsmodellbeispiele bereitgestellt.

Beispiel

Go-Support ist derzeit nicht für diese Bindung verfügbar.

In diesem Beispiel wird gezeigt, wie Sie eine semantische Suche in einer Datei ausführen.

[Function("PromptFile")]
public static IActionResult PromptFile(
    [HttpTrigger(AuthorizationLevel.Function, "post")] SemanticSearchRequest unused,
    [SemanticSearchInput("AISearchEndpoint", "openai-index", Query = "{prompt}", ChatModel = "%CHAT_MODEL_DEPLOYMENT_NAME%", EmbeddingsModel = "%EMBEDDING_MODEL_DEPLOYMENT_NAME%", AIConnectionName = "AzureOpenAI")] SemanticSearchContext result)
{
    return new ContentResult { Content = result.Response, ContentType = "text/plain" };
}

In diesem Beispiel wird gezeigt, wie Sie eine semantische Suche in einer Datei ausführen.

@FunctionName("PromptFile")
public HttpResponseMessage promptFile(
    @HttpTrigger(
        name = "req", 
        methods = {HttpMethod.POST},
        authLevel = AuthorizationLevel.FUNCTION)
        HttpRequestMessage<SemanticSearchRequest> request,
    @SemanticSearch(name = "search", searchConnectionName = "AISearchEndpoint", collection = "openai-index", query = "{prompt}", chatModel = "%CHAT_MODEL_DEPLOYMENT_NAME%", embeddingsModel = "%EMBEDDING_MODEL_DEPLOYMENT_NAME%", isReasoningModel = false, aiConnectionName = "AzureOpenAI" ) String semanticSearchContext,
    final ExecutionContext context) {
        String response = new JSONObject(semanticSearchContext).getString("Response");
        return request.createResponseBuilder(HttpStatus.OK)
        .header("Content-Type", "application/json")
        .body(response)
        .build();        
}
public class SemanticSearchRequest {
    public String prompt;
    public String getPrompt() {
        return prompt;
    }
    public void setPrompt(String prompt) {
        this.prompt = prompt;
    }        
}

In diesem Beispiel wird gezeigt, wie Sie eine semantische Suche in einer Datei ausführen.

const semanticSearchInput = input.generic({
    type: "semanticSearch",
    searchConnectionName: "AISearchEndpoint",
    collection: "openai-index",
    query: "{prompt}",
    chatModel: "%CHAT_MODEL_DEPLOYMENT_NAME%",
    embeddingsModel: "%EMBEDDING_MODEL_DEPLOYMENT_NAME%",
    aiConnectionName: 'AzureOpenAI',
});

app.http('PromptFile', {
    methods: ['POST'],
    authLevel: 'function',
    extraInputs: [semanticSearchInput],
    handler: async (_request, context) => {
        var responseBody = context.extraInputs.get(semanticSearchInput)

        return { status: 200, body: responseBody.Response.trim() }
    }
});
const semanticSearchInput = input.generic({
    type: "semanticSearch",
    searchConnectionName: "AISearchEndpoint",
    collection: "openai-index",
    query: "{prompt}",
    chatModel: "%CHAT_MODEL_DEPLOYMENT_NAME%",
    aiConnectionName: 'AzureOpenAI',
    embeddingsModel: "%EMBEDDING_MODEL_DEPLOYMENT_NAME%"
});

app.http('PromptFile', {
    methods: ['POST'],
    authLevel: 'function',
    extraInputs: [semanticSearchInput],
    handler: async (_request, context) => {
        var responseBody: any = context.extraInputs.get(semanticSearchInput)

        return { status: 200, body: responseBody.Response.trim() }
    }
});

In diesem Beispiel wird gezeigt, wie Sie eine semantische Suche in einer Datei ausführen.

Dies ist die function.json Datei zum Anfordern einer Datei:

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "Request",
      "methods": [
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    },
    {
      "name": "SemanticSearchInput",
      "type": "semanticSearch",
      "direction": "in",
      "searchConnectionName": "AISearchEndpoint",
      "collection": "openai-index",
      "query": "{prompt}",
      "chatModel": "%CHAT_MODEL_DEPLOYMENT_NAME%",
      "embeddingsModel": "%EMBEDDING_MODEL_DEPLOYMENT_NAME%",
      "aiConnectionName": "AzureOpenAI"
    }
  ]
}

Weitere Informationen zu den Dateieigenschaften von function.json finden Sie im Abschnitt Konfiguration.

using namespace System.Net

param($Request, $TriggerMetadata, $SemanticSearchInput)

Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
        StatusCode = [HttpStatusCode]::OK
        Body       = $SemanticSearchInput.Response
    })

In diesem Beispiel wird gezeigt, wie Sie eine semantische Suche in einer Datei ausführen.

@app.function_name("PromptFile")
@app.route(methods=["POST"])
@app.semantic_search_input(
    arg_name="result",
    search_connection_name="AISearchEndpoint",
    collection="openai-index",
    query="{prompt}",
    embeddings_model="%EMBEDDING_MODEL_DEPLOYMENT_NAME%",
    ai_connection_name="AzureOpenAI",
    chat_model="%CHAT_MODEL_DEPLOYMENT_NAME%",
)
def prompt_file(req: func.HttpRequest, result: str) -> func.HttpResponse:
    result_json = json.loads(result)
    response_json = {
        "content": result_json.get("Response"),
        "content_type": "text/plain",
    }
    return func.HttpResponse(
        json.dumps(response_json), status_code=200, mimetype="application/json"
    )

Attribute

Wenden Sie das SemanticSearchInput Attribut an, um eine Eingabebindung für die semantische Suche zu definieren, die diese Parameter unterstützt:

Parameter BESCHREIBUNG
SearchConnectionName Den Namen einer App-Einstellung oder Umgebungsvariable, die den Wert der Verbindungszeichenfolge enthält. Diese Eigenschaft unterstützt Bindungsausdrücke.
Sammlung Den Name der zu durchsuchenden Sammlung oder Tabelle oder des Indexes. Diese Eigenschaft unterstützt Bindungsausdrücke.
Abfrage Der für die Suche zu verwendende semantische Abfragetext. Diese Eigenschaft unterstützt Bindungsausdrücke.
EmbeddingsModel Optional. Die ID des Modells, das für Einbettungen verwendet werden soll. Der Standardwert ist text-embedding-3-small. Diese Eigenschaft unterstützt Bindungsausdrücke.
ChatModel Optional. Ruft den Namen des großen Sprachmodells ab, das für Chatantworten aufgerufen werden soll, oder legt diesen fest. Der Standardwert ist gpt-3.5-turbo. Diese Eigenschaft unterstützt Bindungsausdrücke.
AIConnectionName Optional. Dient zum Abrufen oder Festlegen des Namens des Konfigurationsabschnitts für AI-Dienstkonnektivitätseinstellungen. Für Azure OpenAI: Wenn angegeben, suchen Sie in diesem Konfigurationsabschnitt nach "Endpunkt" und "Key". Wenn sie nicht angegeben ist oder der Abschnitt nicht vorhanden ist, kehren Sie auf Umgebungsvariablen zurück: AZURE_OPENAI_ENDPOINT und AZURE_OPENAI_KEY. Für die vom Benutzer zugewiesene verwaltete Identitätsauthentifizierung ist diese Eigenschaft erforderlich. Legen Sie für openAI-Dienst (nicht azure) die OPENAI_API_KEY Umgebungsvariable fest.
SystemPrompt Optional. Ruft die Systemaufforderung ab, die zum Anfordern des großen Sprachmodells verwendet werden soll, oder legt sie fest. Die Systemaufforderung wird mit Wissen angefügt, das als Ergebnis der QueryAbgerufen wird. Die kombinierte Eingabeaufforderung wird an die OpenAI-Chat-API gesendet. Diese Eigenschaft unterstützt Bindungsausdrücke.
MaxKnowledgeCount Optional. Ruft die Anzahl der Wissenselemente ab, die in das SystemPromptElement eingefügt werden sollen, oder legt diese fest.
IsReasoningModel Optional. Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Chatabschlussmodell ein Grundmodell ist. Diese Option ist experimentell und mit dem Begründungsmodell verknüpft, bis alle Modelle die Parität in den erwarteten Eigenschaften haben, mit einem Standardwert von false.

Anmerkungen

Mit der SemanticSearchInput Anmerkung können Sie eine semantische Sucheingabebindung definieren, die diese Parameter unterstützt:

Element BESCHREIBUNG
Name Ruft den Namen der Eingabebindung ab oder legt ihn fest.
searchConnectionName Den Namen einer App-Einstellung oder Umgebungsvariable, die den Wert der Verbindungszeichenfolge enthält. Diese Eigenschaft unterstützt Bindungsausdrücke.
Sammlung Den Name der zu durchsuchenden Sammlung oder Tabelle oder des Indexes. Diese Eigenschaft unterstützt Bindungsausdrücke.
Anfrage Der für die Suche zu verwendende semantische Abfragetext. Diese Eigenschaft unterstützt Bindungsausdrücke.
embeddingsModel Optional. Die ID des Modells, das für Einbettungen verwendet werden soll. Der Standardwert ist text-embedding-3-small. Diese Eigenschaft unterstützt Bindungsausdrücke.
chatModel Optional. Ruft den Namen des großen Sprachmodells ab, das für Chatantworten aufgerufen werden soll, oder legt diesen fest. Der Standardwert ist gpt-3.5-turbo. Diese Eigenschaft unterstützt Bindungsausdrücke.
aiConnectionName Optional. Dient zum Abrufen oder Festlegen des Namens des Konfigurationsabschnitts für AI-Dienstkonnektivitätseinstellungen. Für Azure OpenAI: Wenn angegeben, suchen Sie in diesem Konfigurationsabschnitt nach "Endpunkt" und "Key". Wenn sie nicht angegeben ist oder der Abschnitt nicht vorhanden ist, kehren Sie auf Umgebungsvariablen zurück: AZURE_OPENAI_ENDPOINT und AZURE_OPENAI_KEY. Für die vom Benutzer zugewiesene verwaltete Identitätsauthentifizierung ist diese Eigenschaft erforderlich. Legen Sie für openAI-Dienst (nicht azure) die OPENAI_API_KEY Umgebungsvariable fest.
systemPrompt Optional. Ruft die Systemaufforderung ab, die zum Anfordern des großen Sprachmodells verwendet werden soll, oder legt sie fest. Die Systemaufforderung wird mit Wissen angefügt, das als Ergebnis der QueryAbgerufen wird. Die kombinierte Eingabeaufforderung wird an die OpenAI-Chat-API gesendet. Diese Eigenschaft unterstützt Bindungsausdrücke.
maxKnowledgeCount Optional. Ruft die Anzahl der Wissenselemente ab, die in das SystemPromptElement eingefügt werden sollen, oder legt diese fest.
isReasoningModel Optional. Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Chatabschlussmodell ein Grundmodell ist. Diese Option ist experimentell und mit dem Begründungsmodell verknüpft, bis alle Modelle die Parität in den erwarteten Eigenschaften haben, mit einem Standardwert von false.

Decorator-Elemente

Definieren Sie während der Vorschau die Eingabebindung als generic_input_binding-Bindung vom Typ semanticSearch, die diese Parameter unterstützt:

Parameter BESCHREIBUNG
arg_name Der Name der Variablen, die den Bindungsparameter darstellt.
search_connection_name Den Namen einer App-Einstellung oder Umgebungsvariable, die den Wert der Verbindungszeichenfolge enthält. Diese Eigenschaft unterstützt Bindungsausdrücke.
Sammlung Den Name der zu durchsuchenden Sammlung oder Tabelle oder des Indexes. Diese Eigenschaft unterstützt Bindungsausdrücke.
Anfrage Der für die Suche zu verwendende semantische Abfragetext. Diese Eigenschaft unterstützt Bindungsausdrücke.
embeddings_model Optional. Die ID des Modells, das für Einbettungen verwendet werden soll. Der Standardwert ist text-embedding-3-small. Diese Eigenschaft unterstützt Bindungsausdrücke.
chat_model Optional. Ruft den Namen des großen Sprachmodells ab, das für Chatantworten aufgerufen werden soll, oder legt diesen fest. Der Standardwert ist gpt-3.5-turbo. Diese Eigenschaft unterstützt Bindungsausdrücke.
ai_connection_name Optional. Dient zum Abrufen oder Festlegen des Namens des Konfigurationsabschnitts für AI-Dienstkonnektivitätseinstellungen. Für Azure OpenAI: Wenn angegeben, suchen Sie in diesem Konfigurationsabschnitt nach "Endpunkt" und "Key". Wenn sie nicht angegeben ist oder der Abschnitt nicht vorhanden ist, kehren Sie auf Umgebungsvariablen zurück: AZURE_OPENAI_ENDPOINT und AZURE_OPENAI_KEY. Für die vom Benutzer zugewiesene verwaltete Identitätsauthentifizierung ist diese Eigenschaft erforderlich. Legen Sie für openAI-Dienst (nicht azure) die OPENAI_API_KEY Umgebungsvariable fest.
system_prompt Optional. Ruft die Systemaufforderung ab, die zum Anfordern des großen Sprachmodells verwendet werden soll, oder legt sie fest. Die Systemaufforderung wird mit Wissen angefügt, das als Ergebnis der QueryAbgerufen wird. Die kombinierte Eingabeaufforderung wird an die OpenAI-Chat-API gesendet. Diese Eigenschaft unterstützt Bindungsausdrücke.
max_knowledge_count Optional. Ruft die Anzahl der Wissenselemente ab, die in das SystemPromptElement eingefügt werden sollen, oder legt diese fest.
is_reasoning _model Optional. Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Chatabschlussmodell ein Grundmodell ist. Diese Option ist experimentell und mit dem Begründungsmodell verknüpft, bis alle Modelle die Parität in den erwarteten Eigenschaften haben, mit einem Standardwert von false.

Konfiguration

Die Bindung unterstützt diese Konfigurationseigenschaften, die Sie in der Datei „function.json“ festlegen.

Eigentum BESCHREIBUNG
Typ Muss semanticSearch sein.
Richtung Muss in sein.
Name Der Name der Eingabebindung.
searchConnectionName Dient zum Abrufen oder Festlegen des Namens einer App-Einstellung oder Umgebungsvariable, die einen Verbindungszeichenfolgenwert enthält. Diese Eigenschaft unterstützt Bindungsausdrücke.
Sammlung Den Name der zu durchsuchenden Sammlung oder Tabelle oder des Indexes. Diese Eigenschaft unterstützt Bindungsausdrücke.
Anfrage Der für die Suche zu verwendende semantische Abfragetext. Diese Eigenschaft unterstützt Bindungsausdrücke.
embeddingsModel Optional. Die ID des Modells, das für Einbettungen verwendet werden soll. Der Standardwert ist text-embedding-3-small. Diese Eigenschaft unterstützt Bindungsausdrücke.
chatModel Optional. Ruft den Namen des großen Sprachmodells ab, das für Chatantworten aufgerufen werden soll, oder legt diesen fest. Der Standardwert ist gpt-3.5-turbo. Diese Eigenschaft unterstützt Bindungsausdrücke.
aiConnectionName Optional. Dient zum Abrufen oder Festlegen des Namens des Konfigurationsabschnitts für AI-Dienstkonnektivitätseinstellungen. Für Azure OpenAI: Wenn angegeben, suchen Sie in diesem Konfigurationsabschnitt nach "Endpunkt" und "Key". Wenn sie nicht angegeben ist oder der Abschnitt nicht vorhanden ist, kehren Sie auf Umgebungsvariablen zurück: AZURE_OPENAI_ENDPOINT und AZURE_OPENAI_KEY. Für die vom Benutzer zugewiesene verwaltete Identitätsauthentifizierung ist diese Eigenschaft erforderlich. Legen Sie für openAI-Dienst (nicht azure) die OPENAI_API_KEY Umgebungsvariable fest.
systemPrompt Optional. Ruft die Systemaufforderung ab, die zum Anfordern des großen Sprachmodells verwendet werden soll, oder legt sie fest. Die Systemaufforderung wird mit Wissen angefügt, das als Ergebnis der QueryAbgerufen wird. Die kombinierte Eingabeaufforderung wird an die OpenAI-Chat-API gesendet. Diese Eigenschaft unterstützt Bindungsausdrücke.
maxKnowledgeCount Optional. Ruft die Anzahl der Wissenselemente ab, die in das SystemPromptElement eingefügt werden sollen, oder legt diese fest.
isReasoningModel Optional. Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Chatabschlussmodell ein Grundmodell ist. Diese Option ist experimentell und mit dem Begründungsmodell verknüpft, bis alle Modelle die Parität in den erwarteten Eigenschaften haben, mit einem Standardwert von false.

Konfiguration

Die Bindung unterstützt diese Eigenschaften, die in Ihrem Code definiert sind:

Eigentum BESCHREIBUNG
searchConnectionName Den Namen einer App-Einstellung oder Umgebungsvariable, die den Wert der Verbindungszeichenfolge enthält. Diese Eigenschaft unterstützt Bindungsausdrücke.
Sammlung Den Name der zu durchsuchenden Sammlung oder Tabelle oder des Indexes. Diese Eigenschaft unterstützt Bindungsausdrücke.
Anfrage Der für die Suche zu verwendende semantische Abfragetext. Diese Eigenschaft unterstützt Bindungsausdrücke.
embeddingsModel Optional. Die ID des Modells, das für Einbettungen verwendet werden soll. Der Standardwert ist text-embedding-3-small. Diese Eigenschaft unterstützt Bindungsausdrücke.
chatModel Optional. Ruft den Namen des großen Sprachmodells ab, das für Chatantworten aufgerufen werden soll, oder legt diesen fest. Der Standardwert ist gpt-3.5-turbo. Diese Eigenschaft unterstützt Bindungsausdrücke.
aiConnectionName Optional. Dient zum Abrufen oder Festlegen des Namens des Konfigurationsabschnitts für AI-Dienstkonnektivitätseinstellungen. Für Azure OpenAI: Wenn angegeben, suchen Sie in diesem Konfigurationsabschnitt nach "Endpunkt" und "Key". Wenn sie nicht angegeben ist oder der Abschnitt nicht vorhanden ist, kehren Sie auf Umgebungsvariablen zurück: AZURE_OPENAI_ENDPOINT und AZURE_OPENAI_KEY. Für die vom Benutzer zugewiesene verwaltete Identitätsauthentifizierung ist diese Eigenschaft erforderlich. Legen Sie für openAI-Dienst (nicht azure) die OPENAI_API_KEY Umgebungsvariable fest.
systemPrompt Optional. Ruft die Systemaufforderung ab, die zum Anfordern des großen Sprachmodells verwendet werden soll, oder legt sie fest. Die Systemaufforderung wird mit Wissen angefügt, das als Ergebnis der QueryAbgerufen wird. Die kombinierte Eingabeaufforderung wird an die OpenAI-Chat-API gesendet. Diese Eigenschaft unterstützt Bindungsausdrücke.
maxKnowledgeCount Optional. Ruft die Anzahl der Wissenselemente ab, die in das SystemPromptElement eingefügt werden sollen, oder legt diese fest.
isReasoningModel Optional. Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Chatabschlussmodell ein Grundmodell ist. Diese Option ist experimentell und mit dem Begründungsmodell verknüpft, bis alle Modelle die Parität in den erwarteten Eigenschaften haben, mit einem Standardwert von false.

Verwendung

Vollständige Beispiele finden Sie im Abschnitt „Beispiele“.

Verbindungen

Um die Azure OpenAI-Bindungserweiterung zu verwenden, muss man eine Verbindung zu einer OpenAI-Modelldefinition angeben. Stellen Sie die OpenAI-Modellverbindung in Ihren Bindings mit einem dieser Ansätze ein:

  • Verwenden Sie die AIConnectionName Binding-Eigenschaft (bevorzugt für Azure OpenAI).
  • Setze AZURE_OPENAI_ENDPOINT und AZURE_OPENAI_KEY in den App-Einstellungen (für Azure OpenAI).
  • Setze nur Open_API_Key in den App-Einstellungen (für https://api.openai.com).

Die Art und Weise, wie Sie die Verbindung einstellen, hängt sowohl von der Modell-API als auch von der Authentifizierungsmethode ab, wie in der folgenden Tabelle angegeben:

Authentifizierungs-/Modell-API Azure OpenAI OpenAI (https://api.openai.com)
Managed Identity-Verbindung AIConnectionName Nicht unterstützt
Key Vault-Referenz AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key
App-Konfigurationsreferenz AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key
Gemeinsames Geheimnis AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key

Nutzen Sie verwaltete Identitätsbasierte Verbindungen und die Immobilie AIConnectionName .

Wenn Sie verwenden AIConnectionName, hängt der Wert dieser Eigenschaftseinstellung vom Verbindungstyp ab:

  • Managed Identity-Verbindung: Die AIConnectionName Eigenschaft wird <CONNECTION_NAME_PREFIX> von einer Gruppe von Settings geteilt, die zusammen eine identitätsbasierte Verbindung zu Azure OpenAI definieren. Weitere Informationen finden Sie unter Identitätsverbindungen definieren.
  • Key Vault-Referenz: Die AIConnectionName Property-Einstellung liefert eine Azure Key Vault-Referenz auf den Standort, an dem der API-Schlüssel zentral verwaltet wird. Weitere Informationen finden Sie unter Define Key Vault connections.
  • App Configuration Reference: Die AIConnectionName Eigenschaftseinstellung liefert eine Azure App Configuration-Referenz, die einen API-Schlüssel oder eine Key Vault-Referenz zurückgibt. Weitere Informationen finden Sie unter Azure App Configuration im Artikel über Verbindungen.
  • API-Schlüssel: Die AIConnectionName Eigenschaftseinstellung wird direkt auf App-Einstellungen umgesetzt, die den Endpunkt und den Schlüssel enthalten. Da gemeinsame Schlüssel kompromittiert werden können, sollten Sie wenn möglich verwaltete Identitätsverbindungen verwenden. Weitere Informationen finden Sie unter Zusammenhänge definieren.

Um mehr über Bindungsverbindungen zu erfahren, siehe Verbindungen verwalten in Azure Functions.

Die OpenAI-Bindungen enthalten eine AIConnectionName Eigenschaft, mit der Sie die <ConnectionNamePrefix> für die Gruppe von App-Einstellungen festlegen können, die die Verbindung zu Azure OpenAI definieren:

Einstellungsname BESCHREIBUNG
<CONNECTION_NAME_PREFIX>__endpoint Setzt das URI-Endpunkt des Azure OpenAI-Dienstes. Diese Einstellung ist immer erforderlich.
<CONNECTION_NAME_PREFIX>__clientId Legt die bestimmte vom Benutzer zugewiesene Identität fest, die beim Abrufen eines Zugriffstokens verwendet werden soll. Erfordert, dass <CONNECTION_NAME_PREFIX>__credential auf managedidentity festgelegt wird. Die Eigenschaft akzeptiert eine Client-ID, die einer vom Benutzer zugewiesenen Identität entspricht, die der Anwendung zugeordnet ist. Es ist nicht möglich, sowohl eine Ressourcen-ID als auch eine Client-ID anzugeben. Wenn Sie diese Eigenschaft nicht spezifizieren, wird die systemzugewiesene Identität verwendet. Diese Eigenschaft wird in Szenarien für die lokale Entwicklung anders verwendet, in denen credential nicht festgelegt werden darf.
<CONNECTION_NAME_PREFIX>__credential Definiert, wie ein access-Token für die Verbindung abgerufen wird. Verwenden Sie managedidentity für die Authentifizierung der verwalteten Identität. Dieser Wert ist nur gültig, wenn eine verwaltete Identität in der Hostingumgebung verfügbar ist.
<CONNECTION_NAME_PREFIX>__managedIdentityResourceId Wenn credential auf gesetzt ist managedidentity, setzen Sie diese Eigenschaft so, dass sie die Ressourcen-Identifikator angibt, die beim Erlangen eines Tokens verwendet werden soll. Die Eigenschaft akzeptiert einen Ressourcenbezeichner, der der Ressourcen-ID der benutzerdefinierten verwalteten Identität entspricht. Es ist nicht möglich, sowohl eine Ressourcen-ID als auch eine Client-ID anzugeben. Wenn Sie keines von beiden angeben, wird die systemzugewiesene Identität verwendet. Diese Eigenschaft wird in Szenarien für die lokale Entwicklung anders verwendet, in denen credential nicht festgelegt werden darf.
<CONNECTION_NAME_PREFIX>__key Setzt den gemeinsamen geheimen Schlüssel, der für den Zugriff auf den Endpunkt des Azure OpenAI-Dienstes erforderlich ist, mittels schlüsselbasierter Authentifizierung. Als Sicherheitsbest-Practice sollten Sie immer Microsoft Entra ID mit verwalteten Identitäten zur Authentifizierung verwenden.

Betrachten Sie diese Managed Identity Connection-Einstellungen, wenn Sie die Eigenschaft AIConnectionName auf myAzureOpenAIsetzen:

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

Zur Laufzeit interpretiert der Host diese Einstellungen als eine einzige myAzureOpenAI Einstellung:

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

Wenn Sie verwaltete Identitäten verwenden, fügen Sie Ihre Identität unbedingt der Cognitive Services OpenAI User Rolle hinzu.

Beim lokalen Ausführen fügen Sie diese Einstellungen der local.settings.json Projektdatei hinzu. Weitere Informationen finden Sie unter "Lokale Entwicklung mit identitätsbasierten Verbindungen".

Weitere Informationen finden Sie unter Verwenden von Anwendungseinstellungen.