Queryinvoerbinding voor Azure OpenAI-assistent voor Azure Functions

Belangrijk

De Azure OpenAI-extensie voor Azure Functions is momenteel in preview.

Met de queryinvoerbinding van de Azure OpenAI-assistent kunt u API-query's voor assistenten integreren in uw code-uitvoeringen.

Zie Azure OpenAI-extensies voor Azure Functions voor informatie over de installatie en configuratie van de Azure OpenAI-extensie. Zie de Api voor Azure OpenAI-assistenten voor meer informatie over Azure OpenAI-assistenten.

Notitie

Verwijzingen en voorbeelden worden alleen verstrekt voor het Node.js v4-model.

Notitie

Verwijzingen en voorbeelden worden alleen verstrekt voor het Python v2-model.

Notitie

Hoewel beide C#-procesmodellen worden ondersteund, worden alleen geïsoleerde werkrolmodelvoorbeelden gegeven.

Opmerking

Go-ondersteuning is momenteel niet beschikbaar voor deze binding.

In dit voorbeeld ziet u het aanmaakproces, waarbij de HTTP GET-functie die de gespreksgeschiedenis van de chatbot van de assistent opvraagt. Het antwoord op de prompt wordt geretourneerd in het HTTP-antwoord.

/// <summary>
/// HTTP GET function that queries the conversation history of the assistant chat bot.
/// </summary>
[Function(nameof(GetChatState))]
public static IActionResult GetChatState(
   [HttpTrigger(AuthorizationLevel.Function, "get", Route = "assistants/{assistantId}")] HttpRequestData req,
   string assistantId,
   [AssistantQueryInput("{assistantId}", TimestampUtc = "{Query.timestampUTC}", ChatStorageConnectionSetting = DefaultChatStorageConnectionSetting, CollectionName = DefaultCollectionName)] AssistantState state)
{
    return new OkObjectResult(state);
}

In dit voorbeeld ziet u het aanmaakproces, waarbij de HTTP GET-functie die de gespreksgeschiedenis van de chatbot van de assistent opvraagt. Het antwoord op de prompt wordt geretourneerd in het HTTP-antwoord.

/*
 * HTTP GET function that queries the conversation history of the assistant chat bot.
 */   
@FunctionName("GetChatState")
public HttpResponseMessage getChatState(
    @HttpTrigger(
        name = "req",
        methods = {HttpMethod.GET}, 
        authLevel = AuthorizationLevel.FUNCTION,
        route = "assistants/{assistantId}") 
        HttpRequestMessage<Optional<String>> request,
    @BindingName("assistantId") String assistantId,        
    @AssistantQuery(name = "AssistantState", id = "{assistantId}", timestampUtc = "{Query.timestampUTC}", chatStorageConnectionSetting = DEFAULT_CHATSTORAGE, collectionName = DEFAULT_COLLECTION) AssistantState state,
    final ExecutionContext context) {
        return request.createResponseBuilder(HttpStatus.OK)
            .header("Content-Type", "application/json")
            .body(state)
            .build();
}

In dit voorbeeld ziet u het aanmaakproces, waarbij de HTTP GET-functie die de gespreksgeschiedenis van de chatbot van de assistent opvraagt. Het antwoord op de prompt wordt geretourneerd in het HTTP-antwoord.

const { app, input, output } = require("@azure/functions");

const chatBotQueryInput = input.generic({
    type: 'assistantQuery',
    id: '{assistantId}',
    timestampUtc: '{Query.timestampUTC}',
    chatStorageConnectionSetting: CHAT_STORAGE_CONNECTION_SETTING,
    collectionName: COLLECTION_NAME
})
app.http('GetChatState', {
    methods: ['GET'],
    route: 'assistants/{assistantId}',
    authLevel: 'function',
    extraInputs: [chatBotQueryInput],
    handler: async (_, context) => {
        const state = context.extraInputs.get(chatBotQueryInput)
        return { status: 200, jsonBody: state }
    }
})

In dit voorbeeld ziet u het aanmaakproces, waarbij de HTTP GET-functie die de gespreksgeschiedenis van de chatbot van de assistent opvraagt. Het antwoord op de prompt wordt geretourneerd in het HTTP-antwoord.

import { HttpRequest, InvocationContext, app, input, output } from "@azure/functions"

const chatBotQueryInput = input.generic({
    type: 'assistantQuery',
    id: '{assistantId}',
    timestampUtc: '{Query.timestampUTC}',
    chatStorageConnectionSetting: CHAT_STORAGE_CONNECTION_SETTING,
    collectionName: COLLECTION_NAME
})
app.http('GetChatState', {
    methods: ['GET'],
    route: 'assistants/{assistantId}',
    authLevel: 'function',
    extraInputs: [chatBotQueryInput],
    handler: async (_, context) => {
        const state: any = context.extraInputs.get(chatBotQueryInput)
        return { status: 200, jsonBody: state }
    }
})

In dit voorbeeld ziet u het aanmaakproces, waarbij de HTTP GET-functie die de gespreksgeschiedenis van de chatbot van de assistent opvraagt. Het antwoord op de prompt wordt geretourneerd in het HTTP-antwoord.

