Serviço de Agente do Azure AI Foundry (Preview)

Integre facilmente as capacidades do Serviço de Agente do Azure AI Foundry nos seus fluxos de trabalho.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Standard Todas as regiões Power Automate 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 Azure Government
     - Regiões Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Standard Todas as regiões 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)
Power Automate Standard Todas as regiões Power Automate 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
Publisher 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

O Azure AI Agent Service é um serviço totalmente gerido concebido para capacitar os programadores a construir, implementar e escalar de forma segura agentes de IA de alta qualidade e extensíveis, sem necessidade de gerir os recursos de computação e armazenamento subjacentes. O Azure AI Agent Service integra modelos, ferramentas e tecnologia e permite-lhe expandir agentes com conhecimento de fontes conectadas (como Bing Search, SharePoint, Fabric, armazenamento Azure Blob e dados licenciados) e ações usando ferramentas como Azure Logic Apps, Funções do Azure, OpenAPI 3.0 especificou ferramentas e Interpretador de Código

Pré-requisitos

Obtenha as suas credenciais

Para autenticar os seus pedidos de API, vai precisar do endpoint para os seus recursos do Azure AI Agent Service.

Para o seu recurso Azure AI Agent Service:

  1. Navegue até ao seu recurso no portal Azure.
  2. Na página do seu recurso, selecione Chaves e termine no menu de navegação da esquerda. Regista as tuas credenciais. Vais usar uma das tuas chaves e o teu endpoint.

Problemas conhecidos e limitações

  • Apenas o Azure AI Agent Service é suportado como serviço de agente com este conector Power Platform apenas para Logic Apps. Não para o Power Automate e Power Apps

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Identidade Gerenciada Criar uma conexão usando uma identidade gerenciada Apenas LOGICAPPS Compartilhável
Microsoft Entra ID Login do Utilizador Iniciar sessão 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

ID de autenticação: managedIdentityAuth

Aplicável: apenas LOGICAPPS

Criar uma conexão usando uma identidade gerenciada

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 mais informações, consulte a visão geral Connectors para aplicações canvas - Power Apps | Microsoft Docs

Nome Tipo Description Obrigatório
Identidade gerenciada managedIdentity Iniciar sessão com uma Identidade Gerida Verdade
Azure AI Project Endpoint cadeia (de caracteres) O nome do Azure AI Project Endpoint como https://{account-name}.services.ai.azure. com/api/projects/{project-name} Verdade

Login de utilizador do Microsoft Entra ID

ID de autenticação: entraIDUserLogin

Aplicável: Todas as regiões

Iniciar sessão 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
Azure AI Project Endpoint cadeia (de caracteres) O nome do Azure AI Project Endpoint 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

Nome Chamadas Período de Renovação
Chamadas de API por conexão 1000 60 segundos

Ações

Agentes de Lista (Serviço de Agentes)

Agentes de Lista do Serviço de Agentes

Ativar Agente Alojado

Ativa um endpoint de agente alojado para que possa servir pedidos.

Atualizar o Roteamento do Agente Hospedado

Atualiza o endpoint do agente hospedado para encaminhar 100 por cento do tráfego para uma versão específica do agente ativo. Versões de rascunho não podem ser alvos de roteamento.

Carregar ficheiro de sessão alojado

Carrega conteúdo bruto de ficheiros para uma sessão alojada. O tamanho máximo do ficheiro é de 50 MB.

Comece a correr

Comece a correr

Criar Agente Hospedado

Cria um agente alojado e a sua versão inicial a partir de uma imagem contentor.

Criar Execução

Criar Execução

Criar Sessão Hospedada

Cria uma sessão de agente alojada. Opcionalmente, selecione uma versão específica do agente; caso contrário, a configuração de encaminhamento do agente hospedado seleciona a versão.

Criar thread

Criar thread

Criar Versão do Agente Alojado

Cria uma nova versão do agente alojado a partir de uma imagem de contentor.

Criar Versão do Agente de Prompts

Cria uma nova versão de prompt agent usando uma implementação de modelo, instruções e ferramentas opcionais.

Desativar Agente Hospedado

Desativa um endpoint de agente hospedado sem eliminar o agente ou as suas versões.

