Desencadenador del asistente de Azure OpenAI para Azure Functions

Importante

La extensión de Azure OpenAI para Azure Functions está actualmente en versión preliminar.

El desencadenador del asistente de Azure OpenAI permite ejecutar el código en función del bot de chat personalizado o la solicitud de aptitud realizada a un asistente.

Para obtener información sobre la configuración y los detalles de configuración de la extensión de Azure OpenAI, consulte Extensiones de Azure OpenAI para Azure Functions. Para más información sobre los asistentes de Azure OpenAI, consulte API Azure OpenAI Assistants.

Nota:

Las referencias y ejemplos solo se proporcionan para el modelo de Node.js v4.

Nota:

Las referencias y ejemplos solo se proporcionan para el modelo de Python v2.

Nota:

Aunque se admiten ambos modelos de proceso de C#, solo se proporcionan ejemplos de modelos de trabajo aislados.

Ejemplo

El soporte de Go no está disponible actualmente para esta asignación.

En este ejemplo se muestra cómo crear un asistente que agrega una nueva tarea de tareas pendientes a una base de datos. El desencadenador tiene una descripción estática de Create a new todo task que usa el modelo. La propia función toma una cadena, que representa una nueva tarea que se va a agregar. Cuando se ejecuta, la función agrega la tarea como un nuevo elemento de tareas pendientes en un almacén de elementos personalizado y devuelve una respuesta del almacén.

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

En este ejemplo se muestra cómo crear un asistente que agrega una nueva tarea de tareas pendientes a una base de datos. El desencadenador tiene una descripción estática de Create a new todo task que usa el modelo. La propia función toma una cadena, que representa una nueva tarea que se va a agregar. Cuando se ejecuta, la función agrega la tarea como un nuevo elemento de tareas pendientes en un almacén de elementos personalizado y devuelve una respuesta del almacén.

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

En este ejemplo se muestra cómo crear un asistente que agrega una nueva tarea de tareas pendientes a una base de datos. El desencadenador tiene una descripción estática de Create a new todo task que usa el modelo. La propia función toma una cadena, que representa una nueva tarea que se va a agregar. Cuando se ejecuta, la función agrega la tarea como un nuevo elemento de tareas pendientes en un almacén de elementos personalizado y devuelve una respuesta del almacén.

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

En este ejemplo se muestra cómo crear un asistente que agrega una nueva tarea de tareas pendientes a una base de datos. El desencadenador tiene una descripción estática de Create a new todo task que usa el modelo. La propia función toma una cadena, que representa una nueva tarea que se va a agregar. Cuando se ejecuta, la función agrega la tarea como un nuevo elemento de tareas pendientes en un almacén de elementos personalizado y devuelve una respuesta del almacén.

Este es el archivo function.json para Agregar tareas pendientes:

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

Para obtener más información sobre las propiedades del archivo function.json, consulte la sección de Configuración.

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

En este ejemplo se muestra cómo crear un asistente que agrega una nueva tarea de tareas pendientes a una base de datos. El desencadenador tiene una descripción estática de Create a new todo task que usa el modelo. La propia función toma una cadena, que representa una nueva tarea que se va a agregar. Cuando se ejecuta, la función agrega la tarea como un nuevo elemento de tareas pendientes en un almacén de elementos personalizado y devuelve una respuesta del almacén.

@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

Atributos

Aplique el atributo AssistantSkillTrigger para definir un desencadenador del asistente, que admite estos parámetros:

Parámetro Descripción
FunctionDescription Obtiene la descripción de la función asistente, que se proporciona al modelo.
FunctionName Opcional. Obtiene o establece el nombre de la función a la que llama el asistente.
ParameterDescriptionJson Opcional. Obtiene o establece una descripción JSON del parámetro de función, que se proporciona al modelo. Para obtener más información, consulte Uso.

anotaciones

La anotación AssistantSkillTrigger permite definir un desencadenador del asistente, que admite estos parámetros:

Elemento Descripción
nombre Obtiene o establece el nombre del enlace de entrada.
functionDescription Obtiene la descripción de la función asistente, que se proporciona al modelo.
functionName Opcional. Obtiene o establece el nombre de la función a la que llama el asistente.
parameterDescriptionJson Opcional. Obtiene o establece una descripción JSON del parámetro de función, que se proporciona al modelo. Para obtener más información, consulte Uso.

Elementos Decorator

Durante la versión preliminar, defina el enlace de entrada como un enlace generic_trigger de tipo assistantSkillTrigger, que admite estos parámetros:

Parámetro Descripción
function_description Obtiene la descripción de la función asistente, que se proporciona al modelo.
function_name Opcional. Obtiene o establece el nombre de una función a la que llama el asistente.
parameterDescriptionJson Opcional. Obtiene o establece una descripción JSON del parámetro de función, que se proporciona al modelo. Para obtener más información, consulte Uso.

Configuración

El enlace admite estas propiedades de configuración que se establecen en el archivo function.json.

Propiedad Descripción
tipo Debe ser AssistantSkillTrigger.
dirección Debe ser in.
nombre El nombre del desencadenador.
functionName Obtiene o establece el nombre de la función a la que llama el asistente.
functionDescription Obtiene la descripción de la función assistant, que se proporciona al modelo de lenguaje.
parameterDescriptionJson Opcional. Obtiene o establece una descripción JSON del parámetro de función, que se proporciona al modelo. Para obtener más información, consulte Uso.

Configuración

El enlace admite estas propiedades, que se definen en el código:

