Azure OpenAI-Assistentenauslöser für Azure Functions

Wichtig

Die Azure OpenAI-Erweiterung für Azure Functions befindet sich derzeit in der Vorschau.

Mit dem Azure OpenAI-Assistentenauslöser können Sie Ihren Code auf der Grundlage von benutzerdefinierten Chatbot- oder Skillanforderungen ausführen, die an einen Assistenten gestellt werden.

Informationen zu Einrichtungs- und Konfigurationsdetails der Azure OpenAI-Erweiterung finden Sie unter Azure OpenAI-Erweiterungen für Azure Functions. Weitere Informationen zu Azure OpenAI-Assistenten finden Sie unter API für Azure OpenAI-Assistenten.

Hinweis

Referenzen und Beispiele werden nur für das Node.js v4-Modell bereitgestellt.

Hinweis

Referenzen und Beispiele werden nur für das Python v2-Modell bereitgestellt.

Hinweis

Während beide C#-Prozessmodelle unterstützt werden, werden nur Isolierte Arbeitsmodellbeispiele bereitgestellt.

Beispiel

Go-Support ist derzeit nicht für diese Bindung verfügbar.

Dieses Beispiel zeigt, wie man einen Assistenten erstellt, der eine neue Aufgabe zu einer Datenbank hinzufügt. Der Auslöser hat eine statische Beschreibung von Create a new todo task, die vom Modell verwendet wird. Die Funktion selbst nimmt eine Zeichenfolge an, die eine neue Aufgabe darstellt, die hinzugefügt werden soll. Bei der Ausführung fügt die Funktion die Aufgabe als neues ToDo-Element in einem benutzerdefinierten Elementspeicher hinzu und gibt eine Antwort aus dem Speicher zurück.

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

Dieses Beispiel zeigt, wie man einen Assistenten erstellt, der eine neue Aufgabe zu einer Datenbank hinzufügt. Der Auslöser hat eine statische Beschreibung von Create a new todo task, die vom Modell verwendet wird. Die Funktion selbst nimmt eine Zeichenfolge an, die eine neue Aufgabe darstellt, die hinzugefügt werden soll. Bei der Ausführung fügt die Funktion die Aufgabe als neues ToDo-Element in einem benutzerdefinierten Elementspeicher hinzu und gibt eine Antwort aus dem Speicher zurück.

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

Dieses Beispiel zeigt, wie man einen Assistenten erstellt, der eine neue Aufgabe zu einer Datenbank hinzufügt. Der Auslöser hat eine statische Beschreibung von Create a new todo task, die vom Modell verwendet wird. Die Funktion selbst nimmt eine Zeichenfolge an, die eine neue Aufgabe darstellt, die hinzugefügt werden soll. Bei der Ausführung fügt die Funktion die Aufgabe als neues ToDo-Element in einem benutzerdefinierten Elementspeicher hinzu und gibt eine Antwort aus dem Speicher zurück.

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

Dieses Beispiel zeigt, wie man einen Assistenten erstellt, der eine neue Aufgabe zu einer Datenbank hinzufügt. Der Auslöser hat eine statische Beschreibung von Create a new todo task, die vom Modell verwendet wird. Die Funktion selbst nimmt eine Zeichenfolge an, die eine neue Aufgabe darstellt, die hinzugefügt werden soll. Bei der Ausführung fügt die Funktion die Aufgabe als neues ToDo-Element in einem benutzerdefinierten Elementspeicher hinzu und gibt eine Antwort aus dem Speicher zurück.

Dies ist die function.json Datei für "Add Todo":

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

Weitere Informationen zu den Dateieigenschaften von function.json finden Sie im Abschnitt 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

Dieses Beispiel zeigt, wie man einen Assistenten erstellt, der eine neue Aufgabe zu einer Datenbank hinzufügt. Der Auslöser hat eine statische Beschreibung von Create a new todo task, die vom Modell verwendet wird. Die Funktion selbst nimmt eine Zeichenfolge an, die eine neue Aufgabe darstellt, die hinzugefügt werden soll. Bei der Ausführung fügt die Funktion die Aufgabe als neues ToDo-Element in einem benutzerdefinierten Elementspeicher hinzu und gibt eine Antwort aus dem Speicher zurück.

@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

Attribute

Wenden Sie das Attribut AssistantSkillTrigger an, um einen Assistentenauslöser zu definieren, der diese Parameter unterstützt:

Parameter Beschreibung
FunctionDescription Ruft die Beschreibung der Assistenzfunktion ab, die dem Modell zur Verfügung gestellt wird.
FunctionName Optional. Ruft den Namen der Funktion ab, die vom Assistenten aufgerufen wird, oder legt ihn fest.
ParameterDescriptionJson Optional. Ruft eine JSON-Beschreibung des Funktionsparameters ab, die dem Modell zur Verfügung gestellt wird, oder legt diese fest. Weitere Informationen finden Sie unter Verbrauch.

