Azure OpenAI-assistentens frågeindatabindning för Azure Functions

Viktigt!

Azure OpenAI-tillägget för Azure Functions är för närvarande i förhandsversion.

Med frågeindatabindningen för Azure OpenAI-assistenten kan du integrera API-frågor för assistenter i dina kodkörningar.

Information om konfiguration och konfigurationsinformation för Azure OpenAI-tillägget finns i Azure OpenAI-tillägg för Azure Functions. Mer information om Azure OpenAI-assistenter finns i API för Azure OpenAI Assistants.

Kommentar

Referenser och exempel tillhandahålls endast för modellen Node.js v4.

Kommentar

Referenser och exempel tillhandahålls endast för Python v2-modellen.

Kommentar

Båda C#-processmodellerna stöds, men endast exempel på isolerade arbetsmodeller tillhandahålls.

Exempel

Go-stöd finns för närvarande inte tillgängligt för denna bindning.

Det här exemplet visar skapandeprocessen, där funktionen HTTP GET som frågar konversationshistoriken för chattroboten för assistenten. Svaret på uppmaningen returneras i HTTP-svaret.

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

Det här exemplet visar skapandeprocessen, där funktionen HTTP GET som frågar konversationshistoriken för chattroboten för assistenten. Svaret på uppmaningen returneras i HTTP-svaret.

