Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Importante
La extensión de Azure OpenAI para Azure Functions está actualmente en versión preliminar.
El asistente de Azure OpenAI genera un enlace de salida que permite crear un nuevo bot de chat del asistente a partir de la ejecución del código de la función.
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 PUT crea un nuevo bot de chat del asistente con el identificador especificado. La respuesta a la solicitud se devuelve en la respuesta HTTP.
/// <summary>
/// HTTP PUT function that creates a new assistant chat bot with the specified ID.
/// </summary>
[Function(nameof(CreateAssistant))]
public static async Task<CreateChatBotOutput> CreateAssistant(
[HttpTrigger(AuthorizationLevel.Function, "put", Route = "assistants/{assistantId}")] HttpRequestData req,
string assistantId)
{
string instructions =
"""
Don't make assumptions about what values to plug into functions.
Ask for clarification if a user request is ambiguous.
""";
using StreamReader reader = new(req.Body);
string request = await reader.ReadToEndAsync();
return new CreateChatBotOutput
{
HttpResponse = new ObjectResult(new { assistantId }) { StatusCode = 201 },
ChatBotCreateRequest = new AssistantCreateRequest(assistantId, instructions)
{
ChatStorageConnectionSetting = DefaultChatStorageConnectionSetting,
CollectionName = DefaultCollectionName,
},
};
}
public class CreateChatBotOutput
{
[AssistantCreateOutput()]
public AssistantCreateRequest? ChatBotCreateRequest { get; set; }
[HttpResult]
public IActionResult? HttpResponse { get; set; }
}
En este ejemplo se muestra el proceso de creación, donde la función HTTP PUT crea un nuevo bot de chat del asistente con el identificador especificado. La respuesta a la solicitud se devuelve en la respuesta HTTP.
/**
* The default storage account setting for the table storage account.
* This constant is used to specify the connection string for the table storage
* account
* where chat data will be stored.
*/
final String DEFAULT_CHATSTORAGE = "AzureWebJobsStorage";
/**
* The default collection name for the table storage account.
* This constant is used to specify the collection name for the table storage
* account
* where chat data will be stored.
*/
final String DEFAULT_COLLECTION = "ChatState";
/*
* HTTP PUT function that creates a new assistant chat bot with the specified ID.
*/
@FunctionName("CreateAssistant")
public HttpResponseMessage createAssistant(
@HttpTrigger(
name = "req",
methods = {HttpMethod.PUT},
authLevel = AuthorizationLevel.FUNCTION,
route = "assistants/{assistantId}")
HttpRequestMessage<Optional<String>> request,
@BindingName("assistantId") String assistantId,
@AssistantCreate(name = "AssistantCreate") OutputBinding<AssistantCreateRequest> message,
final ExecutionContext context) {
context.getLogger().info("Java HTTP trigger processed a request.");
String instructions = "Don't make assumptions about what values to plug into functions.\n" +
"Ask for clarification if a user request is ambiguous.";
AssistantCreateRequest assistantCreateRequest = new AssistantCreateRequest(assistantId, instructions);
assistantCreateRequest.setChatStorageConnectionSetting(DEFAULT_CHATSTORAGE);
assistantCreateRequest.setCollectionName(DEFAULT_COLLECTION);
message.setValue(assistantCreateRequest);
JSONObject response = new JSONObject();
response.put("assistantId", assistantId);
return request.createResponseBuilder(HttpStatus.CREATED)
.header("Content-Type", "application/json")
.body(response.toString())
.build();
}
En este ejemplo se muestra el proceso de creación, donde la función HTTP PUT crea un nuevo bot de chat del asistente con el identificador especificado. La respuesta a la solicitud se devuelve en la respuesta HTTP.
const { app, input, output } = require("@azure/functions");
const CHAT_STORAGE_CONNECTION_SETTING = "AzureWebJobsStorage";
const COLLECTION_NAME = "ChatState";
const chatBotCreateOutput = output.generic({
type: 'assistantCreate'
})
app.http('CreateAssistant', {
methods: ['PUT'],
route: 'assistants/{assistantId}',
authLevel: 'function',
extraOutputs: [chatBotCreateOutput],
handler: async (request, context) => {
const assistantId = request.params.assistantId
const instructions =
`
Don't make assumptions about what values to plug into functions.
Ask for clarification if a user request is ambiguous.
`
const createRequest = {
id: assistantId,
instructions: instructions,
chatStorageConnectionSetting: CHAT_STORAGE_CONNECTION_SETTING,
collectionName: COLLECTION_NAME
}
context.extraOutputs.set(chatBotCreateOutput, createRequest)
return { status: 202, jsonBody: { assistantId: assistantId } }
}
})
import { HttpRequest, InvocationContext, app, input, output } from "@azure/functions"
const CHAT_STORAGE_CONNECTION_SETTING = "AzureWebJobsStorage";
const COLLECTION_NAME = "ChatState";
const chatBotCreateOutput = output.generic({
type: 'assistantCreate'
})
app.http('CreateAssistant', {
methods: ['PUT'],
route: 'assistants/{assistantId}',
authLevel: 'function',
extraOutputs: [chatBotCreateOutput],
handler: async (request: HttpRequest, context: InvocationContext) => {
const assistantId = request.params.assistantId
const instructions =
`
Don't make assumptions about what values to plug into functions.
Ask for clarification if a user request is ambiguous.
`
const createRequest = {
id: assistantId,
instructions: instructions,
chatStorageConnectionSetting: CHAT_STORAGE_CONNECTION_SETTING,
collectionName: COLLECTION_NAME
}
context.extraOutputs.set(chatBotCreateOutput, createRequest)
return { status: 202, jsonBody: { assistantId: assistantId } }
}
})
En este ejemplo se muestra el proceso de creación, donde la función HTTP PUT crea un nuevo bot de chat del asistente con el identificador especificado. La respuesta a la solicitud se devuelve en la respuesta HTTP.
Este es el archivo function.json para Crear asistente:
{
"bindings": [
{
"authLevel": "function",
"type": "httpTrigger",
"direction": "in",
"name": "Request",
"route": "assistants/{assistantId}",
"methods": [
"put"
]
},
{
"type": "http",
"direction": "out",
"name": "Response"
},
{
"type": "assistantCreate",
"direction": "out",
"dataType": "string",
"name": "Requests"
}
]
}
Para obtener más información sobre las propiedades del archivo function.json, consulte la sección de Configuración.
{{Esto procede del comentario de código de ejemplo}}
using namespace System.Net
param($Request, $TriggerMetadata)
$assistantId = $Request.params.assistantId
$instructions = "Don't make assumptions about what values to plug into functions."
$instructions += "\nAsk for clarification if a user request is ambiguous."
$create_request = @{
"id" = $assistantId
"instructions" = $instructions
"chatStorageConnectionSetting" = "AzureWebJobsStorage"
"collectionName" = "ChatState"
}
Push-OutputBinding -Name Requests -Value (ConvertTo-Json $create_request)
Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
StatusCode = [HttpStatusCode]::Accepted
Body = (ConvertTo-Json @{ "assistantId" = $assistantId})
Headers = @{
"Content-Type" = "application/json"
}
})
En este ejemplo se muestra el proceso de creación, donde la función HTTP PUT crea un nuevo bot de chat del asistente con el identificador especificado. La respuesta a la solicitud se devuelve en la respuesta HTTP.
DEFAULT_CHAT_STORAGE_SETTING = "AzureWebJobsStorage"
DEFAULT_CHAT_COLLECTION_NAME = "ChatState"
@apis.function_name("CreateAssistant")
@apis.route(route="assistants/{assistantId}", methods=["PUT"])
@apis.assistant_create_output(arg_name="requests")
def create_assistant(
req: func.HttpRequest, requests: func.Out[str]
) -> func.HttpResponse:
assistantId = req.route_params.get("assistantId")
instructions = """
Don't make assumptions about what values to plug into functions.
Ask for clarification if a user request is ambiguous.
"""
create_request = {
"id": assistantId,
"instructions": instructions,
"chatStorageConnectionSetting": DEFAULT_CHAT_STORAGE_SETTING,
"collectionName": DEFAULT_CHAT_COLLECTION_NAME,
}
requests.set(json.dumps(create_request))
response_json = {"assistantId": assistantId}
return func.HttpResponse(
json.dumps(response_json), status_code=202, mimetype="application/json"
)
Atributos
Aplique el atributo CreateAssistant para definir un enlace de salida de creación del asistente, que admite estos parámetros:
| Parámetro | Descripción |
|---|---|
| Identificación | Identificador del asistente que se va a crear. |
| Instrucciones | Opcional. Instrucciones que se proporcionan al asistente. |
| ChatStorageConnectionSetting |
Opcional. El nombre de la sección de configuración de la configuración de la tabla para el almacenamiento de chat. El valor predeterminado es AzureWebJobsStorage. |
| CollectionName |
Opcional. Nombre de la colección de tablas para el almacenamiento de chat. El valor predeterminado es ChatState. |
anotaciones
La anotación de CreateAssistant permite definir un enlace de salida de creación del asistente, que admite estos parámetros:
| Elemento | Descripción |
|---|---|
| nombre | Obtiene o establece el nombre del enlace de salida. |
| ID | Identificador del asistente que se va a crear. |
| detalladas | Opcional. Instrucciones que se proporcionan al asistente. |
| chatStorageConnectionSetting |
Opcional. El nombre de la sección de configuración de la configuración de la tabla para el almacenamiento de chat. El valor predeterminado es AzureWebJobsStorage. |
| collectionName |
Opcional. Nombre de la colección de tablas para el almacenamiento de chat. El valor predeterminado es ChatState. |
Elementos Decorator
Durante la versión preliminar, defina el enlace de salida como un enlace generic_output_binding de tipo createAssistant, que admite estos parámetros:
| Parámetro | Descripción |
|---|---|
| arg_name | Nombre de la variable que representa el parámetro de enlace. |
| ID | Identificador del asistente que se va a crear. |
| detalladas | Opcional. Instrucciones que se proporcionan al asistente. |
| chat_storage_connection_setting |
Opcional. El nombre de la sección de configuración de la configuración de la tabla para el almacenamiento de chat. El valor predeterminado es AzureWebJobsStorage. |
| collection_name |
Opcional. Nombre de la colección de tablas para el almacenamiento de chat. El valor predeterminado es ChatState. |
Configuración
El enlace admite estas propiedades de configuración que se establecen en el archivo function.json.
| Propiedad | Descripción |
|---|---|
| tipo | Debe ser CreateAssistant. |
| dirección | Debe ser out. |
| nombre | Nombre del enlace de salida. |
| ID | Identificador del asistente que se va a crear. |
| detalladas | Opcional. Instrucciones que se proporcionan al asistente. |
| chatStorageConnectionSetting |
Opcional. El nombre de la sección de configuración de la configuración de la tabla para el almacenamiento de chat. El valor predeterminado es AzureWebJobsStorage. |
| collectionName |
Opcional. Nombre de la colección de tablas para el almacenamiento de chat. El valor predeterminado es ChatState. |
Configuración
El enlace admite estas propiedades, que se definen en el código:
| Propiedad | Descripción |
|---|---|
| ID | Identificador del asistente que se va a crear. |
| detalladas | Opcional. Instrucciones que se proporcionan al asistente. |
| chatStorageConnectionSetting |
Opcional. El nombre de la sección de configuración de la configuración de la tabla para el almacenamiento de chat. El valor predeterminado es AzureWebJobsStorage. |
| collectionName |
Opcional. Nombre de la colección de tablas para el almacenamiento de chat. El valor predeterminado es ChatState. |
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
AIConnectionNamepropiedad de binding (preferida para Azure OpenAI). - Configura
AZURE_OPENAI_ENDPOINTyAZURE_OPENAI_KEYestá en la configuración de la app (para Azure OpenAI). - Configurado solo
Open_API_Keyen la configuración de la app (parahttps://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_ENDPOINTAZURE_OPENAI_KEY |
Open_API_Key |
| Referencia de configuración de aplicaciones | AZURE_OPENAI_ENDPOINTAZURE_OPENAI_KEY |
Open_API_Key |
| Secreto compartido | AZURE_OPENAI_ENDPOINTAZURE_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
AIConnectionNamepropiedad 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
AIConnectionNameconfiguració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
AIConnectionNameconfiguració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
AIConnectionNameconfiguració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=managedidentitymyAzureOpenAI__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.