Dit is het bestand function.json voor chatstatus ophalen:

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "Request",
      "route": "assistants/{assistantId}",
      "methods": [
        "get"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    },
    {
      "name": "State",
      "type": "assistantQuery",
      "direction": "in",
      "dataType": "string",
      "id": "{assistantId}",
      "timestampUtc": "{Query.timestampUTC}",
      "chatStorageConnectionSetting": "AzureWebJobsStorage",
      "collectionName": "ChatState"
    }
  ]
}

Zie de sectie Configuratie voor meer informatie over function.json bestandseigenschappen.

using namespace System.Net

param($Request, $TriggerMetadata, $State)

Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
    StatusCode = [HttpStatusCode]::OK
    Body       = $State
    Headers    = @{
        "Content-Type" = "application/json"
    }
})

In dit voorbeeld ziet u het aanmaakproces, waarbij de HTTP GET-functie die de gespreksgeschiedenis van de chatbot van de assistent opvraagt. Het antwoord op de prompt wordt geretourneerd in het HTTP-antwoord.

@apis.function_name("GetChatState")
@apis.route(route="assistants/{assistantId}", methods=["GET"])
@apis.assistant_query_input(
    arg_name="state",
    id="{assistantId}",
    timestamp_utc="{Query.timestampUTC}",
    chat_storage_connection_setting=DEFAULT_CHAT_STORAGE_SETTING,
    collection_name=DEFAULT_CHAT_COLLECTION_NAME,
)
def get_chat_state(req: func.HttpRequest, state: str) -> func.HttpResponse:
    return func.HttpResponse(state, status_code=200, mimetype="application/json")

Kenmerken

Pas het AssistantQuery kenmerk toe om een assistentquery-invoerbinding te definiëren, die ondersteuning biedt voor deze parameters:

Kenmerk Beschrijving
Legitimatiebewijs Hiermee haalt u de id van de assistent op om een query uit te voeren.
TimeStampUtc Optioneel. Hiermee wordt de tijdstempel van het vroegste bericht in de chatgeschiedenis opgehaald of ingesteld. De tijdstempel moet een ISO 8601-indeling hebben, bijvoorbeeld 2023-08-01T00:00:00Z.

Aantekeningen

Met de assistantQuery aantekening kunt u een assistentquery-invoerbinding definiëren, die ondersteuning biedt voor deze parameters:

Onderdeel Beschrijving
naam Hiermee haalt u de naam van de invoerbinding op of stelt u deze in.
ID Hiermee haalt u de id van de assistent op om een query uit te voeren.
timeStampUtc Optioneel. Hiermee wordt de tijdstempel van het vroegste bericht in de chatgeschiedenis opgehaald of ingesteld. De tijdstempel moet een ISO 8601-indeling hebben, bijvoorbeeld 2023-08-01T00:00:00Z.

Decorateurs

Definieer tijdens de preview de invoerbinding als een generic_input_binding binding van het type assistantQuery, die ondersteuning biedt voor deze parameters:

Kenmerk Beschrijving
arg_name De naam van de variabele die de bindingsparameter vertegenwoordigt.
ID Hiermee haalt u de id van de assistent op om een query uit te voeren.
time_stamp_utc Optioneel. Hiermee wordt de tijdstempel van het vroegste bericht in de chatgeschiedenis opgehaald of ingesteld. De tijdstempel moet een ISO 8601-indeling hebben, bijvoorbeeld 2023-08-01T00:00:00Z.

Configuratie

De binding ondersteunt deze configuratie-eigenschappen die u in het function.json-bestand hebt ingesteld.

Eigenschappen Beschrijving
soort Moet assistantQuery zijn.
richting Moet in zijn.
naam De naam van de invoerbinding.
ID Hiermee haalt u de id van de assistent op om een query uit te voeren.
timeStampUtc Optioneel. Hiermee wordt de tijdstempel van het vroegste bericht in de chatgeschiedenis opgehaald of ingesteld. De tijdstempel moet een ISO 8601-indeling hebben, bijvoorbeeld 2023-08-01T00:00:00Z.

Configuratie

De binding ondersteunt deze eigenschappen, die zijn gedefinieerd in uw code:

Eigenschappen Beschrijving
ID Hiermee haalt u de id van de assistent op om een query uit te voeren.
timeStampUtc Optioneel. Hiermee wordt de tijdstempel van het vroegste bericht in de chatgeschiedenis opgehaald of ingesteld. De tijdstempel moet een ISO 8601-indeling hebben, bijvoorbeeld 2023-08-01T00:00:00Z.

Gebruik

Zie de sectie Voorbeeld voor volledige voorbeelden.

Connections