Descarregar o Ficheiro de Sessão Alojado

Descarrega o conteúdo binário de um ficheiro a partir de uma sessão alojada.

Eliminar ficheiro de sessão alojado

Apaga um ficheiro ou diretório de uma sessão alojada.

Eliminar Sessão Alojada

Elimina uma sessão de agente alojada, termina o seu sandbox e liberta os seus recursos.

Excluir agente

Apaga permanentemente um agente e todas as suas versões. Para agentes alojados, sessões ativas causam conflito a menos que a eliminação forçada esteja ativada.

Invocar Agente Hospedado (Invocações)

Invoca um agente hospedado que expõe o protocolo Invocations. O JSON de pedido e resposta são definidos pela implementação do agente hospedado.

Invocar o Agente Hospedado (Respostas)

Invoca um agente hospedado que expõe o protocolo Responses. A ação utiliza respostas JSON que não são streaming.

Invoke Prompt Agent

Invoca um agente de prompt.

Lista de ficheiros de sessão alojados

Lista ficheiros e diretórios num caminho numa sessão hospedada.

Lista de Sessões Organizadas

Lista sessões organizadas para um agente acessíveis ao ouvinte.

Listar Agentes

Listar Agentes

Listar mensagens

Listar mensagens

Obter Agente

Recebe um agente e a sua versão mais recente.

Obter Versão Agente

Recebe uma versão específica de um agente.

Protocolo de atividade de agente externo baseado no identificador de agente com endpoint V2

Protocolo de atividade de agente externo baseado no identificador de agente com endpoint V2

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

Sessão de Receber Hospedagem

Obtém uma sessão de agente hospedada pelo seu identificador de sessão.

Versão Delete Agent

Apaga permanentemente uma versão específica do agente. Para agentes alojados, sessões ativas causam conflito a menos que a eliminação forçada esteja ativada.

Versões do Agente de Lista

Lista versões de um agente.

Agentes de Lista (Serviço de Agentes)

Agentes de Lista do Serviço de Agentes

Devoluções

Ativar Agente Alojado

Ativa um endpoint de agente alojado para que possa servir pedidos.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Atualizar o Roteamento do Agente Hospedado

Atualiza o endpoint do agente hospedado para encaminhar 100 por cento do tráfego para uma versão específica do agente ativo. Versões de rascunho não podem ser alvos de roteamento.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Versão do agente
agent_version True string

A versão ativa, sem agente de draft, que recebe tráfego do endpoint.

Devoluções

Carregar ficheiro de sessão alojado

Carrega conteúdo bruto de ficheiros para uma sessão alojada. O tamanho máximo do ficheiro é de 50 MB.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Chave de isolamento do utilizador
x-ms-user-isolation-key string

Uma chave de particionamento opcional para agentes alojados configurada com isolamento de sessão baseado em cabeçalhos. Use o mesmo valor para todas as operações da sessão. Esta chave não fornece autenticação.

ID da sessão
SessionId True string

O identificador de sessão alojado.

Caminho do arquivo
path True string

O caminho do ficheiro ou diretório na sessão alojada.

Conteúdo do ficheiro
body True binary

O conteúdo binário do ficheiro a carregar.

Devoluções

Comece a correr

Comece a correr

Parâmetros

Nome Chave Obrigatório Tipo Descrição
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

Criar Agente Hospedado

Cria um agente alojado e a sua versão inicial a partir de uma imagem contentor.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
name True string

O nome do agente hospedado.

Description
description string

Uma descrição legível para humanos do agente alojado.

Metadata
metadata object

Metadados para associar ao agente alojado.

Imagem de container
image True string

A referência completa da imagem do contentor, por exemplo, myregistry.azurecr.io/my-agent:v1.

ID de ligação ao registo
registry_connection_id string

O identificador de ligação do projeto Foundry para o registo de contentores, quando necessário.

CPU
cpu True string

O número de núcleos de CPU solicitados para o contentor agente alojado, por exemplo 1.

Memory
memory True string

A quantidade de memória solicitada para o contentor agente hospedado, por exemplo 2Gi.

Protocolo
protocol True string