Anmerkungen

Mit der Anmerkung AssistantSkillTrigger können Sie einen Assistentenauslöser festlegen, die diese Parameter unterstützt:

Element Beschreibung
Name Ruft den Namen der Eingabebindung ab oder legt ihn fest.
functionDescription Ruft die Beschreibung der Assistenzfunktion ab, die dem Modell zur Verfügung gestellt wird.
functionName Optional. Ruft den Namen der Funktion ab, die vom Assistenten aufgerufen wird, oder legt ihn fest.
parameterDescriptionJson Optional. Ruft eine JSON-Beschreibung des Funktionsparameters ab, die dem Modell zur Verfügung gestellt wird, oder legt diese fest. Weitere Informationen finden Sie unter Verbrauch.

Decorator-Elemente

Definieren Sie während der Vorschau die Eingabebindung als generic_trigger-Bindung vom Typ assistantSkillTrigger, die diese Parameter unterstützt:

Parameter Beschreibung
function_description Ruft die Beschreibung der Assistenzfunktion ab, die dem Modell zur Verfügung gestellt wird.
function_name Optional. Ruft den Namen einer Funktion ab, die vom Assistenten aufgerufen wird, oder legt ihn fest.
parameterDescriptionJson Optional. Ruft eine JSON-Beschreibung des Funktionsparameters ab, die dem Modell zur Verfügung gestellt wird, oder legt diese fest. Weitere Informationen finden Sie unter Verbrauch.

Konfiguration

Die Bindung unterstützt diese Konfigurationseigenschaften, die Sie in der Datei „function.json“ festlegen.

Eigenschaft Beschreibung
Typ Muss AssistantSkillTriggerlauten.
Richtung Muss inlauten.
Name Der Name des Triggers.
functionName Ruft den Namen der Funktion ab, die vom Assistenten aufgerufen wird, oder legt ihn fest.
functionDescription Ruft die Beschreibung der Assistentenfunktion ab, die für das Sprachmodell bereitgestellt wird.
parameterDescriptionJson Optional. Ruft eine JSON-Beschreibung des Funktionsparameters ab, die dem Modell zur Verfügung gestellt wird, oder legt diese fest. Weitere Informationen finden Sie unter Verbrauch.

Konfiguration

Die Bindung unterstützt diese Eigenschaften, die in Ihrem Code definiert sind:

Eigenschaft Beschreibung
Typ Muss AssistantSkillTriggerlauten.
Name Der Name des Triggers.
functionName Ruft den Namen der Funktion ab, die vom Assistenten aufgerufen wird, oder legt ihn fest.
functionDescription Ruft die Beschreibung der Assistenzfunktion ab, die dem LLM zur Verfügung gestellt wird
parameterDescriptionJson Optional. Ruft eine JSON-Beschreibung des Funktionsparameters ab, die dem Modell zur Verfügung gestellt wird, oder legt diese fest. Weitere Informationen finden Sie unter Verbrauch.

Vollständige Beispiele finden Sie im Abschnitt Beispiele.

Verbrauch

Wenn der JSON-Wert parameterDescriptionJson nicht angegeben wird, wird er automatisch generiert. Weitere Informationen zur Syntax dieses Objekts finden Sie in der OpenAI-Funktionsaufruf-Dokumentation.

Verbindungen