Om de Azure OpenAI-bindingsextensie te gebruiken, moet je een verbinding specificeren met een OpenAI-modeldefinitie. Stel de OpenAI-modelverbinding in je bindings in met een van deze benaderingen:

  • Gebruik de AIConnectionName binding-eigenschap (voorkeur voor Azure OpenAI).
  • Instellen AZURE_OPENAI_ENDPOINT en AZURE_OPENAI_KEY in de app-instellingen (voor Azure OpenAI).
  • Stel alleen Open_API_Key in de app-instellingen in (voor https://api.openai.com).

De manier waarop je de verbinding instelt hangt af van zowel de model-API als de authenticatiemethode, zoals aangegeven in de volgende tabel:

Authenticatie/Model API Azure OpenAI OpenAI (https://api.openai.com)
Beheerde identiteitsverbinding AIConnectionName Niet ondersteund
Key Vault-referentie AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key
App-configuratiereferentie AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key
Gedeeld geheim AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key

Gebruik beheerde identiteitsgebaseerde verbindingen en het eigendom AIConnectionName .

Wanneer je gebruikt AIConnectionName, hangt de waarde van deze eigenschapsinstelling af van het type verbinding:

  • Managed identity-verbinding: De AIConnectionName eigenschap wordt <CONNECTION_NAME_PREFIX> gedeeld door een groep instellingen die samen een identiteitsgebaseerde verbinding met Azure OpenAI definiëren. Voor meer informatie, zie Definieer identiteitsverbindingen.
  • Key Vault-referentie: De AIConnectionName property-instelling geeft een Azure Key Vault-referentie terug naar de locatie waar de API-sleutel centraal wordt onderhouden. Voor meer informatie, zie Define Key Vault-verbindingen.
  • App Configuration reference: De AIConnectionName property-instelling geeft een Azure App Configuration-referentie terug die een API-sleutel of een Key Vault-referentie teruggeeft. Voor meer informatie, zie Azure App Configuration in het artikel over verbindingen.
  • API-sleutel: De AIConnectionName property-instelling wordt direct omgezet naar app-instellingen die het eindpunt en de sleutel bevatten. Omdat gedeelde sleutels gecompromitteerd kunnen worden, gebruik waar mogelijk beheerde identiteitsverbindingen. Voor meer informatie, zie Verbindingen definiëren.

Voor meer informatie over bindingsverbindingen, zie Verbindingen beheren in Azure Functions.

De OpenAI-bindings bevatten een AIConnectionName eigenschap die je kunt gebruiken om de <ConnectionNamePrefix> voor de groep app-instellingen te specificeren die de verbinding met Azure OpenAI definiëren:

Instellingsnaam Beschrijving
<CONNECTION_NAME_PREFIX>__endpoint Zet het URI-eindpunt van de Azure OpenAI-service. Deze instelling is altijd vereist.
<CONNECTION_NAME_PREFIX>__clientId Hiermee stelt u de specifieke door de gebruiker toegewezen identiteit in die moet worden gebruikt bij het verkrijgen van een toegangstoken. Vereist dat deze <CONNECTION_NAME_PREFIX>__credential is ingesteld op managedidentity. De eigenschap accepteert een client-id die overeenkomt met een door de gebruiker toegewezen identiteit die aan de toepassing is toegewezen. Het is ongeldig om zowel een resource-id als een client-id op te geven. Als je deze eigenschap niet specificeert, wordt de systeem-toegewezen identiteit gebruikt. Deze eigenschap wordt anders gebruikt in lokale ontwikkelscenario's, wanneer credential deze niet moeten worden ingesteld.
<CONNECTION_NAME_PREFIX>__credential Hiermee definieert u hoe een access token wordt verkregen voor de verbinding. Gebruiken managedidentity voor verificatie van beheerde identiteiten. Deze waarde is alleen geldig wanneer een beheerde identiteit beschikbaar is in de hostingomgeving.
<CONNECTION_NAME_PREFIX>__managedIdentityResourceId Wanneer credential is gezet op managedidentity, stel deze eigenschap in om de resource Identifier te specificeren die gebruikt moet worden bij het verkrijgen van een token. De eigenschap accepteert een resource-id die overeenkomt met de resource-id van de door de gebruiker gedefinieerde beheerde identiteit. Het is ongeldig om zowel een resource-id als een client-id op te geven. Als je geen van beide specificeert, wordt de door het systeem toegewezen identiteit gebruikt. Deze eigenschap wordt anders gebruikt in lokale ontwikkelscenario's, wanneer credential deze niet moeten worden ingesteld.
<CONNECTION_NAME_PREFIX>__key Stelt de gedeelde geheime sleutel in die nodig is om toegang te krijgen tot het eindpunt van de Azure OpenAI-dienst door gebruik te maken van sleutelgebaseerde authenticatie. Als beveiligingsbest practice gebruik je altijd Microsoft Entra ID met beheerde identiteiten voor authenticatie.

Overweeg deze managed identity-verbindingsinstellingen wanneer je de AIConnectionName eigenschap instelt op myAzureOpenAI:

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

Tijdens runtime interpreteert de host deze instellingen als één enkele myAzureOpenAI instelling:

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

Wanneer je managed identitys gebruikt, voeg je dan je identiteit toe aan de Cognitive Services OpenAI User rol.

Voeg deze instellingen bij lokaal uitvoeren toe aan het local.settings.json projectbestand. Zie Lokale ontwikkeling met op identiteit gebaseerde verbindingen voor meer informatie.

Zie Werken met toepassingsinstellingen voor meer informatie.