Powiązanie danych wejściowych asystenta usługi Azure OpenAI dla usługi Azure Functions

Ważne

Rozszerzenie Azure OpenAI dla usługi Azure Functions jest obecnie dostępne w wersji zapoznawczej.

Powiązanie danych wejściowych asystenta usługi Azure OpenAI umożliwia integrację zapytań interfejsu API Asystentów z wykonywaniem kodu.

Aby uzyskać informacje na temat konfigurowania i konfigurowania rozszerzenia Azure OpenAI, zobacz Azure OpenAI extensions for Azure Functions (Rozszerzenia azure OpenAI dla usługi Azure Functions). Aby dowiedzieć się więcej na temat asystentów usługi Azure OpenAI, zobacz Interfejs API asystentów usługi Azure OpenAI.

Uwaga

Odwołania i przykłady są udostępniane tylko dla modelu Node.js w wersji 4.

Uwaga

Odwołania i przykłady są udostępniane tylko dla modelu języka Python w wersji 2.

Uwaga

Chociaż oba modele procesów języka C# są obsługiwane, udostępniane są tylko izolowane przykłady modeli procesów roboczych.

Przykład

W tym przykładzie pokazano proces tworzenia, w którym funkcja HTTP GET, która wysyła zapytania do historii konwersacji asystenta czatbota. Odpowiedź na monit jest zwracana w odpowiedzi HTTP.

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

W tym przykładzie pokazano proces tworzenia, w którym funkcja HTTP GET, która wysyła zapytania do historii konwersacji asystenta czatbota. Odpowiedź na monit jest zwracana w odpowiedzi HTTP.

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

W tym przykładzie pokazano proces tworzenia, w którym funkcja HTTP GET, która wysyła zapytania do historii konwersacji asystenta czatbota. Odpowiedź na monit jest zwracana w odpowiedzi HTTP.

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: 'anonymous',
    extraInputs: [chatBotQueryInput],
    handler: async (_, context) => {
        const state = context.extraInputs.get(chatBotQueryInput)
        return { status: 200, jsonBody: state }
    }
})

W tym przykładzie pokazano proces tworzenia, w którym funkcja HTTP GET, która wysyła zapytania do historii konwersacji asystenta czatbota. Odpowiedź na monit jest zwracana w odpowiedzi HTTP.

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: 'anonymous',
    extraInputs: [chatBotQueryInput],
    handler: async (_, context) => {
        const state: any = context.extraInputs.get(chatBotQueryInput)
        return { status: 200, jsonBody: state }
    }
})

W tym przykładzie pokazano proces tworzenia, w którym funkcja HTTP GET, która wysyła zapytania do historii konwersacji asystenta czatbota. Odpowiedź na monit jest zwracana w odpowiedzi HTTP.

Oto plik function.json get chat state:

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

Aby uzyskać więcej informacji na temat function.json właściwości pliku, zobacz sekcję Konfiguracja.

using namespace System.Net

param($Request, $TriggerMetadata, $State)

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

W tym przykładzie pokazano proces tworzenia, w którym funkcja HTTP GET, która wysyła zapytania do historii konwersacji asystenta czatbota. Odpowiedź na monit jest zwracana w odpowiedzi HTTP.

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

Atrybuty

Zastosuj atrybut, AssistantQuery aby zdefiniować powiązanie wejściowe zapytania asystenta, które obsługuje następujące parametry:

Parametr	Opis
Id	Pobiera identyfikator asystenta do wykonywania zapytań.
Znacznik czasu Utc	Opcjonalne. Pobiera lub ustawia znacznik czasu najwcześniejszej wiadomości w historii czatu, aby pobrać. Znacznik czasu powinien mieć format ISO 8601 — na przykład 2023-08-01T00:00:00Z.

Adnotacje

Adnotacja assistantQuery umożliwia zdefiniowanie asystenta powiązania wejściowego zapytania, które obsługuje następujące parametry:

Składnik	Opis
nazwa	Pobiera lub ustawia nazwę powiązania wejściowego.
id	Pobiera identyfikator asystenta do wykonywania zapytań.
znacznik czasu Utc	Opcjonalne. Pobiera lub ustawia znacznik czasu najwcześniejszej wiadomości w historii czatu, aby pobrać. Znacznik czasu powinien mieć format ISO 8601 — na przykład 2023-08-01T00:00:00Z.

Dekoratory

W wersji zapoznawczej zdefiniuj powiązanie wejściowe jako generic_input_binding powiązanie typu assistantQuery, które obsługuje następujące parametry:

Parametr	Opis
arg_name	Nazwa zmiennej reprezentującej parametr powiązania.
id	Pobiera identyfikator asystenta do wykonywania zapytań.
time_stamp_utc	Opcjonalne. Pobiera lub ustawia znacznik czasu najwcześniejszej wiadomości w historii czatu, aby pobrać. Znacznik czasu powinien mieć format ISO 8601 — na przykład 2023-08-01T00:00:00Z.

Konfigurowanie

Powiązanie obsługuje te właściwości konfiguracji ustawione w pliku function.json.

Właściwości	Opis
typ	Musi mieć wartość assistantQuery.
kierunek	Musi mieć wartość in.
nazwa	Nazwa powiązania wejściowego.
id	Pobiera identyfikator asystenta do wykonywania zapytań.
znacznik czasu Utc	Opcjonalne. Pobiera lub ustawia znacznik czasu najwcześniejszej wiadomości w historii czatu, aby pobrać. Znacznik czasu powinien mieć format ISO 8601 — na przykład 2023-08-01T00:00:00Z.

Konfigurowanie

Powiązanie obsługuje te właściwości zdefiniowane w kodzie:

Właściwości	Opis
id	Pobiera identyfikator asystenta do wykonywania zapytań.
znacznik czasu Utc	Opcjonalne. Pobiera lub ustawia znacznik czasu najwcześniejszej wiadomości w historii czatu, aby pobrać. Znacznik czasu powinien mieć format ISO 8601 — na przykład 2023-08-01T00:00:00Z.

Użycie

Zobacz sekcję Przykład, aby zapoznać się z kompletnymi przykładami.

Powiązana zawartość

• Przykłady asystentów
• Rozszerzenie Azure OpenAI
• Wyzwalacz asystenta usługi Azure OpenAI
• Asystent usługi Azure OpenAI — tworzenie powiązania wyjściowego
• Asystent usługi Azure OpenAI po powiązaniu wejściowym