Enlace de entrada de consulta 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 enlace de entrada de consulta del asistente de Azure OpenAI permite integrar consultas de API de Assistants en las ejecuciones de código.

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 el proceso de creación, donde la función HTTP GET que consulta el historial de conversaciones del bot de chat del asistente. La respuesta a la solicitud se devuelve en la respuesta HTTP.

/// <summary>
/// HTTP GET function that queries the conversation history of the assistant chat bot.
/// </summary>
[Function(nameof(GetChatState))]
public static IActionResult GetChatState(
   [HttpTrigger(AuthorizationLevel.Function, "get", Route = "assistants/{assistantId}")] HttpRequestData req,
   string assistantId,
   [AssistantQueryInput("{assistantId}", TimestampUtc = "{Query.timestampUTC}", ChatStorageConnectionSetting = DefaultChatStorageConnectionSetting, CollectionName = DefaultCollectionName)] AssistantState state)
{
    return new OkObjectResult(state);
}

En este ejemplo se muestra el proceso de creación, donde la función HTTP GET que consulta el historial de conversaciones del bot de chat del asistente. La respuesta a la solicitud se devuelve en la respuesta HTTP.

/*
 * HTTP GET function that queries the conversation history of the assistant chat bot.
 */   
@FunctionName("GetChatState")
public HttpResponseMessage getChatState(
    @HttpTrigger(
        name = "req",
        methods = {HttpMethod.GET}, 
        authLevel = AuthorizationLevel.FUNCTION,
        route = "assistants/{assistantId}") 
        HttpRequestMessage<Optional<String>> request,
    @BindingName("assistantId") String assistantId,        
    @AssistantQuery(name = "AssistantState", id = "{assistantId}", timestampUtc = "{Query.timestampUTC}", chatStorageConnectionSetting = DEFAULT_CHATSTORAGE, collectionName = DEFAULT_COLLECTION) AssistantState state,
    final ExecutionContext context) {
        return request.createResponseBuilder(HttpStatus.OK)
            .header("Content-Type", "application/json")
            .body(state)
            .build();
}

En este ejemplo se muestra el proceso de creación, donde la función HTTP GET que consulta el historial de conversaciones del bot de chat del asistente. La respuesta a la solicitud se devuelve en la respuesta HTTP.

const { app, input, output } = require("@azure/functions");

const chatBotQueryInput = input.generic({
    type: 'assistantQuery',
    id: '{assistantId}',
    timestampUtc: '{Query.timestampUTC}',
    chatStorageConnectionSetting: CHAT_STORAGE_CONNECTION_SETTING,
    collectionName: COLLECTION_NAME
})
app.http('GetChatState', {
    methods: ['GET'],
    route: 'assistants/{assistantId}',
    authLevel: 'function',
    extraInputs: [chatBotQueryInput],
    handler: async (_, context) => {
        const state = context.extraInputs.get(chatBotQueryInput)
        return { status: 200, jsonBody: state }
    }
})

En este ejemplo se muestra el proceso de creación, donde la función HTTP GET que consulta el historial de conversaciones del bot de chat del asistente. La respuesta a la solicitud se devuelve en la respuesta HTTP.

import { HttpRequest, InvocationContext, app, input, output } from "@azure/functions"

const chatBotQueryInput = input.generic({
    type: 'assistantQuery',
    id: '{assistantId}',
    timestampUtc: '{Query.timestampUTC}',
    chatStorageConnectionSetting: CHAT_STORAGE_CONNECTION_SETTING,
    collectionName: COLLECTION_NAME
})
app.http('GetChatState', {
    methods: ['GET'],
    route: 'assistants/{assistantId}',
    authLevel: 'function',
    extraInputs: [chatBotQueryInput],
    handler: async (_, context) => {
        const state: any = context.extraInputs.get(chatBotQueryInput)
        return { status: 200, jsonBody: state }
    }
})

En este ejemplo se muestra el proceso de creación, donde la función HTTP GET que consulta el historial de conversaciones del bot de chat del asistente. La respuesta a la solicitud se devuelve en la respuesta HTTP.

Este es el archivo function.json para Obtener estado de chat:

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "Request",
      "route": "assistants/{assistantId}",
      "methods": [
        "get"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    },
    {
      "name": "State",
      "type": "assistantQuery",
      "direction": "in",
      "dataType": "string",
      "id": "{assistantId}",
      "timestampUtc": "{Query.timestampUTC}",
      "chatStorageConnectionSetting": "AzureWebJobsStorage",
      "collectionName": "ChatState"
    }
  ]
}

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($Request, $TriggerMetadata, $State)

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

En este ejemplo se muestra el proceso de creación, donde la función HTTP GET que consulta el historial de conversaciones del bot de chat del asistente. La respuesta a la solicitud se devuelve en la respuesta HTTP.

@apis.function_name("GetChatState")
@apis.route(route="assistants/{assistantId}", methods=["GET"])
@apis.assistant_query_input(
    arg_name="state",
    id="{assistantId}",
    timestamp_utc="{Query.timestampUTC}",
    chat_storage_connection_setting=DEFAULT_CHAT_STORAGE_SETTING,
    collection_name=DEFAULT_CHAT_COLLECTION_NAME,
)
def get_chat_state(req: func.HttpRequest, state: str) -> func.HttpResponse:
    return func.HttpResponse(state, status_code=200, mimetype="application/json")

Atributos

Aplique el atributo AssistantQuery para definir un enlace de entrada de consulta del asistente, que admite estos parámetros:

Parámetro Descripción
Identificación Obtiene el identificador del asistente que se va a consultar.
Marca de tiempoUtc Opcional. Obtiene o establece la marca de tiempo del mensaje más antiguo del historial de chat que se va a capturar. La marca de tiempo debe estar en formato ISO 8601; por ejemplo, 2023-08-01T00:00:00Z.

anotaciones

La anotación assistantQuery permite definir un enlace de entrada de consulta del asistente, que admite estos parámetros:

Elemento Descripción
nombre Obtiene o establece el nombre del enlace de entrada.
ID Obtiene el identificador del asistente que se va a consultar.
timeStampUtc Opcional. Obtiene o establece la marca de tiempo del mensaje más antiguo del historial de chat que se va a capturar. La marca de tiempo debe estar en formato ISO 8601; por ejemplo, 2023-08-01T00:00:00Z.

Elementos Decorator

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

Parámetro Descripción
arg_name Nombre de la variable que representa el parámetro de enlace.
ID Obtiene el identificador del asistente que se va a consultar.
time_stamp_utc Opcional. Obtiene o establece la marca de tiempo del mensaje más antiguo del historial de chat que se va a capturar. La marca de tiempo debe estar en formato ISO 8601; por ejemplo, 2023-08-01T00:00:00Z.

Configuración

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

Propiedad Descripción
tipo Debe ser assistantQuery.
dirección Debe ser in.
nombre Nombre del enlace de entrada.
ID Obtiene el identificador del asistente que se va a consultar.
timeStampUtc Opcional. Obtiene o establece la marca de tiempo del mensaje más antiguo del historial de chat que se va a capturar. La marca de tiempo debe estar en formato ISO 8601; por ejemplo, 2023-08-01T00:00:00Z.

Configuración

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

Propiedad Descripción
ID Obtiene el identificador del asistente que se va a consultar.
timeStampUtc Opcional. Obtiene o establece la marca de tiempo del mensaje más antiguo del historial de chat que se va a capturar. La marca de tiempo debe estar en formato ISO 8601; por ejemplo, 2023-08-01T00:00:00Z.

Uso

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

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.