Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Importante
Atualmente, a extensão do OpenAI do Azure para Azure Functions está em versão prévia.
A associação de saída de criação do assistente do OpenAI do Azure permite que você crie um novo chatbot assistente a partir da execução do código de função.
Para obter informações sobre os detalhes de configuração da extensão do OpenAI do Azure, consulte 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 o processo de criação, em que a função HTTP PUT que cria um novo chatbot assistente com a ID especificada. A resposta ao prompt é retornada na resposta 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; }
}
Este exemplo demonstra o processo de criação, em que a função HTTP PUT que cria um novo chatbot assistente com a ID especificada. A resposta ao prompt é retornada na resposta 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();
}
Este exemplo demonstra o processo de criação, em que a função HTTP PUT que cria um novo chatbot assistente com a ID especificada. A resposta ao prompt é retornada na resposta 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 } }
}
})
Este exemplo demonstra o processo de criação, em que a função HTTP PUT que cria um novo chatbot assistente com a ID especificada. A resposta ao prompt é retornada na resposta HTTP.
Aqui está o arquivo function.json para o Create Assistant:
{
"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 obter mais informações sobre as propriedades do arquivo function.json, consulte a seção Configuração.
{{Isso vem do comentário do código de exemplo}}
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"
}
})
Este exemplo demonstra o processo de criação, em que a função HTTP PUT que cria um novo chatbot assistente com a ID especificada. A resposta ao prompt é retornada na resposta 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 o atributo CreateAssistant para definir uma associação de saída de criação do assistente, que dá suporte a esses parâmetros:
| Parâmetro | Descrição |
|---|---|
| Id | O identificador do assistente a ser criado. |
| Instruções | Opcional. As instruções fornecidas ao assistente a serem seguidas. |
| ChatStorageConnectionSetting |
Opcional. O nome da seção de configuração das configurações da tabela para o armazenamento de chat. O valor padrão é AzureWebJobsStorage. |
| CollectionName |
Opcional. O nome da coleção de tabelas para armazenamento de chat. O valor padrão é ChatState. |
Anotações
A anotação CreateAssistant permite que você defina uma associação de saída de criação do assistente, que dá suporte a esses parâmetros:
| Elemento | Descrição |
|---|---|
| nome | Obtém ou define o nome da associação de saída. |
| id | O identificador do assistente a ser criado. |
| instruções | Opcional. As instruções fornecidas ao assistente a serem seguidas. |
| chatStorageConnectionSetting |
Opcional. O nome da seção de configuração das configurações da tabela para o armazenamento de chat. O valor padrão é AzureWebJobsStorage. |
| collectionName |
Opcional. O nome da coleção de tabelas para armazenamento de chat. O valor padrão é ChatState. |
Decoradores
Durante a versão prévia, defina a associação de saída como uma associação generic_output_binding do tipo createAssistant, que dá suporte a esses parâmetros:
| Parâmetro | Descrição |
|---|---|
| arg_name | O nome da variável que representa o parâmetro de associação. |
| id | O identificador do assistente a ser criado. |
| instruções | Opcional. As instruções fornecidas ao assistente a serem seguidas. |
| chat_storage_connection_setting |
Opcional. O nome da seção de configuração das configurações da tabela para o armazenamento de chat. O valor padrão é AzureWebJobsStorage. |
| collection_name |
Opcional. O nome da coleção de tabelas para armazenamento de chat. O valor padrão é ChatState. |
Configuração
A associação dá suporte a essas propriedades de configuração definidas no arquivo function.json.
| Propriedade | Descrição |
|---|---|
| tipo | Deve ser CreateAssistant. |
| direção | Deve ser out. |
| nome | O nome da associação de saída. |
| id | O identificador do assistente a ser criado. |
| instruções | Opcional. As instruções fornecidas ao assistente a serem seguidas. |
| chatStorageConnectionSetting |
Opcional. O nome da seção de configuração das configurações da tabela para o armazenamento de chat. O valor padrão é AzureWebJobsStorage. |
| collectionName |
Opcional. O nome da coleção de tabelas para armazenamento de chat. O valor padrão é ChatState. |
Configuração
A associação dá suporte a estas propriedades, que são definidas no código:
| Propriedade | Descrição |
|---|---|
| id | O identificador do assistente a ser criado. |
| instruções | Opcional. As instruções fornecidas ao assistente a serem seguidas. |
| chatStorageConnectionSetting |
Opcional. O nome da seção de configuração das configurações da tabela para o armazenamento de chat. O valor padrão é AzureWebJobsStorage. |
| collectionName |
Opcional. O nome da coleção de tabelas para armazenamento de chat. O valor padrão é ChatState. |
Uso
Consulte a Seção de exemplo para obter exemplos completos.
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
AIConnectionNamepropriedade de binding (preferida para Azure OpenAI). - Configure
AZURE_OPENAI_ENDPOINTeAZURE_OPENAI_KEYesteja nas configurações do app (para Azure OpenAI). - Defina apenas
Open_API_Keynas configurações do app (parahttps://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_ENDPOINTAZURE_OPENAI_KEY |
Open_API_Key |
| Referência de configuração do aplicativo | AZURE_OPENAI_ENDPOINTAZURE_OPENAI_KEY |
Open_API_Key |
| Segredo compartilhado | AZURE_OPENAI_ENDPOINTAZURE_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
AIConnectionNamepropriedade é<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
AIConnectionNameconfiguraçã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
AIConnectionNameconfiguraçã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
AIConnectionNameconfiguraçã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=managedidentitymyAzureOpenAI__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.