Azure OpenAI Assistant – Vytvoření výstupní vazby pro Azure Functions

Článek
11/09/2024

Důležité

Rozšíření Azure OpenAI pro Azure Functions je aktuálně ve verzi Preview.

Pomocník Azure OpenAI vytvoří výstupní vazbu, která vám umožní vytvořit nového chatovacího robota asistenta z provádění kódu funkce.

Informace o nastavení a konfiguraci rozšíření Azure OpenAI najdete v tématu Rozšíření Azure OpenAI pro Azure Functions. Další informace o asistentech Azure OpenAI najdete v tématu Rozhraní API pomocníků Azure OpenAI.

Poznámka:

Odkazy a příklady jsou k dispozici pouze pro model Node.js v4.

Poznámka:

Odkazy a příklady jsou k dispozici pouze pro model Pythonu v2.

Poznámka:

I když jsou podporovány oba modely procesu jazyka C#, jsou k dispozici pouze příklady izolovaného modelu pracovního procesu .

Příklad

Tento příklad ukazuje proces vytvoření, kde funkce HTTP PUT, která vytvoří nového chatovacího robota asistenta se zadaným ID. Odpověď na výzvu se vrátí v odpovědi HTTP.

/// HTTP PUT function that creates a new assistant chat bot with the specified ID.
/// </summary>
[Function(nameof(CreateAssistant))]
public static async Task<CreateChatBotOutput> CreateAssistant(
    [HttpTrigger(AuthorizationLevel.Anonymous, "put", Route = "assistants/{assistantId}")] HttpRequestData req,
    string assistantId)
{
    string instructions =
       """
        Don't make assumptions about what values to plug into functions.
        Ask for clarification if a user request is ambiguous.
        """;

    using StreamReader reader = new(req.Body);

    string request = await reader.ReadToEndAsync();


    return new CreateChatBotOutput
    {
        HttpResponse = new ObjectResult(new { assistantId }) { StatusCode = 202 },
        ChatBotCreateRequest = new AssistantCreateRequest(assistantId, instructions)
        {
            ChatStorageConnectionSetting = DefaultChatStorageConnectionSetting,
            CollectionName = DefaultCollectionName,
        },

Tento příklad ukazuje proces vytvoření, kde funkce HTTP PUT, která vytvoří nového chatovacího robota asistenta se zadaným ID. Odpověď na výzvu se vrátí v odpovědi HTTP.

 * account
 * where chat data will be stored.
 */
String DEFAULT_CHATSTORAGE = "AzureWebJobsStorage";

/**
 * The default collection name for the table storage account.
 * This constant is used to specify the collection name for the table storage
 * account
 * where chat data will be stored.
 */
String DEFAULT_COLLECTION = "ChatState";

/*
 * HTTP PUT function that creates a new assistant chat bot with the specified ID.
 */
@FunctionName("CreateAssistant")
public HttpResponseMessage createAssistant(
    @HttpTrigger(
        name = "req", 
        methods = {HttpMethod.PUT}, 
        authLevel = AuthorizationLevel.ANONYMOUS, 
        route = "assistants/{assistantId}") 
        HttpRequestMessage<Optional<String>> request,
    @BindingName("assistantId") String assistantId,
    @AssistantCreate(name = "AssistantCreate") OutputBinding<AssistantCreateRequest> message,

Příklady ještě nejsou k dispozici.

Tento příklad ukazuje proces vytvoření, kde funkce HTTP PUT, která vytvoří nového chatovacího robota asistenta se zadaným ID. Odpověď na výzvu se vrátí v odpovědi HTTP.

const COLLECTION_NAME = "ChatState";

const chatBotCreateOutput = output.generic({
    type: 'assistantCreate'
})
app.http('CreateAssistant', {
    methods: ['PUT'],
    route: 'assistants/{assistantId}',
    authLevel: 'anonymous',
    extraOutputs: [chatBotCreateOutput],
    handler: async (request: HttpRequest, context: InvocationContext) => {
        const assistantId = request.params.assistantId
        const instructions =
            `
            Don't make assumptions about what values to plug into functions.
            Ask for clarification if a user request is ambiguous.
            `
        const createRequest = {
            id: assistantId,
            instructions: instructions,
            chatStorageConnectionSetting: CHAT_STORAGE_CONNECTION_SETTING,
            collectionName: COLLECTION_NAME
        }

Tento příklad ukazuje proces vytvoření, kde funkce HTTP PUT, která vytvoří nového chatovacího robota asistenta se zadaným ID. Odpověď na výzvu se vrátí v odpovědi HTTP.

Tady je soubor function.json pro Nástroj Create Assistant:

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "Request",
      "route": "assistants/{assistantId}",
      "methods": [
        "put"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    },
    {
      "type": "assistantCreate",
      "direction": "out",
      "dataType": "string",
      "name": "Requests"
    }
  ]
}

Další informace o function.json vlastnosti souboru naleznete v části Konfigurace .

{{Pochází z ukázkového komentáře ke kódu}}

using namespace System.Net

param($Request, $TriggerMetadata)

$assistantId = $Request.params.assistantId

$instructions = "Don't make assumptions about what values to plug into functions."
$instructions += "\nAsk for clarification if a user request is ambiguous."

$create_request = @{
    "id" = $assistantId
    "instructions" = $instructions
    "chatStorageConnectionSetting" = "AzureWebJobsStorage"
    "collectionName" = "ChatState"
}

Push-OutputBinding -Name Requests -Value (ConvertTo-Json $create_request)

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

Tento příklad ukazuje proces vytvoření, kde funkce HTTP PUT, která vytvoří nového chatovacího robota asistenta se zadaným ID. Odpověď na výzvu se vrátí v odpovědi HTTP.

DEFAULT_CHAT_COLLECTION_NAME = "ChatState"

@apis.function_name("CreateAssistant")
@apis.route(route="assistants/{assistantId}", methods=["PUT"])
@apis.assistant_create_output(arg_name="requests")
def create_assistant(req: func.HttpRequest, requests: func.Out[str]) -> func.HttpResponse:
    assistantId = req.route_params.get("assistantId")
    instructions = """
            Don't make assumptions about what values to plug into functions.
            Ask for clarification if a user request is ambiguous.
            """
    create_request = {
        "id": assistantId,
        "instructions": instructions,
        "chatStorageConnectionSetting": DEFAULT_CHAT_STORAGE_SETTING,
        "collectionName": DEFAULT_CHAT_COLLECTION_NAME

Atributy

CreateAssistant Použijte atribut k definování výstupní vazby pomocníka, který podporuje tyto parametry:

Parametr	Popis
Id	Identifikátor asistenta, který se má vytvořit.
Pokyny	Volitelné. Pokyny, které jsou k dispozici asistentovi, které je třeba dodržovat.

Poznámky

Poznámka CreateAssistant umožňuje definovat asistenta vytvořit výstupní vazbu, která podporuje tyto parametry:

Element (Prvek)	Popis
Jméno	Získá nebo nastaví název výstupní vazby.
id	Identifikátor asistenta, který se má vytvořit.
instrukce	Volitelné. Pokyny, které jsou k dispozici asistentovi, které je třeba dodržovat.

Dekoratéry

Během verze Preview definujte výstupní vazbu jako generic_output_binding vazbu typu createAssistant, která podporuje tyto parametry:

Parametr	Popis
arg_name	Název proměnné, která představuje parametr vazby.
id	Identifikátor asistenta, který se má vytvořit.
instrukce	Volitelné. Pokyny, které jsou k dispozici asistentovi, které je třeba dodržovat.

Konfigurace

Vazba podporuje tyto vlastnosti konfigurace, které jste nastavili v souboru function.json.

Vlastnost	Popis
type	Musí být `CreateAssistant`.
direction	Musí být `out`.
Jméno	Název výstupní vazby.
id	Identifikátor asistenta, který se má vytvořit.
instrukce	Volitelné. Pokyny, které jsou k dispozici asistentovi, které je třeba dodržovat.

Konfigurace

Vazba podporuje tyto vlastnosti, které jsou definovány v kódu:

Vlastnost	Popis
id	Identifikátor asistenta, který se má vytvořit.
instrukce	Volitelné. Pokyny, které jsou k dispozici asistentovi, které je třeba dodržovat.

Využití

Kompletní příklady najdete v části Příklad.