/*
 * 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();
}

Det här exemplet visar skapandeprocessen, där funktionen HTTP GET som frågar konversationshistoriken för chattroboten för assistenten. Svaret på uppmaningen returneras i HTTP-svaret.

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

Det här exemplet visar skapandeprocessen, där funktionen HTTP GET som frågar konversationshistoriken för chattroboten för assistenten. Svaret på uppmaningen returneras i HTTP-svaret.

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

Det här exemplet visar skapandeprocessen, där funktionen HTTP GET som frågar konversationshistoriken för chattroboten för assistenten. Svaret på uppmaningen returneras i HTTP-svaret.

Här är function.json-filen för Hämta chatttillstånd:

{
  "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"
    }
  ]
}

Mer information om function.json filegenskaper finns i avsnittet Konfiguration .

using namespace System.Net

param($Request, $TriggerMetadata, $State)

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

Det här exemplet visar skapandeprocessen, där funktionen HTTP GET som frågar konversationshistoriken för chattroboten för assistenten. Svaret på uppmaningen returneras i HTTP-svaret.

@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")

Attribut

AssistantQuery Använd attributet för att definiera en assisterande frågeindatabindning, som stöder följande parametrar:

Parameter Beskrivning
ID Hämtar ID:t för assistenten att fråga.
TimeStampUtc Valfritt. Hämtar eller anger tidsstämpeln för det tidigaste meddelandet i chatthistoriken som ska hämtas. Tidsstämpeln ska vara i ISO 8601-format – till exempel 2023-08-01T00:00:00Z.

Kommentarer

Med anteckningen assistantQuery kan du definiera en assisterande frågeindatabindning som stöder följande parametrar:

Komponent Beskrivning
Namn Hämtar eller anger namnet på indatabindningen.
ID Hämtar ID:t för assistenten att fråga.
timeStampUtc Valfritt. Hämtar eller anger tidsstämpeln för det tidigaste meddelandet i chatthistoriken som ska hämtas. Tidsstämpeln ska vara i ISO 8601-format – till exempel 2023-08-01T00:00:00Z.

Dekoratörer

Under förhandsversionen definierar du indatabindningen som en generic_input_binding bindning av typen assistantQuery, som stöder följande parametrar:

Parameter Beskrivning
arg_name Namnet på variabeln som representerar bindningsparametern.
ID Hämtar ID:t för assistenten att fråga.
time_stamp_utc Valfritt. Hämtar eller anger tidsstämpeln för det tidigaste meddelandet i chatthistoriken som ska hämtas. Tidsstämpeln ska vara i ISO 8601-format – till exempel 2023-08-01T00:00:00Z.

Konfiguration

Bindningen stöder de konfigurationsegenskaper som du anger i filen function.json.

Fastighet Beskrivning
typ Måste vara assistantQuery.
riktning Måste vara in.
Namn Namnet på indatabindningen.
ID Hämtar ID:t för assistenten att fråga.
timeStampUtc Valfritt. Hämtar eller anger tidsstämpeln för det tidigaste meddelandet i chatthistoriken som ska hämtas. Tidsstämpeln ska vara i ISO 8601-format – till exempel 2023-08-01T00:00:00Z.

Konfiguration

Bindningen stöder dessa egenskaper, som definieras i koden:

Fastighet Beskrivning
ID Hämtar ID:t för assistenten att fråga.
timeStampUtc Valfritt. Hämtar eller anger tidsstämpeln för det tidigaste meddelandet i chatthistoriken som ska hämtas. Tidsstämpeln ska vara i ISO 8601-format – till exempel 2023-08-01T00:00:00Z.

Förbrukning

Se avsnittet Exempel för fullständiga exempel.

Connections

För att använda Azure OpenAI-bindningstillägget måste du specificera en anslutning till en OpenAI-modelldefinition. Ställ in OpenAI-modellanslutningen i dina bindningar med en av dessa metoder:

  • Använd bindningsegenskapen AIConnectionName (föredragen för Azure OpenAI).
  • Sätt AZURE_OPENAI_ENDPOINT och AZURE_OPENAI_KEY i app-inställningar (för Azure OpenAI).
  • Ställ in endast Open_API_Key i app-inställningarna (för https://api.openai.com).

Hur du ställer in anslutningen beror både på modellens API och autentiseringsmetoden, vilket indikeras i följande tabell:

Autentisering/Modell-API Azure OpenAI OpenAI (https://api.openai.com)
Hanterad identitetsanslutning AIConnectionName Stöds ej
Key Vault-referens AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key
Appkonfigurationsreferens AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key
Delad hemlighet AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key

Använd hanterade identitetsbaserade kontakter och AIConnectionName egendomen.

När du använder AIConnectionName, beror värdet på denna egenskapsinställning på typen av anslutning:

  • Managed identity-anslutning: Egenskapen AIConnectionName<CONNECTION_NAME_PREFIX> delas av en grupp inställningar som tillsammans definierar en identitetsbaserad anslutning till Azure OpenAI. För mer information, se Definiera identitetskopplingar.
  • Key Vault-referens: Egenskapsinställningen AIConnectionName returnerar en Azure Key Vault-referens till platsen där API-nyckeln underhålls centralt. För mer information, se Definiera Key Vault-anslutningar.
  • App Configuration Reference: Egenskapsinställningen AIConnectionName returnerar en Azure App Configuration-referens som returnerar en API-nyckel eller en Key Vault-referens. För mer information, se Azure App Configuration i artikeln om anslutningar.
  • API-nyckel: Egenskapsinställningen AIConnectionName löses till appinställningar som innehåller endpoint och nyckel direkt. Eftersom delade nycklar kan komprometteras, använd hanterade identitetsanslutningar när det är möjligt. För mer information, se Definiera kopplingar.

För att lära dig mer om bindningsanslutningar, se Hantera anslutningar i Azure Functions.

OpenAI-bindningarna inkluderar en AIConnectionName egenskap som du kan använda för att specificera för <ConnectionNamePrefix> gruppen av appinställningar som definierar anslutningen till Azure OpenAI:

Inställningsnamn Beskrivning
<CONNECTION_NAME_PREFIX>__endpoint Sätter URI-endpoint för Azure OpenAI-tjänsten. Den här inställningen krävs alltid.
<CONNECTION_NAME_PREFIX>__clientId Anger den specifika användartilldelade identiteten som ska användas när du hämtar en åtkomsttoken. Kräver som <CONNECTION_NAME_PREFIX>__credential är inställt på managedidentity. Egenskapen accepterar ett klient-ID som motsvarar en användartilldelad identitet som tilldelats programmet. Det är ogiltigt att ange både ett resurs-ID och ett klient-ID. Om du inte specificerar denna egenskap används den systemtilldelade identiteten. Den här egenskapen används på olika sätt i lokala utvecklingsscenarier, när credential bör inte anges.
<CONNECTION_NAME_PREFIX>__credential Definierar hur en access token hämtas för anslutningen. Används managedidentity för hanterad identitetsautentisering. Det här värdet är endast giltigt när en hanterad identitet är tillgänglig i värdmiljön.
<CONNECTION_NAME_PREFIX>__managedIdentityResourceId När credential är satt till managedidentity, ställ in denna egenskap för att specificera resursidentifieraren som ska användas vid erhållning av en token. Egenskapen accepterar en resursidentifierare som motsvarar resurs-ID:t för den användardefinierade hanterade identiteten. Det är ogiltigt att ange både ett resurs-ID och ett klient-ID. Om du inte specificerar någon av dem används den system-tilldelade identiteten. Den här egenskapen används på olika sätt i lokala utvecklingsscenarier, när credential bör inte anges.
<CONNECTION_NAME_PREFIX>__key Sätter den delade hemliga nyckeln som krävs för att komma åt slutpunkten för Azure OpenAI-tjänsten genom att använda nyckelbaserad autentisering. Som säkerhetspraxis, använd alltid Microsoft Entra ID med hanterade identiteter för autentisering.

Överväg dessa inställningar för managed identity connection när du sätter egenskapen AIConnectionName till myAzureOpenAI:

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

Vid körning tolkar värden dessa inställningar som en enda myAzureOpenAI inställning:

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

När du använder hanterade identiteter, se till att lägga till din identitet i rollen Cognitive Services OpenAI User .

När du kör lokalt, lägg till dessa inställningar i local.settings.json projektfilen. Mer information finns i Lokal utveckling med identitetsbaserade anslutningar.

Mer information finns i Arbeta med programinställningar.