Azure OpenAI-assistentutlösare för Azure Functions

Viktigt!

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

Med utlösaren för Azure OpenAI-assistenten kan du köra din kod baserat på anpassad chattrobot eller kunskapsbegäran som gjorts till en assistent.

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 hur du skapar en assistent som lägger till en ny uppgift att göra i en databas. Utlösaren har en statisk beskrivning av Create a new todo task modellens användning. Själva funktionen tar en sträng som representerar en ny uppgift att lägga till. När den körs lägger funktionen till uppgiften som ett nytt att göra-objekt i ett anpassat objektarkiv och returnerar ett svar från arkivet.

[Function(nameof(AddTodo))]
public Task AddTodo([AssistantSkillTrigger("Create a new todo task")] string taskDescription)
{
    if (string.IsNullOrEmpty(taskDescription))
    {
        throw new ArgumentException("Task description cannot be empty");
    }

    this.logger.LogInformation("Adding todo: {task}", taskDescription);

    string todoId = Guid.NewGuid().ToString()[..6];
    return this.todoManager.AddTodoAsync(new TodoItem(todoId, taskDescription));
}

Det här exemplet visar hur du skapar en assistent som lägger till en ny uppgift att göra i en databas. Utlösaren har en statisk beskrivning av Create a new todo task modellens användning. Själva funktionen tar en sträng som representerar en ny uppgift att lägga till. När den körs lägger funktionen till uppgiften som ett nytt att göra-objekt i ett anpassat objektarkiv och returnerar ett svar från arkivet.

/**
 * Called by the assistant to create new todo tasks.
 */
@FunctionName("AddTodo")
public void addTodo(
    @AssistantSkillTrigger(
            name = "assistantSkillCreateTodo",
            functionDescription = "Create a new todo task"
    ) String taskDescription,
    final ExecutionContext context) {

    if (taskDescription == null || taskDescription.isEmpty()) {
        throw new IllegalArgumentException("Task description cannot be empty");
    }
    context.getLogger().info("Adding todo: " + taskDescription);

    String todoId = UUID.randomUUID().toString().substring(0, 6);
    TodoItem todoItem = new TodoItem(todoId, taskDescription);
    todoManager.addTodo(todoItem);
}

Det här exemplet visar hur du skapar en assistent som lägger till en ny uppgift att göra i en databas. Utlösaren har en statisk beskrivning av Create a new todo task modellens användning. Själva funktionen tar en sträng som representerar en ny uppgift att lägga till. När den körs lägger funktionen till uppgiften som ett nytt att göra-objekt i ett anpassat objektarkiv och returnerar ett svar från arkivet.

const { app, trigger } = require("@azure/functions");
const { TodoItem, CreateTodoManager } = require("../services/todoManager");
const { randomUUID } = require('crypto');

const todoManager = CreateTodoManager()

app.generic('AddTodo', {
    trigger: trigger.generic({
        type: 'assistantSkillTrigger',
        functionDescription: 'Create a new todo task'
    }),
    handler: async (taskDescription, context) => {
        if (!taskDescription) {
            throw new Error('Task description cannot be empty')
        }

        context.log(`Adding todo: ${taskDescription}`)

        const todoId = randomUUID().substring(0, 6)
        return todoManager.AddTodo(new TodoItem(todoId, taskDescription))
    }
})
import { InvocationContext, app, trigger } from "@azure/functions"
import { TodoItem, ITodoManager, CreateTodoManager } from "../services/todoManager"
import { randomUUID } from 'crypto';

const todoManager: ITodoManager = CreateTodoManager()

app.generic('AddTodo', {
    trigger: trigger.generic({
        type: 'assistantSkillTrigger',
        functionDescription: 'Create a new todo task'
    }),
    handler: async (taskDescription: string, context: InvocationContext) => {
        if (!taskDescription) {
            throw new Error('Task description cannot be empty')
        }

        context.log(`Adding todo: ${taskDescription}`)

        const todoId = randomUUID().substring(0, 6)
        return todoManager.AddTodo(new TodoItem(todoId, taskDescription))
    }
})

Det här exemplet visar hur du skapar en assistent som lägger till en ny uppgift att göra i en databas. Utlösaren har en statisk beskrivning av Create a new todo task modellens användning. Själva funktionen tar en sträng som representerar en ny uppgift att lägga till. När den körs lägger funktionen till uppgiften som ett nytt att göra-objekt i ett anpassat objektarkiv och returnerar ett svar från arkivet.