Propiedad Descripción
tipo Debe ser AssistantSkillTrigger.
nombre El nombre del desencadenador.
functionName Obtiene o establece el nombre de la función a la que llama el asistente.
functionDescription Obtiene la descripción de la función asistente, que se proporciona al LLM.
parameterDescriptionJson Opcional. Obtiene o establece una descripción JSON del parámetro de función, que se proporciona al modelo. Para obtener más información, consulte Uso.

Consulte la sección de ejemplos para ver ejemplos completos.

Uso

Cuando no se proporciona el valor JSON parameterDescriptionJson, se genera automáticamente. Para más información sobre la sintaxis de este objeto, consulte la documentación de llamadas de funciones de OpenAI.

Connections

Para usar la extensión de enlace Azure OpenAI, necesitas especificar una conexión a una definición de modelo OpenAI. Establece la conexión del modelo OpenAI en tus bindings usando uno de estos enfoques:

  • Usa la AIConnectionName propiedad de binding (preferida para Azure OpenAI).
  • Configura AZURE_OPENAI_ENDPOINT y AZURE_OPENAI_KEY está en la configuración de la app (para Azure OpenAI).
  • Configurado solo Open_API_Key en la configuración de la app (para https://api.openai.com).

La forma en que se establece la conexión depende tanto de la API del modelo como del método de autenticación, como indica la siguiente tabla:

API de autenticación/modelo Azure OpenAI OpenAI (https://api.openai.com)
Conexión de identidad gestionada AIConnectionName No soportado
Referencia a Key Vault AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key
Referencia de configuración de aplicaciones AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key
Secreto compartido AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key

Utiliza conexiones gestionadas basadas en identidad y la AIConnectionName propiedad.

Cuando usas AIConnectionName, el valor de esta configuración de propiedad depende del tipo de conexión:

  • Conexión de identidad gestionada: La AIConnectionName propiedad es <CONNECTION_NAME_PREFIX> compartida por un grupo de configuraciones que en conjunto definen una conexión basada en identidad con Azure OpenAI. Para más información, véase Definir conexiones de identidad.
  • Referencia Key Vault: La AIConnectionName configuración de propiedades devuelve una referencia de Azure Key Vault a la ubicación donde se mantiene centralmente la clave API. Para más información, consulte Definir conexiones de Key Vault.
  • Referencia de configuración de la aplicación: La AIConnectionName configuración de propiedad devuelve una referencia de Azure App Configuration que devuelve una clave API o una referencia a Key Vault. Para más información, consulta Azure App Configuration en el artículo de conexiones.
  • Clave API: La AIConnectionName configuración de propiedades se resuelve a la configuración de la app que contiene directamente el endpoint y la clave. Como las claves compartidas pueden verse comprometidas, utiliza conexiones de identidad gestionadas siempre que sea posible. Para más información, véase Definir conexiones.

Para saber más sobre conexiones de bindings, consulta Gestionar conexiones en Azure Functions.

Las vinculaciones de OpenAI incluyen una AIConnectionName propiedad que puedes usar para especificar el <ConnectionNamePrefix> grupo de configuraciones de la app que definen la conexión a Azure OpenAI:

Nombre de la configuración Descripción
<CONNECTION_NAME_PREFIX>__endpoint Establece el extremo URI del servicio Azure OpenAI. Esta configuración siempre es necesaria.
<CONNECTION_NAME_PREFIX>__clientId Establece la identidad asignada por el usuario específica que se usará al obtener un token de acceso. Requiere que <CONNECTION_NAME_PREFIX>__credential se establezca en managedidentity. La propiedad acepta un identificador de cliente correspondiente a una identidad asignada por el usuario asignada a la aplicación. No es válido especificar un id. de recurso así como tampoco es válido un id. de cliente. Si no especificas esta propiedad, se utiliza la identidad asignada por el sistema. Esta propiedad se usa de forma diferente en escenarios de desarrollo locales, en los que no se debe establecer el elemento credential.
<CONNECTION_NAME_PREFIX>__credential Define cómo se obtiene un token de access para la conexión. Use managedidentity para la autenticación de identidad administrada. Este valor sólo es válido cuando existe una identidad administrada disponible en el entorno del hospedaje.
<CONNECTION_NAME_PREFIX>__managedIdentityResourceId Cuando credential se establece en managedidentity, establece esta propiedad para especificar el Identificador de recurso a usar al obtener un token. La propiedad acepta un identificador de recurso correspondiente al Id. de recurso de la identidad administrada definida por el usuario. No es válido especificar un Id. de recurso así como tampoco es válido un Id. de cliente. Si no especificas ninguno, se usa la identidad asignada por el sistema. Esta propiedad se usa de forma diferente en escenarios de desarrollo locales, en los que no se debe establecer el elemento credential.
<CONNECTION_NAME_PREFIX>__key Establece la clave secreta compartida necesaria para acceder al punto final del servicio OpenAI de Azure usando autenticación basada en claves. Como mejor práctica de seguridad, utiliza siempre Microsoft Entra ID con identidades gestionadas para la autenticación.

Considera estos ajustes de conexión de identidad gestionada cuando configures la AIConnectionName propiedad como myAzureOpenAI:

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

En tiempo de ejecución, el host interpreta estos ajustes como un solo myAzureOpenAI ajuste:

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

Cuando utilices identidades gestionadas, asegúrate de añadir tu identidad al rol de Usuario OpenAI de Servicios Cognitivos .

Al ejecutarlo localmente, añade estos ajustes al archivolocal.settings.json proyecto. Para obtener más información, consulte Desarrollo local con conexiones basadas en identidades.

Para más información, consulte Trabajar con la configuración de la aplicación.