O protocolo exposto pelo agente hospedado. Selecione Respostas ou Invocações.

Variáveis ambientais
environment_variables object

Variáveis de ambiente passadas para o contentor do agente hospedado.

Configuração responsável de IA
rai_config object

Configuração opcional de filtro de conteúdo responsável por IA.

Configuração da telemetria
telemetry_config object

Configuração opcional de telemetria.

Configuração da sessão
session_configuration object

Configuração opcional de sessão com agente hospedado.

Devoluções

Criar Execução

Criar Execução

Parâmetros

Nome Chave Obrigatório Tipo Descrição
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

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

Criar Sessão Hospedada

Cria uma sessão de agente alojada. Opcionalmente, selecione uma versão específica do agente; caso contrário, a configuração de encaminhamento do agente hospedado seleciona a versão.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Chave de isolamento do utilizador
x-ms-user-isolation-key string

Uma chave de particionamento opcional para agentes alojados configurada com isolamento de sessão baseado em cabeçalhos. Use o mesmo valor para todas as operações da sessão. Esta chave não fornece autenticação.

Versão do agente
agent_version string

Uma versão específica de agente alojada para a sessão. Deixe a opção em branco para usar a configuração de encaminhamento do agente hospedado.

Devoluções

Criar thread

Criar thread

Parâmetros

Nome Chave Obrigatório Tipo Descrição
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

Criar Versão do Agente Alojado

Cria uma nova versão do agente alojado a partir de uma imagem de contentor.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Description
description string

Uma descrição legível por humanos da versão do agente hospedado.

Metadata
metadata object

Metadados para associar à versão do agente alojado.

Criar como rascunho
draft boolean

Se deve criar uma versão preliminar. As versões de rascunho estão excluídas do encaminhamento e das listagens normais.

Imagem de container
image True string

A referência completa da imagem do contentor, por exemplo, myregistry.azurecr.io/my-agent:v1.

ID de ligação ao registo
registry_connection_id string

O identificador de ligação do projeto Foundry para o registo de contentores, quando necessário.

CPU
cpu True string

O número de núcleos de CPU solicitados para o contentor agente alojado, por exemplo 1.

Memory
memory True string

A quantidade de memória solicitada para o contentor agente hospedado, por exemplo 2Gi.

Protocolo
protocol True string

O protocolo exposto pelo agente hospedado. Selecione Respostas ou Invocações.

Variáveis ambientais
environment_variables object

Variáveis de ambiente passadas para o contentor do agente hospedado.

Configuração responsável de IA
rai_config object

Configuração opcional de filtro de conteúdo responsável por IA.

Configuração da telemetria
telemetry_config object

Configuração opcional de telemetria.

Configuração da sessão
session_configuration object

Configuração opcional de sessão com agente hospedado.

Devoluções

Criar Versão do Agente de Prompts

Cria uma nova versão de prompt agent usando uma implementação de modelo, instruções e ferramentas opcionais.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Description
description string

Uma descrição legível por humanos da versão do agente de prompts.

Metadata
metadata object

Metadados para associar à versão do prompt agent.

Criar como rascunho
draft boolean

Se deve criar uma versão preliminar.

Implantação do modelo
model True string

O nome de uma implementação modelo disponível no atual projeto Foundry. Os nomes diretos dos modelos Foundry suportados também podem ser introduzidos manualmente.

Instructions
instructions string

Instruções do sistema que definem o comportamento do agente de prompt.

Tools
Tools object
Escolha da ferramenta
tool_choice

Controla como o agente de prompts seleciona as ferramentas.

Temperatura
temperature float

Temperatura de amostragem entre 0 e 2.

Topo P
top_p float

Probabilidade de amostragem do núcleo entre 0 e 1.

Configuração do texto
text object

Configuração opcional de texto e saída estruturada.

Configuração de raciocínio
reasoning object

Configuração opcional de raciocínio para modelos suportados.

Competências
Skills object
Entradas estruturadas
structured_inputs object

Definições opcionais de entrada estruturada.

Arnês
harness object

Configuração opcional do chicote do agente.

Devoluções

Desativar Agente Hospedado

