Gatilho do assistente do OpenAI do Azure para Azure Functions

Importante

Atualmente, a extensão do OpenAI do Azure para Azure Functions está em versão prévia.

O gatilho do assistente do OpenAI do Azure permite que você execute seu código com base na solicitação de habilidade ou de chatbot personalizado feita a um assistente.

Para obter informações sobre os detalhes de configuração da extensão do OpenAI do Azure, confira Extensões do OpenAI do Azure para Azure Functions. Para saber mais sobre os assistentes do OpenAI do Azure, consulte API de Assistentes do OpenAI do Azure.

Observação

Referências e exemplos só são fornecidos para o modelo do Node.js v4.

Observação

Referências e exemplos só são fornecidos para o modelo do Python v2.

Observação

Embora haja suporte para ambos os modelos de processo C#, apenas exemplos de modelo de trabalho isolados são fornecidos.

Exemplo

O suporte do Go não está disponível para essa ligação no momento.

Este exemplo demonstra como criar um assistente que adiciona uma nova tarefa pendente a um banco de dados. O gatilho tem uma descrição estática de Create a new todo task usada pelo modelo. A função em si usa uma cadeia de caracteres, que representa uma nova tarefa a ser adicionada. Quando executada, a função adiciona a tarefa como um novo item pendente em um repositório de itens personalizado e retorna uma resposta do repositório.

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

Este exemplo demonstra como criar um assistente que adiciona uma nova tarefa pendente a um banco de dados. O gatilho tem uma descrição estática de Create a new todo task usada pelo modelo. A função em si usa uma cadeia de caracteres, que representa uma nova tarefa a ser adicionada. Quando executada, a função adiciona a tarefa como um novo item pendente em um repositório de itens personalizado e retorna uma resposta do repositório.

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

Este exemplo demonstra como criar um assistente que adiciona uma nova tarefa pendente a um banco de dados. O gatilho tem uma descrição estática de Create a new todo task usada pelo modelo. A função em si usa uma cadeia de caracteres, que representa uma nova tarefa a ser adicionada. Quando executada, a função adiciona a tarefa como um novo item pendente em um repositório de itens personalizado e retorna uma resposta do repositório.

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

Este exemplo demonstra como criar um assistente que adiciona uma nova tarefa pendente a um banco de dados. O gatilho tem uma descrição estática de Create a new todo task usada pelo modelo. A função em si usa uma cadeia de caracteres, que representa uma nova tarefa a ser adicionada. Quando executada, a função adiciona a tarefa como um novo item pendente em um repositório de itens personalizado e retorna uma resposta do repositório.

Aqui está o arquivo function.json para Adicionar Todo:

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

Para obter mais informações sobre as propriedades do arquivo function.json, consulte a seção Configuração.

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

Este exemplo demonstra como criar um assistente que adiciona uma nova tarefa pendente a um banco de dados. O gatilho tem uma descrição estática de Create a new todo task usada pelo modelo. A função em si usa uma cadeia de caracteres, que representa uma nova tarefa a ser adicionada. Quando executada, a função adiciona a tarefa como um novo item pendente em um repositório de itens personalizado e retorna uma resposta do repositório.

@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 o atributo AssistantSkillTrigger para definir um gatilho de assistente, que dá suporte a estes parâmetros:

Parâmetro Descrição
FunctionDescription Obtém a descrição da função de assistente, que é fornecida para o modelo.
FunctionName Opcional. Obtém ou define o nome da função chamada pelo assistente.
ParameterDescriptionJson Opcional. Obtém ou define uma descrição JSON do parâmetro de função, que é fornecido para o modelo. Para obter mais informações, confira Uso.

Anotações

A anotação AssistantSkillTrigger permite que você defina um gatilho de assistente, que dá suporte a estes parâmetros:

Elemento Descrição
nome Obtém ou define o nome da associação de entrada.
functionDescription Obtém a descrição da função de assistente, que é fornecida para o modelo.
functionName Opcional. Obtém ou define o nome da função chamada pelo assistente.
parameterDescriptionJson Opcional. Obtém ou define uma descrição JSON do parâmetro de função, que é fornecido para o modelo. Para obter mais informações, confira Uso.

Decoradores

Durante a versão prévia, defina a associação de entrada como uma associação generic_trigger do tipo assistantSkillTrigger, que dá suporte a estes parâmetros:

Parâmetro Descrição
function_description Obtém a descrição da função de assistente, que é fornecida para o modelo.
function_name Opcional. Obtém ou define o nome de uma função chamada pelo assistente.
parameterDescriptionJson Opcional. Obtém ou define uma descrição JSON do parâmetro de função, que é fornecido para o modelo. Para obter mais informações, confira Uso.

Configuração

A associação dá suporte a essas propriedades de configuração definidas no arquivo function.json.

Propriedade Descrição
tipo Deve ser AssistantSkillTrigger.
direção Deve ser in.
nome O nome do gatilho.
functionName Obtém ou define o nome da função chamada pelo assistente.
functionDescription Obtém a descrição da função de assistente, que é fornecida para o modelo de idioma.
parameterDescriptionJson Opcional. Obtém ou define uma descrição JSON do parâmetro de função, que é fornecido para o modelo. Para obter mais informações, confira Uso.

Configuração

A associação dá suporte a estas propriedades, que são definidas no código:

Propriedade Descrição
tipo Deve ser AssistantSkillTrigger.
nome O nome do gatilho.
functionName Obtém ou define o nome da função chamada pelo assistente.
functionDescription Obtém a descrição da função de assistente, que é fornecida para o LLM
parameterDescriptionJson Opcional. Obtém ou define uma descrição JSON do parâmetro de função, que é fornecido para o modelo. Para obter mais informações, confira Uso.

Consulte a Seção de exemplo para obter exemplos completos.

Uso

Quando o valor JSON parameterDescriptionJson não é fornecido, ele é gerado automaticamente. Para mais informações sobre a sintaxe desse objeto, veja a documentação de chamadas de funções do OpenAI.

Conexões

Para usar a extensão de binding Azure OpenAI, você precisa especificar uma conexão com uma definição de modelo OpenAI. Defina a conexão do modelo OpenAI nas suas ligações usando uma destas abordagens:

  • Use a AIConnectionName propriedade de binding (preferida para Azure OpenAI).
  • Configure AZURE_OPENAI_ENDPOINT e AZURE_OPENAI_KEY esteja nas configurações do app (para Azure OpenAI).
  • Defina apenas Open_API_Key nas configurações do app (para https://api.openai.com).

A forma como você configura a conexão depende tanto da API do modelo quanto do método de autenticação, conforme indicado pela tabela a seguir:

API de Autenticação/Modelo Azure OpenAI OpenAI (https://api.openai.com)
Conexão de identidade gerenciada AIConnectionName Sem suporte
Referência ao Key Vault AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key
Referência de configuração do aplicativo AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key
Segredo compartilhado AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key

Use conexões baseadas em identidade gerenciada e a propriedade AIConnectionName .

Quando você usa AIConnectionName, o valor dessa configuração de propriedade depende do tipo de conexão:

  • Conexão de identidade gerenciada: A AIConnectionName propriedade é <CONNECTION_NAME_PREFIX> compartilhada por um grupo de configurações que, juntas, definem uma conexão baseada em identidade com o Azure OpenAI. Para mais informações, veja Definir conexões de identidade.
  • Referência Key Vault: A AIConnectionName configuração de propriedade retorna uma referência ao Azure Key Vault para o local onde a chave API é mantida centralmente. Para mais informações, veja Definir conexões do Key Vault.
  • Referência de Configuração de App: A AIConnectionName configuração de propriedade retorna uma referência Configuração de Aplicativos do Azure que retorna uma chave API ou uma referência ao Key Vault. Para mais informações, veja Configuração de Aplicativos do Azure no artigo de conexões.
  • Chave API: A AIConnectionName configuração de propriedade resolve para as configurações do app contendo diretamente o endpoint e a chave. Como as chaves compartilhadas podem ser comprometidas, use conexões de identidade gerenciadas sempre que possível. Para mais informações, veja Definir conexões.

Para saber mais sobre conexões de bindings, veja Gerenciar conexões no Azure Functions.

As ligações do OpenAI incluem uma AIConnectionName propriedade que você pode usar para especificar o <ConnectionNamePrefix> grupo de configurações de aplicativos que definem a conexão com o Azure OpenAI:

Nome da configuração Descrição
<CONNECTION_NAME_PREFIX>__endpoint Define o endpoint URI do serviço Azure OpenAI. Essa configuração é sempre necessária.
<CONNECTION_NAME_PREFIX>__clientId Define a identidade específica atribuída pelo usuário a ser usada ao obter um token de acesso. Requer que <CONNECTION_NAME_PREFIX>__credential esteja definido como managedidentity. A propriedade aceita uma ID de cliente correspondente a uma identidade atribuída pelo usuário atribuída ao aplicativo. É inválido especificar uma ID de recurso e uma ID de cliente. Se você não especificar essa propriedade, a identidade atribuída ao sistema é usada. Essa propriedade é usada de forma diferente em cenários de desenvolvimento local, quando credential não puder ser definido.
<CONNECTION_NAME_PREFIX>__credential Define como um token de access é obtido para a conexão. Use managedidentity para a autenticação da identidade gerenciada. Esse valor só é válido quando uma identidade gerenciada está disponível no ambiente de hospedagem.
<CONNECTION_NAME_PREFIX>__managedIdentityResourceId Quando credential está definido como managedidentity, defina essa propriedade para especificar o Identificador de recurso a usar ao obter um token. A propriedade aceita um identificador de recurso correspondente à ID do recurso da identidade gerenciada definida pelo usuário. É inválido especificar uma ID de recurso e uma ID de cliente. Se você não especificar nenhum dos dois, a identidade atribuída pelo sistema é usada. Essa propriedade é usada de forma diferente em cenários de desenvolvimento local, quando credential não puder ser definido.
<CONNECTION_NAME_PREFIX>__key Define a chave secreta compartilhada necessária para acessar o endpoint do serviço Azure OpenAI usando autenticação baseada em chaves. Como melhor prática de segurança, sempre use o Microsoft Entra ID com identidades gerenciadas para autenticação.

Considere essas configurações de conexão de identidade gerenciada ao definir a AIConnectionName propriedade para myAzureOpenAI:

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

Em tempo de execução, o host interpreta essas configurações como uma única myAzureOpenAI configuração:

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

Ao usar identidades gerenciadas, certifique-se de adicionar sua identidade ao papel de Usuário OpenAI de Serviços Cognitivos .

Ao rodar localmente, adicione essas configurações ao arquivolocal.settings.json projeto. Para obter mais informações, consulte Desenvolvimento local com conexões baseadas em identidade.

Para obter mais informações, confira Trabalhar com configurações de aplicativo.