Här är function.json-filen för Lägg till todo:

{
  "bindings": [
    {
      "name": "TaskDescription",
      "type": "assistantSkillTrigger",
      "dataType": "string",
      "direction": "in",
      "functionDescription": "Create a new todo task"
    }
  ]
}

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

using namespace System.Net

param($TaskDescription, $TriggerMetadata)
$ErrorActionPreference = "Stop"

if (-not $TaskDescription) {
    throw "Task description cannot be empty"
}

Write-Information "Adding todo: $TaskDescription"
$todoID = [Guid]::NewGuid().ToString().Substring(0, 5)
Add-Todo $todoId $TaskDescription

Det här exemplet visar hur du skapar en assistent som lägger till en ny uppgift att göra i en databas. Utlösaren har en statisk beskrivning av Create a new todo task modellens användning. Själva funktionen tar en sträng som representerar en ny uppgift att lägga till. När den körs lägger funktionen till uppgiften som ett nytt att göra-objekt i ett anpassat objektarkiv och returnerar ett svar från arkivet.

@skills.function_name("AddTodo")
@skills.assistant_skill_trigger(
    arg_name="taskDescription", function_description="Create a new todo task"
)
def add_todo(taskDescription: str) -> None:
    if not taskDescription:
        raise ValueError("Task description cannot be empty")

    logging.info(f"Adding todo: {taskDescription}")

    todo_id = str(uuid.uuid4())[0:6]
    todo_manager.add_todo(TodoItem(id=todo_id, task=taskDescription))
    return

Attribut

AssistantSkillTrigger Använd attributet för att definiera en assistentutlösare som stöder följande parametrar:

Parameter Beskrivning
FunctionDescription Hämtar beskrivningen av assistentfunktionen, som tillhandahålls till modellen.
Funktionsnamn Valfritt. Hämtar eller anger namnet på funktionen som anropas av assistenten.
ParameterDescriptionJson Valfritt. Hämtar eller anger en JSON-beskrivning av funktionsparametern, som tillhandahålls till modellen. Mer information finns i Användning.

Kommentarer

Med anteckningen AssistantSkillTrigger kan du definiera en assistentutlösare som stöder följande parametrar:

Komponent Beskrivning
Namn Hämtar eller anger namnet på indatabindningen.
functionDescription Hämtar beskrivningen av assistentfunktionen, som tillhandahålls till modellen.
functionName Valfritt. Hämtar eller anger namnet på funktionen som anropas av assistenten.
parameterDescriptionJson Valfritt. Hämtar eller anger en JSON-beskrivning av funktionsparametern, som tillhandahålls till modellen. Mer information finns i Användning.

Dekoratörer

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

Parameter Beskrivning
function_description Hämtar beskrivningen av assistentfunktionen, som tillhandahålls till modellen.
function_name Valfritt. Hämtar eller anger namnet på en funktion som anropas av assistenten.
parameterDescriptionJson Valfritt. Hämtar eller anger en JSON-beskrivning av funktionsparametern, som tillhandahålls till modellen. Mer information finns i Användning.

Konfiguration

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

Fastighet Beskrivning
typ Måste vara AssistantSkillTrigger.
riktning Måste vara in.
Namn Namnet på utlösaren.
functionName Hämtar eller anger namnet på funktionen som anropas av assistenten.
functionDescription Hämtar beskrivningen av assistentfunktionen, som tillhandahålls till språkmodellen.
parameterDescriptionJson Valfritt. Hämtar eller anger en JSON-beskrivning av funktionsparametern, som tillhandahålls till modellen. Mer information finns i Användning.

Konfiguration

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

Fastighet Beskrivning
typ Måste vara AssistantSkillTrigger.
Namn Namnet på utlösaren.
functionName Hämtar eller anger namnet på funktionen som anropas av assistenten.
functionDescription Hämtar beskrivningen av assistentfunktionen, som tillhandahålls till LLM
parameterDescriptionJson Valfritt. Hämtar eller anger en JSON-beskrivning av funktionsparametern, som tillhandahålls till modellen. Mer information finns i Användning.

Se avsnittet Exempel för fullständiga exempel.

Förbrukning

När parameterDescriptionJson JSON-värdet inte anges genereras det automatiskt. För mer information om syntaxen för detta objekt, se OpenAI-funktionen som anropar dokumentationen.

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.