Desativa um endpoint de agente hospedado sem eliminar o agente ou as suas versões.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Descarregar o Ficheiro de Sessão Alojado

Descarrega o conteúdo binário de um ficheiro a partir de uma sessão alojada.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Chave de isolamento do utilizador
x-ms-user-isolation-key string

Uma chave de particionamento opcional para agentes alojados configurada com isolamento de sessão baseado em cabeçalhos. Use o mesmo valor para todas as operações da sessão. Esta chave não fornece autenticação.

ID da sessão
SessionId True string

O identificador de sessão alojado.

Caminho do arquivo
path True string

O caminho do ficheiro ou diretório na sessão alojada.

Devoluções

O conteúdo do ficheiro de sessão alojado.

Conteúdo do ficheiro
binary

Eliminar ficheiro de sessão alojado

Apaga um ficheiro ou diretório de uma sessão alojada.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Chave de isolamento do utilizador
x-ms-user-isolation-key string

Uma chave de particionamento opcional para agentes alojados configurada com isolamento de sessão baseado em cabeçalhos. Use o mesmo valor para todas as operações da sessão. Esta chave não fornece autenticação.

ID da sessão
SessionId True string

O identificador de sessão alojado.

Caminho do arquivo
path True string

O caminho do ficheiro ou diretório na sessão alojada.

Eliminar Sessão Alojada

Elimina uma sessão de agente alojada, termina o seu sandbox e liberta os seus recursos.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Chave de isolamento do utilizador
x-ms-user-isolation-key string

Uma chave de particionamento opcional para agentes alojados configurada com isolamento de sessão baseado em cabeçalhos. Use o mesmo valor para todas as operações da sessão. Esta chave não fornece autenticação.

ID da sessão
SessionId True string

O identificador de sessão alojado.

Excluir agente

Apaga permanentemente um agente e todas as suas versões. Para agentes alojados, sessões ativas causam conflito a menos que a eliminação forçada esteja ativada.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Forçar eliminação
force boolean

Para agentes alojados, elimine sessões ativas associadas ao agente ou versão.

Invocar Agente Hospedado (Invocações)

Invoca um agente hospedado que expõe o protocolo Invocations. O JSON de pedido e resposta são definidos pela implementação do agente hospedado.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

object

O payload JSON esperado pelo handler de Invocações do agente alojado.

Devoluções

response
object

Invocar o Agente Hospedado (Respostas)

Invoca um agente hospedado que expõe o protocolo Responses. A ação utiliza respostas JSON que não são streaming.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Entrada
input True

Texto, imagem, ficheiro ou entrada estruturada para o agente hospedado.

ID de resposta anterior
previous_response_id string

O identificador de resposta anterior para continuar uma interação com múltiplas voltas.

Instructions
instructions string

Instruções adicionais para esta resposta.

Resposta da loja
store boolean

Se deve guardar a resposta para recuperação posterior.

Executar em segundo plano
background boolean

Se deve correr a resposta em segundo plano.

Tokens de saída máxima
max_output_tokens integer

O número máximo de tokens de saída.

Metadata
metadata object

Metadados para associar à resposta.

Utilizador
user string

Um identificador único para o utilizador final.

Devoluções

Invoke Prompt Agent