Um die Azure OpenAI-Bindungserweiterung zu verwenden, muss man eine Verbindung zu einer OpenAI-Modelldefinition angeben. Stellen Sie die OpenAI-Modellverbindung in Ihren Bindings mit einem dieser Ansätze ein:

  • Verwenden Sie die AIConnectionName Binding-Eigenschaft (bevorzugt für Azure OpenAI).
  • Setze AZURE_OPENAI_ENDPOINT und AZURE_OPENAI_KEY in den App-Einstellungen (für Azure OpenAI).
  • Setze nur Open_API_Key in den App-Einstellungen (für https://api.openai.com).

Die Art und Weise, wie Sie die Verbindung einstellen, hängt sowohl von der Modell-API als auch von der Authentifizierungsmethode ab, wie in der folgenden Tabelle angegeben:

Authentifizierungs-/Modell-API Azure OpenAI OpenAI (https://api.openai.com)
Managed Identity-Verbindung AIConnectionName Nicht unterstützt
Key Vault-Referenz AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key
App-Konfigurationsreferenz AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key
Gemeinsames Geheimnis AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key

Nutzen Sie verwaltete Identitätsbasierte Verbindungen und die Immobilie AIConnectionName .

Wenn Sie verwenden AIConnectionName, hängt der Wert dieser Eigenschaftseinstellung vom Verbindungstyp ab:

  • Managed Identity-Verbindung: Die AIConnectionName Eigenschaft wird <CONNECTION_NAME_PREFIX> von einer Gruppe von Settings geteilt, die zusammen eine identitätsbasierte Verbindung zu Azure OpenAI definieren. Weitere Informationen finden Sie unter Identitätsverbindungen definieren.
  • Key Vault-Referenz: Die AIConnectionName Property-Einstellung liefert eine Azure Key Vault-Referenz auf den Standort, an dem der API-Schlüssel zentral verwaltet wird. Weitere Informationen finden Sie unter Define Key Vault connections.
  • App Configuration Reference: Die AIConnectionName Eigenschaftseinstellung liefert eine Azure App Configuration-Referenz, die einen API-Schlüssel oder eine Key Vault-Referenz zurückgibt. Weitere Informationen finden Sie unter Azure App Configuration im Artikel über Verbindungen.
  • API-Schlüssel: Die AIConnectionName Eigenschaftseinstellung wird direkt auf App-Einstellungen umgesetzt, die den Endpunkt und den Schlüssel enthalten. Da gemeinsame Schlüssel kompromittiert werden können, sollten Sie wenn möglich verwaltete Identitätsverbindungen verwenden. Weitere Informationen finden Sie unter Zusammenhänge definieren.

Um mehr über Bindungsverbindungen zu erfahren, siehe Verbindungen verwalten in Azure Functions.

Die OpenAI-Bindungen enthalten eine AIConnectionName Eigenschaft, mit der Sie die <ConnectionNamePrefix> für die Gruppe von App-Einstellungen festlegen können, die die Verbindung zu Azure OpenAI definieren:

Einstellungsname Beschreibung
<CONNECTION_NAME_PREFIX>__endpoint Setzt das URI-Endpunkt des Azure OpenAI-Dienstes. Diese Einstellung ist immer erforderlich.
<CONNECTION_NAME_PREFIX>__clientId Legt die bestimmte vom Benutzer zugewiesene Identität fest, die beim Abrufen eines Zugriffstokens verwendet werden soll. Erfordert, dass <CONNECTION_NAME_PREFIX>__credential auf managedidentity festgelegt wird. Die Eigenschaft akzeptiert eine Client-ID, die einer vom Benutzer zugewiesenen Identität entspricht, die der Anwendung zugeordnet ist. Es ist nicht möglich, sowohl eine Ressourcen-ID als auch eine Client-ID anzugeben. Wenn Sie diese Eigenschaft nicht spezifizieren, wird die systemzugewiesene Identität verwendet. Diese Eigenschaft wird in Szenarien für die lokale Entwicklung anders verwendet, in denen credential nicht festgelegt werden darf.
<CONNECTION_NAME_PREFIX>__credential Definiert, wie ein access-Token für die Verbindung abgerufen wird. Verwenden Sie managedidentity für die Authentifizierung der verwalteten Identität. Dieser Wert ist nur gültig, wenn eine verwaltete Identität in der Hostingumgebung verfügbar ist.
<CONNECTION_NAME_PREFIX>__managedIdentityResourceId Wenn credential auf gesetzt ist managedidentity, setzen Sie diese Eigenschaft so, dass sie die Ressourcen-Identifikator angibt, die beim Erlangen eines Tokens verwendet werden soll. Die Eigenschaft akzeptiert einen Ressourcenbezeichner, der der Ressourcen-ID der benutzerdefinierten verwalteten Identität entspricht. Es ist nicht möglich, sowohl eine Ressourcen-ID als auch eine Client-ID anzugeben. Wenn Sie keines von beiden angeben, wird die systemzugewiesene Identität verwendet. Diese Eigenschaft wird in Szenarien für die lokale Entwicklung anders verwendet, in denen credential nicht festgelegt werden darf.
<CONNECTION_NAME_PREFIX>__key Setzt den gemeinsamen geheimen Schlüssel, der für den Zugriff auf den Endpunkt des Azure OpenAI-Dienstes erforderlich ist, mittels schlüsselbasierter Authentifizierung. Als Sicherheitsbest-Practice sollten Sie immer Microsoft Entra ID mit verwalteten Identitäten zur Authentifizierung verwenden.

Betrachten Sie diese Managed Identity Connection-Einstellungen, wenn Sie die Eigenschaft AIConnectionName auf myAzureOpenAIsetzen:

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

Zur Laufzeit interpretiert der Host diese Einstellungen als eine einzige myAzureOpenAI Einstellung:

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

Wenn Sie verwaltete Identitäten verwenden, fügen Sie Ihre Identität unbedingt der Cognitive Services OpenAI User Rolle hinzu.

Beim lokalen Ausführen fügen Sie diese Einstellungen der local.settings.json Projektdatei hinzu. Weitere Informationen finden Sie unter "Lokale Entwicklung mit identitätsbasierten Verbindungen".

Weitere Informationen finden Sie unter Verwenden von Anwendungseinstellungen.