Azure AI Foundry Agent Service (Pré-visualização)
Integre facilmente os recursos do Azure AI Foundry Agent Service em seus fluxos de trabalho.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Microsoft |
| URL | https://support.microsoft.com |
| Metadados do conector | |
|---|---|
| Editora | Microsoft |
| Sítio Web | https://learn.microsoft.com/en-us/azure/ai-services/agents/ |
| Política de privacidade | https://learn.microsoft.com/en-us/legal/cognitive-services/agents/data-privacy-security |
| Categorias | IA; Inteligência de Negócios |
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Identidade gerenciada de aplicativos lógicos | Criar uma conexão usando uma identidade gerenciada do LogicApps | Apenas LOGICAPPS | Compartilhável |
| Login de usuário do Microsoft Entra ID | Login com credenciais do Microsoft Entra ID | Todas as regiões | Não compartilhável |
| Padrão [DEPRECATED] | Esta opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores. | Todas as regiões | Não compartilhável |
Identidade gerenciada de aplicativos lógicos
ID de autenticação: managedIdentityAuth
Aplicável: apenas LOGICAPPS
Criar uma conexão usando uma identidade gerenciada do LogicApps
Esta é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, a conexão também será compartilhada. Para obter mais informações, consulte a Visão geral de conectores para aplicativos de tela - Power Apps | Documentos Microsoft
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Identidade gerenciada do LogicApps | managedIdentity | Entrar com uma identidade gerenciada de aplicativos lógicos | Verdade |
| Ponto de Extremidade do Projeto Azure AI | cadeia (de caracteres) | O nome do Ponto de Extremidade do Projeto Azure AI como https://{account-name}.services.ai.azure.com/api/projects/{project-name} | Verdade |
Login de usuário do Microsoft Entra ID
ID de autenticação: entraIDUserLogin
Aplicável: Todas as regiões
Login com credenciais do Microsoft Entra ID
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Ponto de Extremidade do Projeto Azure AI | cadeia (de caracteres) | O nome do Ponto de Extremidade do Projeto Azure AI como https://{account-name}.services.ai.azure.com/api/projects/{project-name} | Verdade |
Padrão [DEPRECATED]
Aplicável: Todas as regiões
Esta opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 1000 | 60 segundos |
Ações
| Comece a correr |
Comece a correr |
| Criar Execução |
Criar Execução |
| Criar thread |
Criar thread |
| Invocar agente |
Invoque o agente. |
| Listar Agentes |
Listar Agentes |
| Listar mensagens |
Listar mensagens |
| Protocolo de atividade do agente externo baseado no aplicativo |
Protocolo de atividade do agente externo baseado no aplicativo |
| Protocolo de atividade do agente externo baseado no identificador do agente |
Protocolo de atividade do agente externo baseado no identificador do agente |
Comece a correr
Comece a correr
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Versão da API
|
api-version | True | string |
Versão da API |
|
A ID do thread para o qual criar uma mensagem.
|
ThreadId | True | string |
A ID do thread para o qual criar uma mensagem. |
|
A ID da execução.
|
RunId | True | string |
A ID da execução. |
Devoluções
- Body
- getRunResponse
Criar Execução
Criar Execução
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Versão da API
|
api-version | True | string |
Versão da API |
|
A ID do thread para o qual criar uma mensagem.
|
ThreadId | True | string |
A ID do thread para o qual criar uma mensagem. |
|
assistant_id
|
assistant_id | True | string |
A ID do assistente a ser usado para executar essa execução. |
|
modelo
|
model | string |
O nome da implantação do modelo a ser usado para executar essa execução. Se fornecido, ele substitui o nome de implantação do modelo do assistente. |
|
|
instructions
|
instructions | string |
Substitui as instruções do assistente. Útil para modificar o comportamento por execução. |
|
|
additional_instructions
|
additional_instructions | string |
Acrescenta instruções adicionais no final das instruções para a execução. |
|
|
função
|
role | string |
A função da entidade que está criando a mensagem. Pode ser usuário ou assistente. «utilizador» indica que a mensagem é enviada por um utilizador real e deve ser utilizada, na maioria dos casos, para representar mensagens geradas pelo utilizador. 'assistente' indica que a mensagem é gerada pelo assistente. Use esse valor para inserir mensagens do assistente na conversa. |
|
|
conteúdo
|
content | string |
O conteúdo da mensagem. |
|
|
nome
|
name | string |
Lista de IDs de arquivo ou mensagens que podem ser usadas na execução. |
|
|
metadados
|
metadata | object |
Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. As teclas podem ter no máximo 64 caracteres e os valores podem ter, no máximo, 512 caracteres. |
|
|
nome
|
name | string |
Lista de ferramentas que podem ser usadas na execução. |
|
|
metadados
|
metadata | object |
Conjunto de 16 pares chave-valor anexados a um objeto. Teclas comprimento máximo: 64 caracteres, Valores comprimento máximo: 512 caracteres. |
|
|
temperatura
|
temperature | number |
Temperatura de amostragem (0-2). Valores mais altos (por exemplo, 0,8) aumentam a aleatoriedade, valores mais baixos (por exemplo, 0,2) tornam a produção mais determinística. |
|
|
top_p
|
top_p | number |
Amostragem de núcleo, alternativa à temperatura. 0,1 significa que as 10 maiores% massa de probabilidade são consideradas. |
|
|
fluxo
|
stream | boolean |
Se verdadeiro, retorna um fluxo de eventos durante a execução como eventos enviados pelo servidor, terminando com uma mensagem 'data: [DONE]'. |
|
|
max_prompt_tokens
|
max_prompt_tokens | integer |
O número máximo de tokens de conclusão que podem ser usados durante a execução. Se excedido, a execução termina como incompleta. |
|
|
max_completion_tokens
|
max_completion_tokens | integer |
O número máximo de tokens de conclusão que podem ser usados durante a execução. Se excedido, a execução termina como incompleta. |
|
|
truncation_strategy
|
truncation_strategy | object |
Controla como um thread é truncado antes da execução para gerenciar a janela de contexto inicial. |
|
|
tool_choice
|
tool_choice | object |
Controla qual ferramenta o modelo chama. O padrão é 'auto', permitindo que o modelo decida. Pode ser definido como 'nenhum' para desativar o uso da ferramenta. |
|
|
formato_de_resposta
|
response_format | object |
Especifica o formato de saída. A configuração { 'type': 'json_object' } habilita o modo JSON para respostas JSON válidas. |
Devoluções
- Body
- createRunResponse
Criar thread
Criar thread
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Versão da API
|
api-version | True | string |
Versão da API |
|
função
|
role | string |
A função da entidade que está criando a mensagem. Pode ser usuário ou assistente. «utilizador» indica que a mensagem é enviada por um utilizador real e deve ser utilizada, na maioria dos casos, para representar mensagens geradas pelo utilizador. 'assistente' indica que a mensagem é gerada pelo assistente. Use esse valor para inserir mensagens do assistente na conversa. |
|
|
conteúdo
|
content | string |
O conteúdo da mensagem. |
|
|
nome
|
name | string |
Lista de IDs de arquivo ou mensagens que podem ser usadas na execução. |
|
|
metadados
|
metadata | object |
Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. As teclas podem ter no máximo 64 caracteres e os valores podem ter, no máximo, 512 caracteres. |
|
|
metadados
|
metadata | object |
Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. As teclas podem ter no máximo 64 caracteres e os valores podem ter, no máximo, 512 caracteres. |
|
|
tool_resources
|
tool_resources | object |
Um conjunto de recursos que são disponibilizados para as ferramentas do assistente neste tópico. Os recursos são específicos para o tipo de ferramenta. Por exemplo, a ferramenta code_interpreter requer uma lista de IDs de arquivo, enquanto a ferramenta file_search requer uma lista de IDs de armazenamento vetorial. |
Devoluções
- Body
- createThreadResponse
Invocar agente
Invoque o agente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Versão da API
|
api-version | True | string |
Versão da API |
|
metadados
|
metadata | object |
Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos via API ou o painel. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres. |
|
|
utilizador
|
user | string |
Um identificador exclusivo que representa seu usuário final, que pode ajudar a OpenAI a monitorar e detetar abusos. Mais informações. |
|
|
top_logprobs
|
top_logprobs | integer |
Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis de serem retornados em cada posição de token, cada um com uma probabilidade em log associada. |
|
|
previous_response_id
|
previous_response_id | string |
O ID único da resposta anterior dada ao modelo. Use isso para criar conversas de vários turnos. Saiba mais sobre o estado da conversação. |
|
|
em segundo plano
|
background | boolean |
Se a resposta do modelo deve ser executada em segundo plano. Mais informações. |
|
|
max_output_tokens
|
max_output_tokens | integer |
Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio. |
|
|
max_tool_calls
|
max_tool_calls | integer |
O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. |
|
|
tipo
|
type | True | string |
Um objeto que especifica o formato que o modelo deve produzir. A configuração O formato padrão é Não recomendado para gpt-4o e modelos mais recentes: Configurar para |
|
tipo
|
type | True | string |
Uma ferramenta que pode ser usada para gerar uma resposta. |
|
tool_choice
|
tool_choice |
Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o |
||
|
id
|
id | True | string |
O identificador exclusivo do modelo de prompt a ser usado. |
|
versão
|
version | string |
Versão opcional do modelo de prompt. |
|
|
variables
|
variables | object |
Mapa opcional de valores para substituir variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros tipos de entrada de resposta, como imagens ou arquivos. |
|
|
truncation
|
truncation | string |
A estratégia de truncamento a ser usada para a resposta do modelo.
|
|
|
dados introduzidos
|
input |
Entradas de texto, imagem ou arquivo no modelo, usadas para gerar uma resposta. Saiba mais: |
||
|
include
|
include | string |
Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Os valores atualmente suportados são:
|
|
|
chamadas_de_ferramentas_em_paralelo
|
parallel_tool_calls | boolean |
Se deve permitir que o modelo execute chamadas de ferramenta em paralelo. |
|
|
armazenar
|
store | boolean |
Se a resposta do modelo gerado deve ser armazenada para recuperação posterior via API. |
|
|
instructions
|
instructions | string |
Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao usar em conjunto com |
|
|
tipo
|
type | True | string | |
|
nome
|
name | True | string |
O nome do agente. |
|
versão
|
version | True | string |
O identificador de versão do agente. |
Devoluções
- Body
- OpenAI.Response
Listar Agentes
Listar Agentes
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Versão da API
|
api-version | True | string |
Versão da API |
Devoluções
- Body
- listAgentsResponse
Listar mensagens
Listar mensagens
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Versão da API
|
api-version | True | string |
Versão da API |
|
A ID do thread para o qual criar uma mensagem.
|
ThreadId | True | string |
A ID do thread para o qual criar uma mensagem. |
Devoluções
- Body
- listMessageResponse
Protocolo de atividade do agente externo baseado no aplicativo
Protocolo de atividade do agente externo baseado no aplicativo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aplicação do agente.
|
MyApplication | True | string |
Aplicação do agente. |
|
|
object |
Devoluções
- response
- object
Protocolo de atividade do agente externo baseado no identificador do agente
Protocolo de atividade do agente externo baseado no identificador do agente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
A ID do agente para o qual enviar uma mensagem.
|
AgentId | True | string |
A ID do agente para o qual enviar uma mensagem. |
|
|
object |
Devoluções
- response
- object
Definições
listAgentsResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
objecto
|
object | string |
Detalhes do tipo de objeto de resposta. |
|
dados
|
data | array of Data |
A lista de mensagens retornadas pelo serviço. |
|
first_id
|
first_id | string |
Detalhes do primeiro id. |
|
last_id
|
last_id | string |
Detalhes do último id. |
|
tem_mais
|
has_more | boolean |
Diz se há mais agentes. |
createThreadResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
O identificador, que pode ser referenciado em pontos de extremidade de API. |
|
objecto
|
object | string |
O tipo de objeto, que é sempre thread. |
|
criado_em
|
created_at | integer |
O carimbo de data/hora do Unix (em segundos) para quando o thread foi criado. |
|
metadados
|
metadata | object |
Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado. As teclas podem ter no máximo 64 caracteres e os valores podem ter, no máximo, 512 caracteres. |
createRunResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
O identificador, que pode ser referenciado em pontos de extremidade de API. |
|
objecto
|
object | string |
O tipo de objeto, que é sempre thread.run. |
|
criado_em
|
created_at | integer |
O carimbo de data/hora do Unix (em segundos) para quando a execução foi criada. |
|
thread_id
|
thread_id | string |
A ID do thread que foi executado como parte desta execução. |
|
assistant_id
|
assistant_id | string |
O ID do assistente usado para a execução desta execução. |
|
estado
|
status | string |
O status da execução, que pode ser enfileirada, in_progress, requires_action, cancelando, cancelada, falhada, concluída ou expirada. |
|
required_action
|
required_action | object |
Detalhes sobre a ação necessária para continuar a execução. Será nulo se nenhuma ação for necessária. |
|
último_erro
|
last_error | object |
O último erro associado a esta execução. Será nulo se não houver erros. |
|
expira_em
|
expires_at | integer |
O carimbo de data/hora do Unix (em segundos) para quando a execução expirará. |
|
started_at
|
started_at | integer |
O carimbo de data/hora do Unix (em segundos) para quando a execução foi iniciada. |
|
cancelado_em
|
cancelled_at | integer |
O carimbo de data/hora Unix (em segundos) para quando a execução foi cancelada. |
|
falhou_em
|
failed_at | integer |
O carimbo de data/hora do Unix (em segundos) para quando a execução falhou. |
|
concluído_em
|
completed_at | integer |
O carimbo de data/hora do Unix (em segundos) para quando a execução foi concluída. |
|
modelo
|
model | string |
O nome de implantação do modelo que o assistente usou para essa execução. |
|
instructions
|
instructions | string |
As instruções que o assistente usou para esta execução. |
|
Ferramentas
|
tools | array of tools |
A lista de ferramentas que o assistente usou para esta execução. |
|
identificadores_de_arquivo
|
file_ids | array of fileIds |
A lista de IDs de arquivo que o assistente usou para essa execução. |
|
metadados
|
metadata | object |
Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. As teclas podem ter no máximo 64 caracteres e os valores podem ter, no máximo, 512 caracteres. |
|
tool_choice
|
tool_choice | object |
Controla qual (se houver) ferramenta é chamada pelo modelo. "Nenhum" significa que o modelo não chama nenhuma ferramenta e, em vez disso, gera uma mensagem. «Auto» significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ferramenta. Especificar uma ferramenta como {'type': 'file_search'} ou {'type': 'function', 'function': {'name': 'my_function'}} força o modelo a chamar essa ferramenta. |
|
max_prompt_tokens
|
max_prompt_tokens | number |
O número máximo de tokens de prompt especificado para ter sido usado ao longo da execução. |
|
max_completion_tokens
|
max_completion_tokens | number |
O número máximo de tokens de conclusão especificado para ter sido usado ao longo da execução. |
|
utilização
|
usage | object |
Estatísticas de utilização relacionadas com a execução. Esse valor será nulo se a execução não estiver em um estado terminal (por exemplo, in_progress, enfileirada). |
|
truncation_strategy
|
truncation_strategy | object |
Controla como um thread é truncado antes da execução. |
|
formato_de_resposta
|
response_format | string |
O formato que o modelo deve produzir. Compatível com GPT-4 Turbo e todos os modelos GPT-3.5 Turbo desde gpt-3.5-turbo-1106. |
getRunResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
O identificador, que pode ser referenciado em pontos de extremidade de API. |
|
objecto
|
object | string |
O tipo de objeto, que é sempre thread.run. |
|
criado_em
|
created_at | integer |
O carimbo de data/hora do Unix (em segundos) para quando a execução foi criada. |
|
thread_id
|
thread_id | string |
A ID do thread que foi executado como parte desta execução. |
|
assistant_id
|
assistant_id | string |
O ID do assistente usado para a execução desta execução. |
|
estado
|
status | string |
O status da execução, que pode ser enfileirada, in_progress, requires_action, cancelando, cancelada, falhada, concluída ou expirada. |
|
required_action
|
required_action | object |
Detalhes sobre a ação necessária para continuar a execução. Será nulo se nenhuma ação for necessária. |
|
último_erro
|
last_error | object |
O último erro associado a esta execução. Será nulo se não houver erros. |
|
expira_em
|
expires_at | integer |
O carimbo de data/hora do Unix (em segundos) para quando a execução expirará. |
|
started_at
|
started_at | integer |
O carimbo de data/hora do Unix (em segundos) para quando a execução foi iniciada. |
|
cancelado_em
|
cancelled_at | integer |
O carimbo de data/hora Unix (em segundos) para quando a execução foi cancelada. |
|
falhou_em
|
failed_at | integer |
O carimbo de data/hora do Unix (em segundos) para quando a execução falhou. |
|
concluído_em
|
completed_at | integer |
O carimbo de data/hora do Unix (em segundos) para quando a execução foi concluída. |
|
modelo
|
model | string |
O nome de implantação do modelo que o assistente usou para essa execução. |
|
instructions
|
instructions | string |
As instruções que o assistente usou para esta execução. |
|
Ferramentas
|
tools | array of tools |
A lista de ferramentas que o assistente usou para esta execução. |
|
identificadores_de_arquivo
|
file_ids | array of fileIds |
A lista de IDs de arquivo que o assistente usou para essa execução. |
|
metadados
|
metadata | object |
Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. As teclas podem ter no máximo 64 caracteres e os valores podem ter, no máximo, 512 caracteres. |
|
tool_choice
|
tool_choice | object |
Controla qual (se houver) ferramenta é chamada pelo modelo. "Nenhum" significa que o modelo não chama nenhuma ferramenta e, em vez disso, gera uma mensagem. «Auto» significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ferramenta. Especificar uma ferramenta como {'type': 'file_search'} ou {'type': 'function', 'function': {'name': 'my_function'}} força o modelo a chamar essa ferramenta. |
|
max_prompt_tokens
|
max_prompt_tokens | number |
O número máximo de tokens de prompt especificado para ter sido usado ao longo da execução. |
|
max_completion_tokens
|
max_completion_tokens | number |
O número máximo de tokens de conclusão especificado para ter sido usado ao longo da execução. |
|
utilização
|
usage | object |
Estatísticas de utilização relacionadas com a execução. Esse valor será nulo se a execução não estiver em um estado terminal (por exemplo, in_progress, enfileirada). |
|
truncation_strategy
|
truncation_strategy | object |
Controla como um thread é truncado antes da execução. |
|
formato_de_resposta
|
response_format | string |
O formato que o modelo deve produzir. Compatível com GPT-4 Turbo e todos os modelos GPT-3.5 Turbo desde gpt-3.5-turbo-1106. |
listMessageResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
objecto
|
object | string |
Detalhes do tipo de objeto de resposta |
|
dados
|
data | array of Data |
A lista de mensagens retornadas pelo serviço. |
|
first_id
|
first_id | string |
Detalhes do primeiro id |
|
last_id
|
last_id | string |
Detalhes do último id |
|
tem_mais
|
has_more | boolean |
Informa se há mais agentes |
Data
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
O identificador, que pode ser referenciado em pontos de extremidade de API. |
|
objecto
|
object | string |
O tipo de objeto, que é sempre assistente. |
|
criado_em
|
created_at | integer |
O carimbo de data/hora Unix (em segundos) para quando o assistente foi criado. |
|
nome
|
name | string |
O nome do assistente. O comprimento máximo é de 256 caracteres. |
|
descrição
|
description | string |
A descrição do assistente. O comprimento máximo é de 512 caracteres. |
|
modelo
|
model | string |
Nome do nome de implantação do modelo a ser usado. |
|
instructions
|
instructions | string |
As instruções do sistema que o assistente usa. O comprimento máximo é de 32768 caracteres. |
|
Ferramentas
|
tools | array of tools |
Uma lista de ferramentas ativadas no assistente. Pode haver um máximo de 128 ferramentas por assistente. As ferramentas podem ser do tipo code_interpreter ou função. Uma descrição de função pode ter no máximo 1.024 caracteres. |
|
metadados
|
metadata | object |
Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Útil para armazenar informações adicionais em um formato estruturado. As teclas podem ter no máximo 64 caracteres e os valores podem ter, no máximo, 512 caracteres. |
|
temperatura
|
temperature | number |
O padrão é 1. Determina a temperatura de amostragem a utilizar, entre 0 e 2. Valores mais altos como 0,8 tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. |
|
top_p
|
top_p | number |
O padrão é 1. Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com a massa de probabilidade top_p. Assim, 0,1 significa que apenas os tokens que compõem a massa de probabilidade superior de 10% são considerados. |
|
formato_de_resposta
|
response_format | object |
Especifica o formato que o modelo deve produzir. Definir este parâmetro como { 'type': 'json_object' } habilita o modo JSON, garantindo que a mensagem seja JSON válida. |
|
tool_resources
|
tool_resources | object |
Um conjunto de recursos que são usados pelas ferramentas do assistente. Os recursos são específicos para o tipo de ferramenta. Por exemplo, a ferramenta code_interpreter requer uma lista de IDs de arquivo, enquanto a ferramenta file_search requer uma lista de IDs de armazenamento vetorial. |
OpenAI.ServiceTier
Especifica o tipo de processamento usado para atender à solicitação.
- Se definido como 'auto', a solicitação será processada com a camada de serviço configurada nas configurações do projeto. A menos que configurado de outra forma, o projeto usará 'default'.
- Se definido como 'padrão', a solicitação será processada com o preço e o desempenho padrão para o modelo selecionado.
- Se definido como 'flex' ou 'priority', a solicitação será processada com a camada de serviço correspondente. Entre em contato com o departamento de vendas para saber mais sobre o processamento prioritário.
- Quando não está definido, o comportamento padrão é 'auto'.
Quando o service_tier parâmetro é definido, o corpo da resposta incluirá o service_tier valor com base no modo de processamento realmente usado para atender à solicitação. Esse valor de resposta pode ser diferente do valor definido no parâmetro.
Especifica o tipo de processamento usado para atender à solicitação.
- Se definido como 'auto', a solicitação será processada com a camada de serviço configurada nas configurações do projeto. A menos que configurado de outra forma, o projeto usará 'default'.
- Se definido como 'padrão', a solicitação será processada com o preço e o desempenho padrão para o modelo selecionado.
- Se definido como 'flex' ou 'priority', a solicitação será processada com a camada de serviço correspondente. Entre em contato com o departamento de vendas para saber mais sobre o processamento prioritário.
- Quando não está definido, o comportamento padrão é 'auto'.
Quando o service_tier parâmetro é definido, o corpo da resposta incluirá o service_tier valor com base no modo de processamento realmente usado para atender à solicitação. Esse valor de resposta pode ser diferente do valor definido no parâmetro.
OpenAI.Reasoning
Apenas modelos da série O
Opções de configuração para modelos de raciocínio.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
effort
|
effort | string | |
|
resumo
|
summary | string |
Um resumo do raciocínio realizado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo.
Um de |
|
generate_summary
|
generate_summary | string |
Preterido: use Um resumo do raciocínio realizado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo.
Um de |
Configuração do formato de texto da resposta OpenAI (OpenAI.ResponseTextFormatConfiguration)
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
type | OpenAI.ResponseTextFormatConfigurationType |
Um objeto que especifica o formato que o modelo deve produzir. A configuração O formato padrão é Não recomendado para gpt-4o e modelos mais recentes: Configurar para |
OpenAI.ResponseTextFormatConfigurationType
Um objeto que especifica o formato que o modelo deve produzir.
A configuração { "type": "json_schema" } habilita saídas estruturadas, o que garante que o modelo corresponda ao esquema JSON fornecido. Saiba mais no guia Saídas estruturadas.
O formato padrão é { "type": "text" } sem opções adicionais.
Não recomendado para gpt-4o e modelos mais recentes:
Configurar para { "type": "json_object" } ativa o modo JSON antigo, o que garante que a mensagem gerada pelo modelo seja JSON válido. O uso json_schema é preferível para modelos que o suportam.
Um objeto que especifica o formato que o modelo deve produzir.
A configuração { "type": "json_schema" } habilita saídas estruturadas, o que garante que o modelo corresponda ao esquema JSON fornecido. Saiba mais no guia Saídas estruturadas.
O formato padrão é { "type": "text" } sem opções adicionais.
Não recomendado para gpt-4o e modelos mais recentes:
Configurar para { "type": "json_object" } ativa o modo JSON antigo, o que garante que a mensagem gerada pelo modelo seja JSON válido. O uso json_schema é preferível para modelos que o suportam.
OpenAI.Tool
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
type | OpenAI.ToolType |
Uma ferramenta que pode ser usada para gerar uma resposta. |
OpenAI.ToolType
Uma ferramenta que pode ser usada para gerar uma resposta.
Uma ferramenta que pode ser usada para gerar uma resposta.
OpenAI.Prompt
Referência a um modelo de prompt e as suas variáveis. Mais informações.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
O identificador exclusivo do modelo de prompt a ser usado. |
|
versão
|
version | string |
Versão opcional do modelo de prompt. |
|
variables
|
variables | OpenAI.ResponsePromptVariables |
Mapa opcional de valores para substituir variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros tipos de entrada de resposta, como imagens ou arquivos. |
OpenAI.Response
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
metadados
|
metadata | object |
Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos via API ou o painel. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres. |
|
temperatura
|
temperature | float |
Qual a temperatura de amostragem a utilizar, entre 0 e 2. Valores mais altos como 0,8 tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística.
Geralmente, recomendamos alterar isto ou |
|
top_p
|
top_p | float |
Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com a massa de probabilidade top_p. Assim, 0,1 significa que apenas os tokens que compõem a massa de probabilidade superior de 10% são considerados. Geralmente, recomendamos alterar isto ou |
|
utilizador
|
user | string |
Um identificador exclusivo que representa seu usuário final, que pode ajudar a OpenAI a monitorar e detetar abusos. Mais informações. |
|
nível_de_serviço
|
service_tier | OpenAI.ServiceTier |
Especifica o tipo de processamento usado para atender à solicitação.
Quando o |
|
top_logprobs
|
top_logprobs | integer |
Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis de serem retornados em cada posição de token, cada um com uma probabilidade em log associada. |
|
previous_response_id
|
previous_response_id | string |
O ID único da resposta anterior dada ao modelo. Use isso para criar conversas de vários turnos. Saiba mais sobre o estado da conversação. |
|
modelo
|
model | string |
O desdobramento do modelo a ser usado para a criação desta resposta. |
|
reasoning
|
reasoning | OpenAI.Reasoning |
Apenas modelos da série O Opções de configuração para modelos de raciocínio. |
|
em segundo plano
|
background | boolean |
Se a resposta do modelo deve ser executada em segundo plano. Mais informações. |
|
max_output_tokens
|
max_output_tokens | integer |
Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio. |
|
max_tool_calls
|
max_tool_calls | integer |
O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. |
|
format
|
text.format | OpenAI.ResponseTextFormatConfiguration | |
|
Ferramentas
|
tools | array of OpenAI.Tool |
Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o As duas categorias de ferramentas que você pode fornecer ao modelo são:
|
|
tool_choice
|
tool_choice |
Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o |
|
|
avisar
|
prompt | OpenAI.Prompt |
Referência a um modelo de prompt e as suas variáveis. Mais informações. |
|
truncation
|
truncation | string |
A estratégia de truncamento a ser usada para a resposta do modelo.
|
|
id
|
id | string |
Identificador exclusivo para esta resposta. |
|
objecto
|
object | string |
O tipo de objeto deste recurso - sempre definido como |
|
estado
|
status | string |
O estado da geração de resposta. Um dos |
|
criado_em
|
created_at | unixtime |
Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada. |
|
erro
|
error | OpenAI.ResponseError |
Um objeto de erro retornado quando o modelo não consegue gerar uma resposta. |
|
razão
|
incomplete_details.reason | string |
A razão pela qual a resposta está incompleta. |
|
output
|
output | array of OpenAI.ItemResource |
Uma matriz de itens de conteúdo gerados pelo modelo.
|
|
instructions
|
instructions |
Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao usar em conjunto com |
|
|
output_text
|
output_text | string |
Propriedade restrita ao SDK que contém a saída de texto agregada de todos os |
|
utilização
|
usage | OpenAI.ResponseUsage |
Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento de tokens de saída e o total de tokens usados. |
|
chamadas_de_ferramentas_em_paralelo
|
parallel_tool_calls | boolean |
Se deve permitir que o modelo execute chamadas de ferramenta em paralelo. |
|
id
|
conversation.id | string | |
|
agente
|
agent | AgentId |
OpenAI.ResponseError
Um objeto de erro retornado quando o modelo não consegue gerar uma resposta.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
code | OpenAI.ResponseErrorCode |
O código de erro para a resposta. |
|
mensagem
|
message | string |
Uma descrição do erro legível por humanos. |
OpenAI.ResponseErrorCode
OpenAI.ItemResource
Item de conteúdo usado para gerar uma resposta.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
type | OpenAI.ItemType | |
|
id
|
id | string |
OpenAI.ItemType
OpenAI.ResponseUsage
Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento de tokens de saída e o total de tokens usados.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
input_tokens
|
input_tokens | integer |
O número de tokens de entrada. |
|
cached_tokens
|
input_tokens_details.cached_tokens | integer |
O número de tokens que foram recuperados do cache. Saiba mais sobre o cache de prompts. |
|
output_tokens
|
output_tokens | integer |
O número de tokens de saída. |
|
fatores_de_razonamento
|
output_tokens_details.reasoning_tokens | integer |
O número de tokens de raciocínio. |
|
total_tokens
|
total_tokens | integer |
O número total de tokens usados. |
ID do agente
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
type | string | |
|
nome
|
name | string |
O nome do agente. |
|
versão
|
version | string |
O identificador de versão do agente. |
OpenAI.ResponsePromptVariables
Mapa opcional de valores para substituir variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros tipos de entrada de resposta, como imagens ou arquivos.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
object |
Mapa opcional de valores para substituir variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros tipos de entrada de resposta, como imagens ou arquivos. |
Ferramentas
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Lista de ferramentas que podem ser usadas na execução. |
fileIds
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Lista de IDs de arquivo que podem ser usados na execução. |
objecto
Este é o tipo 'objeto'.