Invoca um agente de prompt.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
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 { "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.

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 tools parâmetro para ver como especificar quais ferramentas o modelo pode chamar.

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.

  • auto: Se o contexto desta resposta e das anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para se ajustar à janela de contexto, soltando itens de entrada no meio da conversa.
  • disabled (padrão): Se uma resposta do modelo exceder o tamanho da janela de contexto de um modelo, a solicitação falhará com um erro 400.
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:

  • code_interpreter_call.outputs: Inclui as saídas da execução de código python em itens de chamada da ferramenta interpretadora de código.
  • computer_call_output.output.image_url: Inclua URLs de imagens dos resultados da chamada no computador.
  • file_search_call.results: Inclua os resultados da ferramenta de pesquisa de arquivos na chamada de pesquisa.
  • message.input_image.image_url: Inclua URLs de imagem da mensagem de entrada.
  • message.output_text.logprobs: Inclua logprobs com as mensagens do assistente.
  • reasoning.encrypted_content: Inclui uma versão criptografada de tokens de raciocínio nas saídas de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em diálogos de várias interações ao utilizar a API de Respostas em modo sem estado (como quando o parâmetro store é definido como false ou quando uma organização está inscrita no programa de retenção de dados zero).
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 previous_response_id, as instruções de uma resposta anterior não serão mantidas para a resposta seguinte. Isso simplifica a troca de mensagens do sistema (ou do desenvolvedor) em novas respostas.

ID da Conversação
id True string

ID da Conversa. Selecione 'Criar nova Conversa' para criar uma nova conversa.

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

Lista de ficheiros de sessão alojados

Lista ficheiros e diretórios num caminho numa sessão hospedada.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Chave de isolamento do utilizador
x-ms-user-isolation-key string

Uma chave de particionamento opcional para agentes alojados configurada com isolamento de sessão baseado em cabeçalhos. Use o mesmo valor para todas as operações da sessão. Esta chave não fornece autenticação.

ID da sessão
SessionId True string

O identificador de sessão alojado.

Caminho do diretório
path string

O caminho do diretório para listar. O padrão é o diretório atual da sessão.

Devoluções

Lista de Sessões Organizadas

Lista sessões organizadas para um agente acessíveis ao ouvinte.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Chave de isolamento do utilizador
x-ms-user-isolation-key string

Uma chave de particionamento opcional para agentes alojados configurada com isolamento de sessão baseado em cabeçalhos. Use o mesmo valor para todas as operações da sessão. Esta chave não fornece autenticação.

Devoluções

Listar Agentes

Listar Agentes

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Versão da API
api-version True string

Versão da API

Devoluções

Listar mensagens

Listar mensagens

Parâmetros

Nome Chave Obrigatório Tipo Descrição
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

Obter Agente

Recebe um agente e a sua versão mais recente.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Devoluções

Obter Versão Agente

Recebe uma versão específica de um agente.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Versão do agente
AgentVersion True string

O identificador de versão do agente.

Devoluções

Protocolo de atividade de agente externo baseado no identificador de agente com endpoint V2

Protocolo de atividade de agente externo baseado no identificador de agente com endpoint V2

Parâmetros

Nome Chave Obrigatório Tipo Descrição
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

Protocolo de atividade do agente externo baseado no aplicativo

Protocolo de atividade do agente externo baseado no aplicativo

Parâmetros

Nome Chave Obrigatório Tipo Descrição
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

Nome Chave Obrigatório Tipo Descrição
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

Sessão de Receber Hospedagem

Obtém uma sessão de agente hospedada pelo seu identificador de sessão.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Chave de isolamento do utilizador
x-ms-user-isolation-key string

Uma chave de particionamento opcional para agentes alojados configurada com isolamento de sessão baseado em cabeçalhos. Use o mesmo valor para todas as operações da sessão. Esta chave não fornece autenticação.

ID da sessão
SessionId True string

O identificador de sessão alojado.

Devoluções

Versão Delete Agent

Apaga permanentemente uma versão específica do agente. Para agentes alojados, sessões ativas causam conflito a menos que a eliminação forçada esteja ativada.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Versão do agente
AgentVersion True string

O identificador de versão do agente.

Forçar eliminação
force boolean

Para agentes alojados, elimine sessões ativas associadas ao agente ou versão.

Versões do Agente de Lista

Lista versões de um agente.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do agente
AgentName True string

O nome do agente.

Incluir versões preliminares
include_drafts boolean

Se deve incluir versões preliminares. O serviço exclui os drafts por defeito.

Limit
limit integer

O número máximo de versões a voltar.

Order
order string

Ordena pela created_at carimbo temporal.

Após o cursor
after string

Retorne versões após este cursor.

Cursor antes
before string

Devolver versões anteriores a este cursor.

Devoluções

Definições

listAgentsResponse

Nome Caminho Tipo Descrição
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.

listAgentsServiceResponse

Nome Caminho Tipo Descrição
dados
data array of AgentServiceData

A lista de agentes devolvidos pelo serviço.

AgentServiceData

Nome Caminho Tipo Descrição
id
id string

O identificador único do agente.

nome
name string

O nome do agente.

descrição
description string

A descrição do agente.

versão
version string

A versão do agente.

createdAt
createdAt date-time

Quando o agente foi criado.

AgentRecord

Nome Caminho Tipo Descrição
objecto
object string

O tipo de objeto.

id
id string

O identificador único do agente.

nome
name string

O nome do agente.

state
state string

O estado operacional do agente.

configuration_state
configuration_state string

O estado de configuração do agente.

state_source
state_source string

A origem do estado atual.

versions
versions AgentRecordVersions
agent_endpoint
agent_endpoint object

A configuração do endpoint para o agente.

digital_worker_type
digital_worker_type string

O tipo de trabalhador digital, quando aplicável.

instance_identity
instance_identity object

A identidade da instância do agente.

esquema
blueprint object

A identidade do projeto do agente.

blueprint_reference
blueprint_reference object

A referência do projeto para o agente.

agent_card
agent_card object

O cartão de agente, quando disponível.

AgentRecordVersions

Nome Caminho Tipo Descrição
mais recente
latest AgentVersionRecord

AgentVersionRecord

Nome Caminho Tipo Descrição
metadados
metadata object

Metadados associados à versão do agente.

objecto
object string

O tipo de objeto.

id
id string

O identificador exclusivo da versão do agente.

nome
name string

O nome do agente.

versão
version string

O identificador de versão.

descrição
description string

Uma descrição legível para humanos da versão do agente.

criado_em
created_at integer

O carimbo temporal do Unix, em segundos, quando a versão do agente foi criada.

Definição
definition object

A definição do agente.

rascunho
draft boolean

Se isto é uma versão preliminar.

estado
status string

O estado de provisionamento da versão do agente.

instance_identity
instance_identity object

A identidade da instância da versão agente.

esquema
blueprint object

A identidade do blueprint da versão do agente.

blueprint_reference
blueprint_reference object

A referência do blueprint para a versão agente.

agent_guid
agent_guid string

O identificador GUID único do agente.

AgentVersionListResponse

Nome Caminho Tipo Descrição
objecto
object string

O tipo de objeto.

dados
data array of AgentVersionRecord

A lista de versões do agente devolvida pelo serviço.

first_id
first_id string

O primeiro identificador de objeto na página.

last_id
last_id string

O último identificador de objeto na página.

tem_mais
has_more boolean

Se há mais resultados disponíveis.

HostedSession

Nome Caminho Tipo Descrição
agent_session_id
agent_session_id string

O identificador de sessão alojado.

version_indicator
version_indicator HostedSessionVersionIndicator
estado
status string

O estado atual da sessão.

criado_em
created_at integer

O carimbo temporal do Unix, em segundos, quando a sessão foi criada.

last_accessed_at
last_accessed_at integer

O carimbo temporal do Unix, em segundos, quando a sessão foi acedida pela última vez.

expira_em
expires_at integer

O carimbo temporal do Unix, em segundos, quando a sessão termina.

stopped_at
stopped_at integer

O carimbo de hora do Unix, em segundos, quando a sessão terminava, quando aplicável.

HostedSessionVersionIndicator

Nome Caminho Tipo Descrição
tipo
type string

O tipo indicador de seleção de versão.

agent_version
agent_version string

A versão agente hospedada atribuída à sessão.

HostedSessionListResponse

Nome Caminho Tipo Descrição
dados
data array of HostedSession

As sessões organizadas regressaram pelo serviço.

first_id
first_id string

O primeiro identificador de sessão hospedado na página.

last_id
last_id string

O último identificador de sessão alojado na página.

tem_mais
has_more boolean

Se há mais sessões organizadas disponíveis.

HostedSessionFileUploadResposta

Nome Caminho Tipo Descrição
caminho
path string

O caminho do ficheiro carregado.

bytes_written
bytes_written integer

O número de bytes gravados.

success
success boolean

Se o upload teve sucesso.

source_type
source_type string

O tipo de origem usado para o upload.

HostedSessionFileListResponse

Nome Caminho Tipo Descrição
caminho
path string

O caminho do diretório que estava listado.

Inscrições
entries array of HostedSessionFileEntry

Os ficheiros e diretórios no caminho solicitado.

tem_mais
has_more boolean

Se há mais inscrições disponíveis.

HostedSessionFileEntry

Nome Caminho Tipo Descrição
nome
name string

O nome do ficheiro ou diretório.

size
size integer

O tamanho do arquivo em bytes.

is_directory
is_directory boolean

Se a entrada é um diretório.

modified_time
modified_time integer

O tempo de modificação da entrada conforme reportado pela sessão anfitriã.

createThreadResponse

Nome Caminho Tipo Descrição
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

Nome Caminho Tipo Descrição
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

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

Nome Caminho Tipo Descrição
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

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

Nome Caminho Tipo Descrição
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

Nome Caminho Tipo Descrição
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 estiver definido para 'auto', o pedido será processado com o nível de serviço configurado nas definições do Project. A menos que seja configurado de outra forma, o Project 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 estiver definido para 'auto', o pedido será processado com o nível de serviço configurado nas definições do Project. A menos que seja configurado de outra forma, o Project 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.

Nome Caminho Tipo Descrição
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 auto, conciseou detailed.

generate_summary
generate_summary string

Preterido: use summary em vez disso.

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 auto, conciseou detailed.

Configuração do formato de texto da resposta OpenAI (OpenAI.ResponseTextFormatConfiguration)

Nome Caminho Tipo Descrição
tipo
type 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.

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

Nome Caminho Tipo Descrição
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.

Nome Caminho Tipo Descrição
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

Nome Caminho Tipo Descriçã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 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, mas não ambos.

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 temperature, mas não ambos.

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.

  • Se estiver definido para 'auto', o pedido será processado com o nível de serviço configurado nas definições do Project. A menos que seja configurado de outra forma, o Project 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.

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 tool_choice parâmetro.

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 tools parâmetro para ver como especificar quais ferramentas o modelo pode chamar.

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.

  • auto: Se o contexto desta resposta e das anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para se ajustar à janela de contexto, soltando itens de entrada no meio da conversa.
  • disabled (padrão): Se uma resposta do modelo exceder o tamanho da janela de contexto de um modelo, a solicitação falhará com um erro 400.
id
id string

Identificador exclusivo para esta resposta.

objecto
object string

O tipo de objeto deste recurso - sempre definido como response.

estado
status string

O estado da geração de resposta. Um dos completed, failed, in_progress, , cancelledqueued, ou incomplete.

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.

  • O comprimento e a output ordem dos itens na matriz dependem da resposta do modelo.
  • Em vez de acessar o primeiro item na output matriz e assumir que é uma assistant mensagem com o conteúdo gerado pelo modelo, você pode considerar usar a propriedade onde suportado output_text em SDKs.
instructions
instructions

Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo.

Ao usar em conjunto com previous_response_id, as instruções de uma resposta anterior não serão mantidas para a resposta seguinte. Isso simplifica a troca de mensagens do sistema (ou do desenvolvedor) em novas respostas.

output_text
output_text string

Propriedade restrita ao SDK que contém a saída de texto agregada de todos os output_text itens no output array, caso existam. Suportado nos SDKs de Python e JavaScript.

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

Conversa Id para definir a conversa para esta resposta. Se for fornecido 'criar nova conversa', uma nova conversa será iniciada com esta resposta como primeira mensagem.

agente
agent AgentId

OpenAI.ResponseError

Um objeto de erro retornado quando o modelo não consegue gerar uma resposta.

Nome Caminho Tipo Descrição
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

O código de erro para a resposta.

O código de erro para a resposta.

OpenAI.ItemResource

Item de conteúdo usado para gerar uma resposta.

Nome Caminho Tipo Descrição
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.

Nome Caminho Tipo Descrição
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

Nome Caminho Tipo Descrição
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.

Nome Caminho Tipo Descrição
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

Nome Caminho Tipo Descrição
nome
name string

Lista de ferramentas que podem ser usadas na execução.

fileIds

Nome Caminho Tipo Descrição
nome
name string

Lista de IDs de arquivo que podem ser usados na execução.

objecto

Este é o tipo 'objeto'.

binário

Este é o tipo de dados básico 'binário'.