Microsoft Foundry - agentes

Versão da API: v1

Server:{endpoint} — Microsoft Foundry

Variáveis de servidor:

Variable	Default	Description
ponto de extremidade		Ponto de extremidade de Project de pesquisa no formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Se você tiver apenas um Project no Hub de Fundiário ou para direcionar o Project padrão em seu Hub, use o formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"

Authentication

OAuth2Auth (OAuth 2.0)

Fluxo: implícito

URL de autorização:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos:

https://ai.azure.com/.default

Requisitos de segurança

Todos os endpoints requerem OAuth2Auth (escopos: https://ai.azure.com/.default).

Agentes – criar agente

POST {endpoint}/agents?api-version=v1

Cria o agente.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Yes	cadeia	Ponto de extremidade de Project de pesquisa no formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Se você tiver apenas um Project no Hub de Fundiário ou para direcionar o Project padrão em seu Hub, use o formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação. Serialização: explode: false

Cabeçalho da solicitação

Name	Obrigatório	Tipo	Description
Foundry-Features	No	cadeia Valores possíveis: `HostedAgents=V1Preview`, `WorkflowAgents=V1Preview`	Uma aceitação de sinalizador de recurso necessária ao usar operações de visualização ou modificar recursos de visualização persistentes.

Corpo da solicitação

Tipo de conteúdo: application/json

Name	Tipo	Description	Obrigatório
definição	AgentDefinition		Yes
└─ tipo	AgentKind		Yes
└─ rai_config	RaiConfig	Configuração dos recursos de filtragem de conteúdo e segurança da RAI (Configuração para IA Responsável).	No
description	cadeia	Uma descrição legível por humanos do agente. Restrições: maxLength: 512	No
metadados	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No
name	cadeia	O nome exclusivo que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve iniciar e terminar com caracteres alfanuméricos, - Pode conter hifens no meio - Não deve exceder 63 caracteres. Restrições: maxLength: 63	Yes

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Description
application/json	AgentObject

Código de status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Description
application/json	ApiErrorResponse

Agentes – listar agentes

GET {endpoint}/agents?api-version=v1

Retorna a lista de todos os agentes.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Yes	cadeia	Ponto de extremidade de Project de pesquisa no formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Se você tiver apenas um Project no Hub de Fundiário ou para direcionar o Project padrão em seu Hub, use o formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
variante	consulta	No	cadeia Valores possíveis: `prompt`, , `hostedworkflow`	Filtrar agentes por tipo. Se não for fornecido, todos os agentes serão retornados. Serialização: explode: false
limit	consulta	No	inteiro (int32)	Um limite para o número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20. Serialização: explode: false
ordem	consulta	No	cadeia Valores possíveis: `asc`, `desc`	Classificar a ordem pelo carimbo de data/hora `created_at` dos objetos. `asc` para ordem crescente e`desc` para ordem decrescente. Serialização: explode: false
Depois	consulta	No	cadeia	Um cursor para uso na paginação. `after` é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A próxima chamada pode incluir o parâmetro after=obj_foo para buscar a próxima página da lista. Serialização: explode: false
before	consulta	No	cadeia	Um cursor para uso na paginação. `before` é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada seguinte pode incluir before=obj_foo para buscar a página anterior da lista. Serialização: explode: false
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação. Serialização: explode: false

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Description
application/json	objeto	Os dados de resposta de uma lista solicitada de itens.

Name	Tipo	Description	Obrigatório
dados	array do AgentObject	A lista de itens solicitados.	Yes
first_id	cadeia	O primeiro ID representado nesta lista.	No
has_more	boolean	Um valor que indica se há valores adicionais disponíveis que não estão registrados nesta lista.	Yes
last_id	cadeia	O último ID representado nesta lista.	No

Código de status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Description
application/json	ApiErrorResponse

Agentes – obter agente

GET {endpoint}/agents/{agent_name}?api-version=v1

Recupera o agente.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Yes	cadeia	Ponto de extremidade de Project de pesquisa no formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Se você tiver apenas um Project no Hub de Fundiário ou para direcionar o Project padrão em seu Hub, use o formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	caminho	Yes	cadeia	O nome do agente a ser recuperado.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação. Serialização: explode: false

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Description
application/json	AgentObject

Código de status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Description
application/json	ApiErrorResponse

Agentes – atualizar agente

POST {endpoint}/agents/{agent_name}?api-version=v1

Atualiza o agente adicionando uma nova versão se houver alterações na definição do agente. Se nenhuma alteração for alterada, retornará a versão do agente existente.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Yes	cadeia	Ponto de extremidade de Project de pesquisa no formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Se você tiver apenas um Project no Hub de Fundiário ou para direcionar o Project padrão em seu Hub, use o formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	caminho	Yes	cadeia	O nome do agente a ser recuperado.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação. Serialização: explode: false

Cabeçalho da solicitação

Name	Obrigatório	Tipo	Description
Foundry-Features	No	cadeia Valores possíveis: `HostedAgents=V1Preview`, `WorkflowAgents=V1Preview`	Uma aceitação de sinalizador de recurso necessária ao usar operações de visualização ou modificar recursos de visualização persistentes.

Corpo da solicitação

Tipo de conteúdo: application/json

Name	Tipo	Description	Obrigatório
definição	AgentDefinition		Yes
└─ tipo	AgentKind		Yes
└─ rai_config	RaiConfig	Configuração dos recursos de filtragem de conteúdo e segurança da RAI (Configuração para IA Responsável).	No
description	cadeia	Uma descrição legível por humanos do agente. Restrições: maxLength: 512	No
metadados	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Description
application/json	AgentObject

Código de status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Description
application/json	ApiErrorResponse

Agentes – excluir agente

DELETE {endpoint}/agents/{agent_name}?api-version=v1

Exclui um agente.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Yes	cadeia	Ponto de extremidade de Project de pesquisa no formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Se você tiver apenas um Project no Hub de Fundiário ou para direcionar o Project padrão em seu Hub, use o formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	caminho	Yes	cadeia	O nome do agente a ser excluído.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação. Serialização: explode: false

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Description
application/json	DeleteAgentResponse

Código de status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Description
application/json	ApiErrorResponse

Agentes – atualizar o agente do manifesto

POST {endpoint}/agents/{agent_name}/import?api-version=v1

Atualiza o agente de um manifesto adicionando uma nova versão se houver alterações na definição do agente. Se nenhuma alteração for alterada, retornará a versão do agente existente.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Yes	cadeia	Ponto de extremidade de Project de pesquisa no formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Se você tiver apenas um Project no Hub de Fundiário ou para direcionar o Project padrão em seu Hub, use o formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	caminho	Yes	cadeia	O nome do agente a ser atualizado.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação. Serialização: explode: false

Corpo da solicitação

Tipo de conteúdo: application/json

Name	Tipo	Description	Obrigatório
description	cadeia	Uma descrição legível por humanos do agente. Restrições: maxLength: 512	No
manifest_id	cadeia	A ID do manifesto da qual importar a versão do agente.	Yes
metadados	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No
parameter_values	objeto	As entradas para o manifesto que resultarão em um Agente totalmente materializado.	Yes

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Description
application/json	AgentObject

Código de status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Description
application/json	ApiErrorResponse

Agentes – criar versão do agente

POST {endpoint}/agents/{agent_name}/versions?api-version=v1

Crie uma nova versão do agente.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Yes	cadeia	Ponto de extremidade de Project de pesquisa no formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Se você tiver apenas um Project no Hub de Fundiário ou para direcionar o Project padrão em seu Hub, use o formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	caminho	Yes	cadeia	O nome exclusivo que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve iniciar e terminar com caracteres alfanuméricos, - Pode conter hifens no meio - Não deve exceder 63 caracteres.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação. Serialização: explode: false

Cabeçalho da solicitação

Name	Obrigatório	Tipo	Description
Foundry-Features	No	cadeia Valores possíveis: `HostedAgents=V1Preview`, `WorkflowAgents=V1Preview`	Uma aceitação de sinalizador de recurso necessária ao usar operações de visualização ou modificar recursos de visualização persistentes.

Corpo da solicitação

Tipo de conteúdo: application/json

Name	Tipo	Description	Obrigatório
definição	AgentDefinition		Yes
└─ tipo	AgentKind		Yes
└─ rai_config	RaiConfig	Configuração dos recursos de filtragem de conteúdo e segurança da RAI (Configuração para IA Responsável).	No
description	cadeia	Uma descrição legível por humanos do agente. Restrições: maxLength: 512	No
metadados	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Description
application/json	AgentVersionObject

Código de status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Description
application/json	ApiErrorResponse

Agentes – listar versões do agente

GET {endpoint}/agents/{agent_name}/versions?api-version=v1

Retorna a lista de versões de um agente.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Yes	cadeia	Ponto de extremidade de Project de pesquisa no formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Se você tiver apenas um Project no Hub de Fundiário ou para direcionar o Project padrão em seu Hub, use o formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	caminho	Yes	cadeia	O nome do agente para o qual recuperar versões.
limit	consulta	No	inteiro (int32)	Um limite para o número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20. Serialização: explode: false
ordem	consulta	No	cadeia Valores possíveis: `asc`, `desc`	Classificar a ordem pelo carimbo de data/hora `created_at` dos objetos. `asc` para ordem crescente e`desc` para ordem decrescente. Serialização: explode: false
Depois	consulta	No	cadeia	Um cursor para uso na paginação. `after` é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A próxima chamada pode incluir o parâmetro after=obj_foo para buscar a próxima página da lista. Serialização: explode: false
before	consulta	No	cadeia	Um cursor para uso na paginação. `before` é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada seguinte pode incluir before=obj_foo para buscar a página anterior da lista. Serialização: explode: false
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação. Serialização: explode: false

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Description
application/json	objeto	Os dados de resposta de uma lista solicitada de itens.

Name	Tipo	Description	Obrigatório
dados	array do AgentVersionObject	A lista de itens solicitados.	Yes
first_id	cadeia	O primeiro ID representado nesta lista.	No
has_more	boolean	Um valor que indica se há valores adicionais disponíveis que não estão registrados nesta lista.	Yes
last_id	cadeia	O último ID representado nesta lista.	No

Código de status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Description
application/json	ApiErrorResponse

Agentes – obter a versão do agente

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

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

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Yes	cadeia	Ponto de extremidade de Project de pesquisa no formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Se você tiver apenas um Project no Hub de Fundiário ou para direcionar o Project padrão em seu Hub, use o formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	caminho	Yes	cadeia	O nome do agente a ser recuperado.
agent_version	caminho	Yes	cadeia	A versão do agente a ser recuperada.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação. Serialização: explode: false

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Description
application/json	AgentVersionObject

Código de status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Description
application/json	ApiErrorResponse

Agentes – excluir versão do agente

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

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

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Yes	cadeia	Ponto de extremidade de Project de pesquisa no formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Se você tiver apenas um Project no Hub de Fundiário ou para direcionar o Project padrão em seu Hub, use o formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	caminho	Yes	cadeia	O nome do agente a ser excluído.
agent_version	caminho	Yes	cadeia	A versão do agente a ser excluída
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação. Serialização: explode: false

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Description
application/json	DeleteAgentVersionResponse

Código de status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Description
application/json	ApiErrorResponse

Agentes – criar a versão do agente a partir do manifesto

POST {endpoint}/agents/{agent_name}/versions:import?api-version=v1

Crie uma nova versão do agente a partir de um manifesto.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Yes	cadeia	Ponto de extremidade de Project de pesquisa no formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Se você tiver apenas um Project no Hub de Fundiário ou para direcionar o Project padrão em seu Hub, use o formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	caminho	Yes	cadeia	O nome exclusivo que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve iniciar e terminar com caracteres alfanuméricos, - Pode conter hifens no meio - Não deve exceder 63 caracteres.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação. Serialização: explode: false

Corpo da solicitação

Tipo de conteúdo: application/json

Name	Tipo	Description	Obrigatório
description	cadeia	Uma descrição legível por humanos do agente. Restrições: maxLength: 512	No
manifest_id	cadeia	A ID do manifesto da qual importar a versão do agente.	Yes
metadados	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No
parameter_values	objeto	As entradas para o manifesto que resultarão em um Agente totalmente materializado.	Yes

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Description
application/json	AgentVersionObject

Código de status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Description
application/json	ApiErrorResponse

Agentes – criar agente a partir do manifesto

POST {endpoint}/agents:import?api-version=v1

Cria um agente a partir de um manifesto.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Yes	cadeia	Ponto de extremidade de Project de pesquisa no formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Se você tiver apenas um Project no Hub de Fundiário ou para direcionar o Project padrão em seu Hub, use o formulário "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação. Serialização: explode: false

Corpo da solicitação

Tipo de conteúdo: application/json

Name	Tipo	Description	Obrigatório
description	cadeia	Uma descrição legível por humanos do agente. Restrições: maxLength: 512	No
manifest_id	cadeia	A ID do manifesto da qual importar a versão do agente.	Yes
metadados	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No
name	cadeia	O nome exclusivo que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve iniciar e terminar com caracteres alfanuméricos, - Pode conter hifens no meio - Não deve exceder 63 caracteres. Restrições: maxLength: 63	Yes
parameter_values	objeto	As entradas para o manifesto que resultarão em um Agente totalmente materializado.	Yes

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Description
application/json	AgentObject

Código de status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Description
application/json	ApiErrorResponse

Componentes

A2APreviewTool

Um agente que implementa o protocolo A2A.

Name	Tipo	Description	Obrigatório
agent_card_path	cadeia	O caminho para o cartão do agente em relação ao `base_url`. Se não for fornecido, o padrão será `/.well-known/agent-card.json`	No
base_url	cadeia de caracteres (uri)	URL base do agente.	No
project_connection_id	cadeia	A ID de conexão no projeto do servidor A2A. A conexão armazena a autenticação e outros detalhes de conexão necessários para se conectar ao servidor A2A.	No
tipo	enumeração	O tipo da ferramenta. Sempre `"a2a_preview`. Valores possíveis: `a2a_preview`	Yes

AISearchIndexResource

Um recurso de Índice de Pesquisa de IA.

Name	Tipo	Description	Obrigatório
filtro	cadeia	cadeia de caracteres de filtro para o recurso de pesquisa. Saiba mais aqui.	No
index_asset_id	cadeia	Indexar a ID do ativo para o recurso de pesquisa.	No
nome_do_indice	cadeia	O nome de um índice em um IndexResource anexado a esse agente.	No
project_connection_id	cadeia	Uma ID de conexão de índice em um IndexResource anexado a esse agente.	No
tipo_de_consulta	AzureAISearchQueryType	Tipos de consulta disponíveis para Pesquisa de IA do Azure ferramenta.	No
top_k	inteiro (int32)	Número de documentos a serem recuperados da pesquisa e presentes no modelo.	No

AgentDefinition

Discriminador para AgentDefinition

Esse componente usa a propriedade kind para discriminar entre diferentes tipos:

Valor do tipo	Schema
`prompt`	PromptAgentDefinition
`workflow`	WorkflowAgentDefinition
`hosted`	HostedAgentDefinition

Name	Tipo	Description	Obrigatório
variante	AgentKind		Yes
rai_config	RaiConfig	Configuração dos recursos de filtragem de conteúdo e segurança da RAI (Configuração para IA Responsável).	No
└─ rai_policy_name	cadeia	O nome da política RAI a ser aplicada.	Yes

AgentDefinitionOptInKeys

Chaves de opt-in de recursos para operações de definição de agentes, suportando agentes hospedados ou de workflow.

Property	Valor
Tipo	cadeia
Valores	`HostedAgents=V1Preview` `WorkflowAgents=V1Preview`

AgentKind

Property	Valor
Tipo	cadeia
Valores	`prompt` `hosted` `workflow`

AgentObject

Name	Tipo	Description	Obrigatório
id	cadeia	O identificador exclusivo do agente.	Yes
name	cadeia	O nome do agente. Restrições: maxLength: 63	Yes
objeto	enumeração	O tipo de objeto, que é sempre 'agent'. Valores possíveis: `agent`	Yes
versions	objeto	A versão mais recente do agente.	Yes
└─ mais recente	AgentVersionObject		Yes

AgentProtocol

Property	Valor
Tipo	cadeia
Valores	`activity_protocol` `responses`

AgentVersionObject

Name	Tipo	Description	Obrigatório
criado_em	FoundryTimestamp		Yes
definição	AgentDefinition		Yes
description	cadeia	Uma descrição legível por humanos do agente. Restrições: maxLength: 512	No
id	cadeia	O identificador exclusivo da versão do agente.	Yes
metadados	objeto (anulável)	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
name	cadeia	O nome do agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. Restrições: maxLength: 256	Yes
objeto	enumeração	O tipo de objeto, que é sempre 'agent.version'. Valores possíveis: `agent.version`	Yes
versão	cadeia	O identificador de versão do agente. Os agentes são imutáveis e cada atualização cria uma nova versão mantendo o mesmo nome.	Yes

ApiErrorResponse

Resposta de erro para falhas de API.

Name	Tipo	Description	Obrigatório	Default
erro	OpenAI.Error		Yes

AzureAISearchQueryType

Tipos de consulta disponíveis para Pesquisa de IA do Azure ferramenta.

Property	Valor
Description	Tipos de consulta disponíveis para Pesquisa de IA do Azure ferramenta.
Tipo	cadeia
Valores	`simple` `semantic` `vector` `vector_simple_hybrid` `vector_semantic_hybrid`

AzureAISearchTool

As informações de definição de entrada para uma ferramenta de pesquisa de IA Azure, conforme usado para configurar um agente.

Name	Tipo	Description	Obrigatório
azure_ai_search	AzureAISearchToolResource	Um conjunto de recursos de índice usados pela `azure_ai_search` ferramenta.	Yes
└─ índices	matriz de AISearchIndexResource	Os índices anexados a este agente. Pode haver um índice máximo de 1 recurso anexado ao agente. Restrições: maxItems: 1	Yes
tipo	enumeração	O tipo de objeto, que é sempre 'azure_ai_search'. Valores possíveis: `azure_ai_search`	Yes

AzureAISearchToolResource

Um conjunto de recursos de índice usados pela azure_ai_search ferramenta.

Name	Tipo	Description	Obrigatório	Default
índices	matriz de AISearchIndexResource	Os índices anexados a este agente. Pode haver um índice máximo de 1 recurso anexado ao agente. Restrições: maxItems: 1	Yes

AzureFunctionBinding

A estrutura para manter o nome da fila de armazenamento e o URI.

Name	Tipo	Description	Obrigatório
storage_queue	AzureFunctionStorageQueue	A estrutura para manter o nome da fila de armazenamento e o URI.	Yes
└─ queue_name	cadeia	O nome de uma fila de armazenamento de funções Azure.	Yes
└─ queue_service_endpoint	cadeia	URI para o serviço Armazenamento do Azure Fila, permitindo que você manipule uma fila.	Yes
tipo	enumeração	O tipo de associação, que é sempre "storage_queue". Valores possíveis: `storage_queue`	Yes

AzureFunctionDefinition

A definição da função Azure.

Name	Tipo	Description	Obrigatório
função	objeto	A definição da função do azure e seus parâmetros.	Yes
└─ descrição	cadeia	Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função.	No
└─ nome	cadeia	O nome da função a ser chamada.	Yes
└─ parâmetros	objeto	Os parâmetros que as funções aceitam, descritos como um objeto de Esquema JSON.	Yes
input_binding	AzureFunctionBinding	A estrutura para manter o nome da fila de armazenamento e o URI.	Yes
└─ storage_queue	AzureFunctionStorageQueue	Fila de armazenamento.	Yes
└─ tipo	enumeração	O tipo de associação, que é sempre "storage_queue". Valores possíveis: `storage_queue`	Yes
output_binding	AzureFunctionBinding	A estrutura para manter o nome da fila de armazenamento e o URI.	Yes
└─ storage_queue	AzureFunctionStorageQueue	Fila de armazenamento.	Yes
└─ tipo	enumeração	O tipo de associação, que é sempre "storage_queue". Valores possíveis: `storage_queue`	Yes

AzureFunctionStorageQueue

A estrutura para manter o nome da fila de armazenamento e o URI.

Name	Tipo	Description	Obrigatório	Default
Nome_da_fila	cadeia	O nome de uma fila de armazenamento de funções Azure.	Yes
queue_service_endpoint	cadeia	URI para o serviço Armazenamento do Azure Fila, permitindo que você manipule uma fila.	Yes

AzureFunctionTool

As informações de definição de entrada para uma ferramenta de função Azure, conforme usado para configurar um Agente.

Name	Tipo	Description	Obrigatório
azure_function	AzureFunctionDefinition	A definição da função Azure.	Yes
Função └─	objeto	A definição da função do azure e seus parâmetros.	Yes
└─ descrição	cadeia	Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função.	No
└─ nome	cadeia	O nome da função a ser chamada.	Yes
└─ parâmetros	objeto	Os parâmetros que as funções aceitam, descritos como um objeto de Esquema JSON.	Yes
└─ input_binding	AzureFunctionBinding	Fila de armazenamento de entrada. O gatilho de armazenamento de fila executa uma função à medida que as mensagens são adicionadas a ela.	Yes
└─ output_binding	AzureFunctionBinding	Fila de armazenamento de saída. A função grava a saída nessa fila quando os itens de entrada são processados.	Yes
tipo	enumeração	O tipo de objeto, que é sempre 'browser_automation'. Valores possíveis: `azure_function`	Yes

BingCustomSearchConfiguration

Uma configuração de pesquisa personalizada do bing.

Name	Tipo	Description	Obrigatório
contagem	inteiro (int64)	O número de resultados da pesquisa a serem retornados na resposta à API do bing	No
freshness	cadeia	Filtrar os resultados da pesquisa por um intervalo de tempo específico. Veja os valores aceitos aqui.	No
instance_name	cadeia	Nome da instância de configuração personalizada fornecida à configuração.	Yes
Mercado	cadeia	O mercado de onde vêm os resultados.	No
project_connection_id	cadeia	Project id de conexão para aterramento com a pesquisa do bing	Yes
set_lang	cadeia	O idioma a ser usado para cadeias de caracteres de interface do usuário ao chamar a API do Bing.	No

BingCustomSearchPreviewTool

As informações de definição de entrada para uma ferramenta de pesquisa personalizada do Bing, conforme usado para configurar um agente.

Name	Tipo	Description	Obrigatório
bing_custom_search_preview	BingCustomSearchToolParameters	Os parâmetros da ferramenta de pesquisa personalizada do bing.	Yes
└─ search_configurations	matriz de BingCustomSearchConfiguration	As conexões de projeto anexadas a essa ferramenta. Pode haver um máximo de 1 conexão recurso anexado à ferramenta. Restrições: maxItems: 1	Yes
tipo	enumeração	O tipo de objeto, que é sempre 'bing_custom_search_preview'. Valores possíveis: `bing_custom_search_preview`	Yes

BingCustomSearchToolParameters

Os parâmetros da ferramenta de pesquisa personalizada do bing.

Name	Tipo	Description	Obrigatório	Default
search_configurations	matriz de BingCustomSearchConfiguration	As conexões de projeto anexadas a essa ferramenta. Pode haver um máximo de 1 conexão recurso anexado à ferramenta. Restrições: maxItems: 1	Yes

BingGroundingSearchConfiguration

Configuração de pesquisa para o Aterramento do Bing

Name	Tipo	Description	Obrigatório
contagem	inteiro (int64)	O número de resultados da pesquisa a serem retornados na resposta à API do bing	No
freshness	cadeia	Filtrar os resultados da pesquisa por um intervalo de tempo específico. Veja os valores aceitos aqui.	No
Mercado	cadeia	O mercado de onde vêm os resultados.	No
project_connection_id	cadeia	Project id de conexão para aterramento com a pesquisa do bing	Yes
set_lang	cadeia	O idioma a ser usado para cadeias de caracteres de interface do usuário ao chamar a API do Bing.	No

BingGroundingSearchToolParameters

Os parâmetros da ferramenta de pesquisa de aterramento do bing.

Name	Tipo	Description	Obrigatório	Default
search_configurations	matriz de BingGroundingSearchConfiguration	As configurações de pesquisa anexadas a essa ferramenta. Pode haver um máximo de 1 recurso de configuração de pesquisa anexado à ferramenta. Restrições: maxItems: 1	Yes

BingGroundingTool

As informações de definição de entrada para uma ferramenta de pesquisa de aterramento do bing, conforme usado para configurar um agente.

Name	Tipo	Description	Obrigatório
bing_grounding	BingGroundingSearchToolParameters	Os parâmetros da ferramenta de pesquisa de aterramento do bing.	Yes
└─ search_configurations	matriz de BingGroundingSearchConfiguration	As configurações de pesquisa anexadas a essa ferramenta. Pode haver um máximo de 1 recurso de configuração de pesquisa anexado à ferramenta. Restrições: maxItems: 1	Yes
tipo	enumeração	O tipo de objeto, que é sempre 'bing_grounding'. Valores possíveis: `bing_grounding`	Yes

BrowserAutomationPreviewTool

As informações de definição de entrada para uma Ferramenta de Automação do Navegador, conforme usado para configurar um Agente.

Name	Tipo	Description	Obrigatório
browser_automation_preview	BrowserAutomationToolParameters	Definição de parâmetros de entrada para a Ferramenta de Automação do Navegador.	Yes
└─ conexão	BrowserAutomationToolConnectionParameters	Os parâmetros de conexão do projeto associados à Ferramenta de Automação do Navegador.	Yes
tipo	enumeração	O tipo de objeto, que é sempre "browser_automation_preview". Valores possíveis: `browser_automation_preview`	Yes

BrowserAutomationToolConnectionParameters

Definição de parâmetros de entrada para a conexão usada pela Ferramenta de Automação do Navegador.

Name	Tipo	Description	Obrigatório	Default
project_connection_id	cadeia	A ID da conexão do projeto com seu recurso de dramaturgo Azure.	Yes

BrowserAutomationToolParameters

Definição de parâmetros de entrada para a Ferramenta de Automação do Navegador.

Name	Tipo	Description	Obrigatório	Default
conexão	BrowserAutomationToolConnectionParameters	Definição de parâmetros de entrada para a conexão usada pela Ferramenta de Automação do Navegador.	Yes
└─ project_connection_id	cadeia	A ID da conexão do projeto com seu recurso de dramaturgo Azure.	Yes

CaptureStructuredOutputsTool

Uma ferramenta para capturar saídas estruturadas

Name	Tipo	Description	Obrigatório
outputs	StructuredOutputDefinition	Uma saída estruturada que pode ser produzida pelo agente.	Yes
└─ descrição	cadeia	Uma descrição da saída a ser emitida. Usado pelo modelo para determinar quando emitir a saída.	Yes
└─ nome	cadeia	O nome da saída estruturada.	Yes
└─ esquema	objeto	O esquema JSON para a saída estruturada.	Yes
└─ rigoroso	booliano (anulável)	Se a validação estrita deve ser imposta. Padrão `true`.	Yes
tipo	enumeração	O tipo da ferramenta. Sempre `capture_structured_outputs`. Valores possíveis: `capture_structured_outputs`	Yes

CreateAgentFromManifestRequest

Name	Tipo	Description	Obrigatório
description	cadeia	Uma descrição legível por humanos do agente. Restrições: maxLength: 512	No
manifest_id	cadeia	A ID do manifesto da qual importar a versão do agente.	Yes
metadados	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No
name	cadeia	O nome exclusivo que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve iniciar e terminar com caracteres alfanuméricos, - Pode conter hifens no meio - Não deve exceder 63 caracteres. Restrições: maxLength: 63	Yes
parameter_values	objeto	As entradas para o manifesto que resultarão em um Agente totalmente materializado.	Yes

CreateAgentRequest

Name	Tipo	Description	Obrigatório
definição	AgentDefinition		Yes
└─ tipo	AgentKind		Yes
└─ rai_config	RaiConfig	Configuração dos recursos de filtragem de conteúdo e segurança da RAI (Configuração para IA Responsável).	No
description	cadeia	Uma descrição legível por humanos do agente. Restrições: maxLength: 512	No
metadados	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No
name	cadeia	O nome exclusivo que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve iniciar e terminar com caracteres alfanuméricos, - Pode conter hifens no meio - Não deve exceder 63 caracteres. Restrições: maxLength: 63	Yes

CreateAgentVersionFromManifestRequest

Name	Tipo	Description	Obrigatório
description	cadeia	Uma descrição legível por humanos do agente. Restrições: maxLength: 512	No
manifest_id	cadeia	A ID do manifesto da qual importar a versão do agente.	Yes
metadados	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No
parameter_values	objeto	As entradas para o manifesto que resultarão em um Agente totalmente materializado.	Yes

CreateAgentVersionRequest

Name	Tipo	Description	Obrigatório
definição	AgentDefinition		Yes
└─ tipo	AgentKind		Yes
└─ rai_config	RaiConfig	Configuração dos recursos de filtragem de conteúdo e segurança da RAI (Configuração para IA Responsável).	No
description	cadeia	Uma descrição legível por humanos do agente. Restrições: maxLength: 512	No
metadados	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No

DeleteAgentResponse

Um objeto de agente excluído

Name	Tipo	Description	Obrigatório
excluído	boolean	Se o agente foi excluído com êxito.	Yes
name	cadeia	O nome do agente.	Yes
objeto	enumeração	O tipo de objeto. Sempre 'agent.deleted'. Valores possíveis: `agent.deleted`	Yes

DeleteAgentVersionResponse

Um objeto de versão do agente excluído

Name	Tipo	Description	Obrigatório
excluído	boolean	Se o agente foi excluído com êxito.	Yes
name	cadeia	O nome do agente.	Yes
objeto	enumeração	O tipo de objeto. Sempre 'agent.version.deleted'. Valores possíveis: `agent.version.deleted`	Yes
versão	cadeia	O identificador de versão do agente.	Yes

FabricDataAgentToolParameters

Os parâmetros da ferramenta agente de dados de malha.

Name	Tipo	Description	Obrigatório	Default
project_connections	matriz de ToolProjectConnection	As conexões de projeto anexadas a essa ferramenta. Pode haver um máximo de 1 conexão recurso anexado à ferramenta. Restrições: maxItems: 1	No

FoundryTimestamp

Tipo: inteiro

Format: unixtime

HostedAgentDefinition

A definição do agente hospedado.

Name	Tipo	Description	Obrigatório
container_protocol_versions	matriz de ProtocolVersionRecord	Os protocolos aos quais o agente dá suporte para a comunicação de entrada dos contêineres.	Yes
cpu	cadeia	A configuração da CPU para o agente hospedado.	Yes
environment_variables	objeto	Variáveis de ambiente a serem definidas no contêiner do agente hospedado.	No
imagem	cadeia	A ID da imagem do agente, aplicável a agentes hospedados baseados em imagem.	No
variante	enumeração	Valores possíveis: `hosted`	Yes
memória	cadeia	A configuração de memória do agente hospedado.	Yes
rai_config	RaiConfig	Configuração dos recursos de filtragem de conteúdo e segurança da RAI (Configuração para IA Responsável).	No
└─ rai_policy_name	cadeia	O nome da política RAI a ser aplicada.	Yes
tools	matriz de OpenAI.Tool	Uma matriz de ferramentas que o modelo do agente hospedado pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro.	No

MemorySearchOptions

Opções de pesquisa de memória.

Name	Tipo	Description	Obrigatório	Default
max_memories	inteiro (int32)	Número máximo de itens de memória a serem retornados.	No

MemorySearchPreviewTool

Uma ferramenta para integrar memórias ao agente.

Name	Tipo	Description	Obrigatório	Default
memory_store_name	cadeia	O nome do repositório de memória a ser usado.	Yes
escopo	cadeia	O namespace usado para agrupar e isolar memórias, como uma ID de usuário. Limita quais memórias podem ser recuperadas ou atualizadas. Use uma variável `{{$userId}}` especial para definir o escopo de memórias para o usuário conectado atual.	Yes
search_options	MemorySearchOptions	Opções de pesquisa de memória.	No
└─ max_memories	inteiro (int32)	Número máximo de itens de memória a serem retornados.	No
tipo	enumeração	O tipo da ferramenta. Sempre `memory_search_preview`. Valores possíveis: `memory_search_preview`	Yes
update_delay	inteiro (int32)	Tempo de espera antes de atualizar as memórias após a inatividade (segundos). Padrão 300.	No	300

MicrosoftFabricPreviewTool

As informações de definição de entrada para uma ferramenta de Microsoft Fabric, conforme usado para configurar um agente.

Name	Tipo	Description	Obrigatório
fabric_dataagent_preview	FabricDataAgentToolParameters	Os parâmetros da ferramenta agente de dados de malha.	Yes
└─ project_connections	matriz de ToolProjectConnection	As conexões de projeto anexadas a essa ferramenta. Pode haver um máximo de 1 conexão recurso anexado à ferramenta. Restrições: maxItems: 1	No
tipo	enumeração	O tipo de objeto, que é sempre 'fabric_dataagent_preview'. Valores possíveis: `fabric_dataagent_preview`	Yes

OpenAI.ApplyPatchToolParam

Aplicar a ferramenta de correção

Permite que o assistente crie, exclua ou atualize arquivos usando diferenças unificadas.

Name	Tipo	Description	Obrigatório	Default
tipo	enumeração	O tipo da ferramenta. Sempre `apply_patch`. Valores possíveis: `apply_patch`	Yes	apply_patch

OpenAI.ApproximateLocation

Name	Tipo	Description	Obrigatório	Default
city	cadeia de caracteres (anulável)		No
country	cadeia de caracteres (anulável)		No
região	cadeia de caracteres (anulável)		No
timezone	cadeia de caracteres (anulável)		No
tipo	enumeração	O tipo de aproximação de local. Sempre `approximate`. Valores possíveis: `approximate`	Yes	aproximado

OpenAI.AutoCodeInterpreterToolParam

Parâmetros da Ferramenta Automática de Interpretador de Código

Configuração para um contêiner de interpretador de código. Opcionalmente, especifique as IDs dos arquivos nos quais executar o código.

Name	Tipo	Description	Obrigatório	Default
identificadores_de_arquivos	matriz de strings	Uma lista opcional de arquivos carregados a serem disponibilizados para seu código. Restrições: máximosItens: 50	No
limite de memória	OpenAI.ContainerMemoryLimit (anulável)		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Política de acesso à rede para o contêiner.	No
tipo	enumeração	Sempre `auto`. Valores possíveis: `auto`	Yes	automático

OpenAI.CodeInterpreterTool

Interpretador de código

Uma ferramenta que executa o código Python para ajudar a gerar uma resposta a um prompt.

Name	Tipo	Description	Obrigatório	Default
contêiner	string ou OpenAI.AutoCodeInterpreterToolParam	O contêiner do interpretador de código. Pode ser uma ID de contêiner ou um objeto que especifica as IDs de arquivo carregadas a serem disponibilizadas para seu código, juntamente com um configuração opcional `memory_limit` . Se não for fornecido, o serviço assumirá automaticamente.	No
tipo	enumeração	O tipo da ferramenta de interpretador de código. Sempre `code_interpreter`. Valores possíveis: `code_interpreter`	Yes

OpenAI.FiltroComparativo

Filtro de Comparação

Um filtro usado para comparar uma chave de atributo especificada com um determinado valor usando uma operação de comparação definida.

Name	Tipo	Description	Obrigatório	Default
chave	cadeia	A chave a ser comparada com o valor.	Yes
tipo	enumeração	Especifica o operador de comparação: `eq`, , `ne`, `gt`, `gte`, `lt`, , `lte`, `in`, `nin`. - `eq`: igual - `ne`: não é igual a - `gt`: maior que - `gte`: maior ou igual a - `lt`: menor que - `lte`: menor ou igual a - `in`:Em - `nin`: não em Valores possíveis: `eq`, , `ne`, `gt`, `gte`, , `ltlte`	Yes	eq
valor	string ou OpenAI.numeric ou boolean ou array of string ou OpenAI.numeric	O valor a ser comparado com a chave de atributo; dá suporte a tipos de cadeia de caracteres, número ou booliano.	Yes

OpenAI.CompoundFilter

Filtro composto

Combinar vários filtros usando and ou or.

Name	Tipo	Description	Obrigatório	Default
filters	matriz de OpenAI.ComparisonFilter ou objeto	Matriz de filtros a serem combinados. Os itens podem ser `ComparisonFilter` ou `CompoundFilter`.	Yes
tipo	enumeração	Tipo de operação: `and` ou `or`. Valores possíveis: `and`, `or`	Yes

OpenAI.ComputerEnvironment

Property	Valor
Tipo	cadeia
Valores	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerUsePreviewTool

Prévia do uso do computador

Uma ferramenta que controla um computador virtual.

Name	Tipo	Description	Obrigatório	Default
altura_do_display	OpenAI.integer		Yes
largura de exibição	OpenAI.integer		Yes
ambiente	OpenAI.ComputerEnvironment		Yes
tipo	enumeração	O tipo da ferramenta de uso do computador. Sempre `computer_use_preview`. Valores possíveis: `computer_use_preview`	Yes	computer_use_preview

OpenAI.ContainerAutoParam

Name	Tipo	Description	Obrigatório	Default
identificadores_de_arquivos	matriz de strings	Uma lista opcional de arquivos carregados a serem disponibilizados para seu código. Restrições: máximosItens: 50	No
limite de memória	OpenAI.ContainerMemoryLimit (anulável)		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Política de acesso à rede para o contêiner.	No
habilidades	array de OpenAI.ContainerSkill	Uma lista opcional de habilidades referenciadas por ID ou dados inline. Restrições: máximoItens: 200	No
tipo	enumeração	Cria automaticamente um contêiner para essa solicitação Valores possíveis: `container_auto`	Yes	container_auto

OpenAI.ContainerMemoryLimit

Property	Valor
Tipo	cadeia
Valores	`1g` `4g` `16g` `64g`

OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Tipo	Description	Obrigatório	Default
allowed_domains	matriz de strings	Uma lista de domínios permitidos quando o tipo é `allowlist`. Restrições: minItens: 1	Yes
domain_secrets	array de OpenAI.ContainerNetworkPolicyDomainSecretParam	Segredos opcionais com escopo de domínio para domínios permitidos. Restrições: minItens: 1	No
tipo	enumeração	Permita acesso à rede de saída apenas a domínios específicos. Sempre `allowlist`. Valores possíveis: `allowlist`	Yes	incluir na lista de permitidos

OpenAI.ContainerNetworkPolicyDisabledParam

Name	Tipo	Description	Obrigatório	Default
tipo	enumeração	Desative o acesso à rede de saída. Sempre `disabled`. Valores possíveis: `disabled`	Yes	desabilitado

OpenAI.ContainerNetworkPolicyDomainSecretParam

Name	Tipo	Description	Obrigatório
domínio	cadeia	O domínio associado ao segredo. Restrições: minLength: 1	Yes
name	cadeia	O nome do segredo a ser injetado para o domínio. Restrições: minLength: 1	Yes
valor	cadeia	O valor secreto a ser injetado para o domínio. Restrições: minComprimento: 1, máximoComprimento: 10485760	Yes

OpenAI.ContainerNetworkPolicyParam

Política de acesso à rede para o contêiner.

Discriminador para OpenAI.ContainerNetworkPolicyParam

Esse componente usa a propriedade type para discriminar entre diferentes tipos:

Valor do tipo	Schema
`disabled`	OpenAI.ContainerNetworkPolicyDisabledParam
`allowlist`	OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ContainerNetworkPolicyParamType		Yes

OpenAI.ContainerNetworkPolicyParamType

Property	Valor
Tipo	cadeia
Valores	`disabled` `allowlist`

OpenAI.ContainerSkill

Discriminador para OpenAI.ContainerSkill

Esse componente usa a propriedade type para discriminar entre diferentes tipos:

Valor do tipo	Schema
`skill_reference`	OpenAI.SkillReferenceParam
`inline`	OpenAI.InlineSkillParam

Name	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ContainerSkillType		Yes

OpenAI.ContainerSkillType

Property	Valor
Tipo	cadeia
Valores	`skill_reference` `inline`

OpenAI.CustomGrammarFormatParam

Formato gramatical

Uma gramática definida pelo usuário.

Name	Tipo	Description	Obrigatório	Default
definição	cadeia	A definição de gramática.	Yes
Sintaxe	OpenAI.GrammarSyntax1		Yes
tipo	enumeração	Formato de gramática. Sempre `grammar`. Valores possíveis: `grammar`	Yes	Gramática

OpenAI.CustomTextFormatParam

Formato de texto

Texto sem restrições de forma livre.

Name	Tipo	Description	Obrigatório	Default
tipo	enumeração	Formato de texto não treinado. Sempre `text`. Valores possíveis: `text`	Yes	enviar SMS

OpenAI.CustomToolParam

Ferramenta personalizada

Uma ferramenta personalizada que processa a entrada usando um formato especificado. Saiba mais sobre ferramentas personalizadas

Name	Tipo	Description	Obrigatório	Default
description	cadeia	Descrição opcional da ferramenta personalizada, usada para fornecer mais contexto.	No
format	OpenAI.CustomToolParamFormat	O formato de entrada para a ferramenta personalizada. O padrão é texto sem restrições.	No
└─ tipo	OpenAI.CustomToolParamFormatType		Yes
name	cadeia	O nome da ferramenta personalizada, usada para identificá-la em chamadas de ferramenta.	Yes
tipo	enumeração	O tipo da ferramenta personalizada. Sempre `custom`. Valores possíveis: `custom`	Yes	personalizado

OpenAI.CustomToolParamFormat

O formato de entrada para a ferramenta personalizada. O padrão é texto sem restrições.

Discriminador para OpenAI.CustomToolParamFormat

Esse componente usa a propriedade type para discriminar entre diferentes tipos:

Valor do tipo	Schema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

Name	Tipo	Description	Obrigatório	Default
tipo	OpenAI.CustomToolParamFormatType		Yes

OpenAI.CustomToolParamFormatType

Property	Valor
Tipo	cadeia
Valores	`text` `grammar`

OpenAI.Error

Name	Tipo	Obrigatório
Informações adicionais	objeto	No
codificar	cadeia de caracteres (anulável)	Yes
Debuginfo	objeto	No
details	matriz de OpenAI.Error	No
mensagem	cadeia	Yes
param	cadeia de caracteres (anulável)	No
tipo	cadeia	No

OpenAI.FileSearchTool

Pesquisa de arquivo

Uma ferramenta que pesquisa conteúdo relevante de arquivos carregados.

Name	Tipo	Description	Obrigatório	Default
filters	OpenAI.Filters (anulável)		No
numero_maximo_de_resultados	OpenAI.integer		No
opções_de_classificação	OpenAI.RankingOptions		No
└─ hybrid_search	OpenAI.HybridSearchOptions	Pesos que controlam como a fusão de classificação recíproca equilibra correspondências de inserção semântica versus correspondências de palavra-chave esparsa quando a pesquisa híbrida está habilitada.	No
└─ Ranker	OpenAI.RankerVersionType	O classificador a ser usado para a pesquisa de arquivos.	No
└─ limite_de_pontuação	OpenAI.numeric	O limite de pontuação para a pesquisa de arquivos, um número entre 0 e 1. Números mais próximos de 1 tentarão retornar apenas os resultados mais relevantes, mas podem retornar menos resultados.	No
tipo	enumeração	O tipo da ferramenta de pesquisa de arquivo. Sempre `file_search`. Valores possíveis: `file_search`	Yes	file_search
vector_store_ids	matriz de strings	Os IDs dos repositórios de vetores a serem pesquisados.	Yes

OpenAI.Filters

Tipo: OpenAI.ComparisonFilter ou OpenAI.CompoundFilter

OpenAI.FunctionShellToolParam

Ferramenta de concha

Uma ferramenta que permite que o modelo execute comandos de shell.

Name	Tipo	Description	Obrigatório	Default
ambiente	OpenAI.FunctionShellToolParamEnvironment (nullável)		No
└─ tipo	OpenAI.FunctionShellToolParamEnvironmentType		Yes
tipo	enumeração	O tipo da ferramenta de shell. Sempre `shell`. Valores possíveis: `shell`	Yes	shell

OpenAI.FunctionShellToolParamEnvironment

Discriminador para OpenAI.FunctionShellToolParamEnvironment

Esse componente usa a propriedade type para discriminar entre diferentes tipos:

Valor do tipo	Schema
`local`	OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam
`container_auto`	OpenAI.ContainerAutoParam

Name	Tipo	Description	Obrigatório	Default
tipo	OpenAI.FunctionShellToolParamEnvironmentType		Yes

OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam

Name	Tipo	Description	Obrigatório	Default
container_id	cadeia	O ID do contêiner referenciado.	Yes
tipo	enumeração	Faz referência a um contêiner criado com o endpoint /v1/containers Valores possíveis: `container_reference`	Yes	container_reference

OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam

Name	Tipo	Description	Obrigatório	Default
habilidades	array de OpenAI.LocalSkillParam	Uma lista opcional de habilidades. Restrições: máximoItens: 200	No
tipo	enumeração	Use um ambiente de computador local. Valores possíveis: `local`	Yes	local

OpenAI.FunctionShellToolParamEnvironmentType

Property	Valor
Tipo	cadeia
Valores	`container_auto` `local` `container_reference`

OpenAI.FunctionTool

Função

Define uma função em seu próprio código que o modelo pode optar por chamar.

Name	Tipo	Description	Obrigatório	Default
description	cadeia de caracteres (anulável)		No
name	cadeia	O nome da função a ser chamada.	Yes
parameters	objeto (anulável)		Yes
rigoroso	booliano (anulável)		Yes
tipo	enumeração	O tipo da ferramenta de função. Sempre `function`. Valores possíveis: `function`	Yes	função

OpenAI.GrammarSyntax1

Property	Valor
Tipo	cadeia
Valores	`lark` `regex`

OpenAI.HybridSearchOptions

Name	Tipo	Description	Obrigatório	Default
embedding_weight	OpenAI.numeric		Yes
text_weight	OpenAI.numeric		Yes

OpenAI.ImageGenActionEnum

Property	Valor
Tipo	cadeia
Valores	`generate` `edit` `auto`

OpenAI.ImageGenTool

Ferramenta de geração de imagens

Uma ferramenta que gera imagens usando os modelos de imagem GPT.

Modelos válidos:

gpt-image-1
gpt-image-1-mini
gpt-image-1.5

Name	Tipo	Description	Obrigatório	Default
ação	OpenAI.ImageGenActionEnum		No
em segundo plano	enumeração	Tipo de plano de fundo para a imagem gerada. Uma opção entre `transparent`, `opaque` ou `auto`. Padrão: `auto`. Valores possíveis: `transparent`, , `opaqueauto`	No	automático
fidelidade_de_entrada	OpenAI.InputFidelity (anulável)	Controlar o esforço que o modelo exercerá para corresponder ao estilo e aos recursos, especialmente os recursos faciais, das imagens de entrada. Esse parâmetro é suportado apenas para `gpt-image-1` e `gpt-image-1.5` modelos posteriores, não suportados para `gpt-image-1-mini`. Suportes `high` e `low`. Usa `low` como padrão.	No
input_image_mask	OpenAI.ImageGenToolInputImageMask		No
└─ identificador_de_arquivo	cadeia		No
└─ URL da imagem	cadeia de caracteres (uri)		No
modelo	cadeia de caracteres (veja os modelos válidos abaixo)		No
Moderação	enumeração	Nível de moderação para a imagem gerada. Padrão: `auto`. Valores possíveis: `auto`, `low`	No	automático
compressão_de_saída	OpenAI.integer	Restrições: min: 0, máximo: 100	No	100
formato de saída	enumeração	O formato de saída da imagem gerada. Um de `png`, `webp`, ou `jpeg`. Padrão: `png`. Valores possíveis: `png`, , `webpjpeg`	No	png
imagens parciais	OpenAI.integer	Restrições: min: 0, max: 3	No
Qualidade	enumeração	A qualidade da imagem gerada. Um de `low`, `medium`, , `high` ou `auto`. Padrão: `auto`. Valores possíveis: `low`, , `medium`, `highauto`	No	automático
size	enumeração	O tamanho da imagem gerada. Um de `1024x1024`, `1024x1536` `1536x1024` ou `auto`. Padrão: `auto`. Valores possíveis: `1024x1024`, , `1024x1536`, `1536x1024auto`	No	automático
tipo	enumeração	O tipo da ferramenta de geração de imagem. Sempre `image_generation`. Valores possíveis: `image_generation`	Yes	image_generation

OpenAI.ImageGenToolInputImageMask

Name	Tipo	Description	Obrigatório	Default
file_id	cadeia		No
image_url	cadeia de caracteres (uri)		No

OpenAI.InlineSkillParam

Name	Tipo	Description	Obrigatório	Default
description	cadeia	A descrição da habilidade.	Yes
name	cadeia	O nome da habilidade.	Yes
fonte	OpenAI.InlineSkillSourceParam	Carga útil de habilidade inline	Yes
└─ dados	cadeia	Pacote zip de habilidades codificado em base64. Restrições: minComprimento: 1, maxComprimento: 70254592	Yes
└─ media_type	enumeração	O tipo de mídia da carga útil de habilidades inline. Deve ser `application/zip`. Valores possíveis: `application/zip`	Yes	application/zip
└─ tipo	enumeração	O tipo da fonte de habilidade inline. Deve ser `base64`. Valores possíveis: `base64`	Yes	base64
tipo	enumeração	Define uma habilidade inline para essa solicitação. Valores possíveis: `inline`	Yes	em linha

OpenAI.InlineSkillSourceParam

Carga útil de habilidade inline

Name	Tipo	Description	Obrigatório	Default
dados	cadeia	Pacote zip de habilidades codificado em base64. Restrições: minComprimento: 1, maxComprimento: 70254592	Yes
media_type	enumeração	O tipo de mídia da carga útil de habilidades inline. Deve ser `application/zip`. Valores possíveis: `application/zip`	Yes	application/zip
tipo	enumeração	O tipo da fonte de habilidade inline. Deve ser `base64`. Valores possíveis: `base64`	Yes	base64

OpenAI.InputFidelity

Controlar o esforço que o modelo exercerá para corresponder ao estilo e aos recursos, especialmente os recursos faciais, das imagens de entrada. Esse parâmetro é suportado apenas para gpt-image-1 e gpt-image-1.5 modelos posteriores, não suportados para gpt-image-1-mini. Suportes high e low. Usa low como padrão.

Property	Valor
Tipo	cadeia
Valores	`high` `low`

OpenAI.LocalShellToolParam

Ferramenta local de concha

Uma ferramenta que permite que o modelo execute comandos de shell em um ambiente local.

Name	Tipo	Description	Obrigatório	Default
tipo	enumeração	O tipo da ferramenta de shell local. Sempre `local_shell`. Valores possíveis: `local_shell`	Yes	local_shell

OpenAI.LocalSkillParam

Name	Tipo	Description	Obrigatório
description	cadeia	A descrição da habilidade.	Yes
name	cadeia	O nome da habilidade.	Yes
caminho	cadeia	O caminho para o diretório que contém a habilidade.	Yes

OpenAI.MCPTool

Ferramenta MCP

Forneça ao modelo acesso a ferramentas adicionais por meio de servidores remotos do Protocolo de Contexto de Modelo (MCP).

Name	Tipo	Description	Obrigatório
ferramentas_permitidas	matriz de cadeia de caracteres ou OpenAI.MCPToolFilter		No
autorização	cadeia	Um token de acesso OAuth que pode ser usado com um servidor MCP remoto, com uma URL de servidor MCP personalizada ou um conector de serviço. Seu aplicativo deve lidar com o fluxo de autorização OAuth e fornecer o token aqui.	No
connector_id	enumeração	Identificador para conectores de serviço, como aqueles disponíveis no ChatGPT. Um dos `server_url` ou `connector_id` deve ser fornecido. Saiba mais sobre o serviço conectores aqui. Os valores com `connector_id` suporte no momento são: -Dropbox: `connector_dropbox` -Gmail: `connector_gmail` - Google Calendário: `connector_googlecalendar` - Google Drive: `connector_googledrive` - Microsoft Teams: `connector_microsoftteams` - Calendário do Outlook: `connector_outlookcalendar` - Email do Outlook: `connector_outlookemail` -Sharepoint: `connector_sharepoint` Valores possíveis: `connector_dropbox`, , `connector_gmail`, `connector_googlecalendar`, `connector_googledrive`, `connector_microsoftteams`, `connector_outlookcalendar`, , , `connector_outlookemailconnector_sharepoint`	No
headers	objeto (anulável)		No
project_connection_id	cadeia	A ID de conexão no projeto para o servidor MCP. A conexão armazena a autenticação e outros detalhes de conexão necessários para se conectar ao servidor MCP.	No
requer_aprovação	OpenAI.MCPToolRequireApproval ou string		No
server_description	cadeia	Descrição opcional do servidor MCP, usada para fornecer mais contexto.	No
etiqueta_do_servidor	cadeia	Um rótulo para esse servidor MCP, usado para identificá-lo em chamadas de ferramenta.	Yes
URL_do_servidor	cadeia de caracteres (uri)	A URL do servidor MCP. Um de `server_url` ou `connector_id` deve ser Fornecido.	No
tipo	enumeração	O tipo da ferramenta MCP. Sempre `mcp`. Valores possíveis: `mcp`	Yes

OpenAI.MCPToolFilter

Filtro de ferramenta MCP

Um objeto de filtro para especificar quais ferramentas são permitidas.

Name	Tipo	Description	Obrigatório	Default
Read_only	boolean	Indica se uma ferramenta modifica ou não dados ou é somente leitura. Se um O servidor MCP é anotado com `readOnlyHint`, ele corresponderá a esse filtro.	No
tool_names	matriz de strings	Lista de nomes de ferramentas permitidos.	No

OpenAI.MCPToolRequireApproval

Name	Tipo	Description	Obrigatório	Default
Sempre	OpenAI.MCPToolFilter	Um objeto de filtro para especificar quais ferramentas são permitidas.	No
never	OpenAI.MCPToolFilter	Um objeto de filtro para especificar quais ferramentas são permitidas.	No

OpenAI.RankerVersionType

Property	Valor
Tipo	cadeia
Valores	`auto` `default-2024-11-15`

OpenAI.RankingOptions

Name	Tipo	Description	Obrigatório
hybrid_search	OpenAI.HybridSearchOptions		No
└─ embedding_weight	OpenAI.numeric	O peso da inserção na fusão de classificação recíproca.	Yes
└─ text_weight	OpenAI.numeric	O peso do texto na fusão de classificação recíproca.	Yes
classificador	OpenAI.RankerVersionType		No
limiar_de_pontuação	OpenAI.numeric		No

OpenAI.Reasoning

Reasoning

somente modelos gpt-5 e série o Opções de configuração para modelos de raciocínio.

Name	Tipo	Description	Obrigatório
Esforço	Esforço de Raciocínio da OpenAI	Restringe o esforço no raciocínio para modelos de raciocínio. Os valores com suporte no momento são `none`, , `minimal`, `low`, `medium`, `high`e `xhigh`. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados sobre o raciocínio em uma resposta. - `gpt-5.1` o padrão é `none`, que não executa o raciocínio. Os valores de raciocínio com suporte são`gpt-5.1`, e `nonelowmedium`.`high` Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. - Todos os modelos antes `gpt-5.1` do padrão para `medium` o esforço de raciocínio e não dão suporte `none`. - O `gpt-5-pro` modelo usa como padrão o esforço de raciocínio (e só dá `high` suporte). - `xhigh` há suporte para todos os modelos após `gpt-5.1-codex-max`.	No
generate_summary	enum (anulável)	Valores possíveis: `auto`, , `concisedetailed`	No
resumo	enum (anulável)	Valores possíveis: `auto`, , `concisedetailed`	No

Esforço de Raciocínio da OpenAI

Limita o esforço de raciocínio em modelos de raciocínio. Os valores com suporte no momento são none, , minimal, low, medium, highe xhigh. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta.

gpt-5.1 o padrão é none, que não executa o raciocínio. Os valores de raciocínio com suporte sãogpt-5.1, e nonelowmedium.high Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1.
Todos os modelos antes gpt-5.1 do padrão para medium o esforço de raciocínio e não dão suporte none.
O gpt-5-pro modelo usa como padrão o esforço de raciocínio (e só dá high suporte).
xhigh há suporte para todos os modelos após gpt-5.1-codex-max.

Property	Valor
Tipo	cadeia
Nulável	Yes
Valores	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ResponseFormatJsonSchemaSchema

Esquema JSON

O esquema para o formato de resposta, descrito como um objeto de Esquema JSON. Saiba como criar esquemas JSON aqui.

Tipo: objeto

OpenAI.SearchContextSize

Property	Valor
Tipo	cadeia
Valores	`low` `medium` `high`

OpenAI.SkillReferenceParam

Name	Tipo	Description	Obrigatório	Default
skill_id	cadeia	O ID da habilidade mencionada. Restrições: minLength: 1, maxLength: 64	Yes
tipo	enumeração	Faz referência a uma habilidade criada com o endpoint /v1/skills. Valores possíveis: `skill_reference`	Yes	skill_reference
versão	cadeia	Versão opcional de habilidade. Use um inteiro positivo ou 'mais recente'. Omita o padrão de nome.	No

OpenAI.SpecificApplyPatchParam

Escolha específica de ferramenta de aplicação

Força o modelo a chamar a ferramenta apply_patch ao executar uma chamada de ferramenta.

Name	Tipo	Description	Obrigatório	Default
tipo	enumeração	A ferramenta a ser chamada. Sempre `apply_patch`. Valores possíveis: `apply_patch`	Yes	apply_patch

OpenAI.SpecificFunctionShellParam

Escolha específica da ferramenta shell

Força o modelo a chamar a ferramenta de shell quando uma chamada de ferramenta é necessária.

Name	Tipo	Description	Obrigatório	Default
tipo	enumeração	A ferramenta a ser chamada. Sempre `shell`. Valores possíveis: `shell`	Yes	shell

OpenAI.TextResponseFormatConfiguration

Um objeto que especifica o formato que o modelo deve gerar. A configuração { "type": "json_schema" } habilita saídas estruturadas, o que garante que o modelo corresponda ao esquema JSON fornecido. Saiba mais no

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" } ativar o modo JSON mais antigo, que garante que a mensagem gerada pelo modelo seja JSON válida. O uso json_schema é preferencial para modelos que dão suporte a ele.

Discriminador para OpenAI.TextResponseFormatConfiguration

Esse componente usa a propriedade type para discriminar entre diferentes tipos:

Valor do tipo	Schema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	Tipo	Description	Obrigatório	Default
tipo	OpenAI.TextResponseFormatConfigurationType		Yes

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Objeto JSON

Formato de resposta de objeto JSON. Um método mais antigo de geração de respostas JSON. O uso json_schema é recomendado para modelos que dão suporte a ele. Observe que o modelo não gerará JSON sem uma mensagem do sistema ou do usuário instruindo-o a fazer isso.

Name	Tipo	Description	Obrigatório	Default
tipo	enumeração	O tipo de formato de resposta que está sendo definido. Sempre `json_object`. Valores possíveis: `json_object`	Yes

OpenAI.TextResponseFormatConfigurationResponseFormatText

Texto

Formato de resposta padrão. Usado para gerar respostas de texto.

Name	Tipo	Description	Obrigatório	Default
tipo	enumeração	O tipo de formato de resposta que está sendo definido. Sempre `text`. Valores possíveis: `text`	Yes

OpenAI.TextResponseFormatConfigurationType

Property	Valor
Tipo	cadeia
Valores	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

Esquema JSON

Formato de resposta de esquema JSON. Usado para gerar respostas JSON estruturadas.

Name	Tipo	Description	Obrigatório
description	cadeia	Uma descrição do formato de resposta, usado pelo modelo para determinar como responder no formato.	No
name	cadeia	O nome do formato de resposta. Deve ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com um comprimento máximo de 64.	Yes
esquema	OpenAI.ResponseFormatJsonSchemaSchema	O esquema para o formato de resposta, descrito como um objeto de Esquema JSON. Saiba como criar esquemas JSON aqui.	Yes
rigoroso	booliano (anulável)		No
tipo	enumeração	O tipo de formato de resposta que está sendo definido. Sempre `json_schema`. Valores possíveis: `json_schema`	Yes

OpenAI.Tool

Uma ferramenta que pode ser usada para gerar uma resposta.

Discriminador para OpenAI.Tool

Esse componente usa a propriedade type para discriminar entre diferentes tipos:

Valor do tipo	Schema
`bing_grounding`	BingGroundingTool
`fabric_dataagent_preview`	MicrosoftFabricPreviewTool
`sharepoint_grounding_preview`	SharepointPreviewTool
`azure_ai_search`	AzureAISearchTool
`openapi`	OpenApiTool
`bing_custom_search_preview`	BingCustomSearchPreviewTool
`browser_automation_preview`	BrowserAutomationPreviewTool
`azure_function`	AzureFunctionTool
`capture_structured_outputs`	CaptureStructuredOutputsTool
`a2a_preview`	A2APreviewTool
`memory_search_preview`	MemorySearchPreviewTool
`code_interpreter`	OpenAI.CodeInterpreterTool
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search`	OpenAI.WebSearchTool
`mcp`	OpenAI.MCPTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellToolParam
`shell`	OpenAI.FunctionShellToolParam
`custom`	OpenAI.CustomToolParam
`web_search_preview`	OpenAI.WebSearchPreviewTool
`apply_patch`	OpenAI.ApplyPatchToolParam

Name	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ToolType		Yes

OpenAI.ToolChoiceAllowed

Ferramentas permitidas

Restringe as ferramentas disponíveis para o modelo a um conjunto predefinido.

Name	Tipo	Description	Obrigatório
mode	enumeração	Restringe as ferramentas disponíveis para o modelo a um conjunto predefinido. `auto` permite que o modelo escolha entre as ferramentas permitidas e gere um mensagem. `required` requer que o modelo chame uma ou mais das ferramentas permitidas. Valores possíveis: `auto`, `required`	Yes
tools	matriz de objeto	Uma lista de definições de ferramentas que o modelo deve ter permissão para chamar. Para a API de Respostas, a lista de definições de ferramentas pode ser semelhante a: `json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br>`	Yes
tipo	enumeração	Tipo de configuração de ferramenta permitido. Sempre `allowed_tools`. Valores possíveis: `allowed_tools`	Yes

OpenAI.ToolChoiceCodeInterpreter

Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas internas.

Name	Tipo	Description	Obrigatório	Default
tipo	enumeração	Valores possíveis: `code_interpreter`	Yes

OpenAI.ToolChoiceComputerUsePreview

Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas internas.

Name	Tipo	Description	Obrigatório	Default
tipo	enumeração	Valores possíveis: `computer_use_preview`	Yes

OpenAI.ToolChoiceCustom

Ferramenta personalizada

Use essa opção para forçar o modelo a chamar uma ferramenta personalizada específica.

Name	Tipo	Description	Obrigatório	Default
name	cadeia	O nome da ferramenta personalizada a ser chamada.	Yes
tipo	enumeração	Para chamada de ferramenta personalizada, o tipo é sempre `custom`. Valores possíveis: `custom`	Yes

OpenAI.ToolChoiceFileSearch

Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas internas.

Name	Tipo	Description	Obrigatório	Default
tipo	enumeração	Valores possíveis: `file_search`	Yes

OpenAI.ToolChoiceFunction

Ferramenta de função

Use essa opção para forçar o modelo a chamar uma função específica.

Name	Tipo	Description	Obrigatório	Default
name	cadeia	O nome da função a ser chamada.	Yes
tipo	enumeração	Para a chamada de função, o tipo é sempre `function`. Valores possíveis: `function`	Yes

OpenAI.ToolChoiceImageGeneration

Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas internas.

Name	Tipo	Description	Obrigatório	Default
tipo	enumeração	Valores possíveis: `image_generation`	Yes

OpenAI.ToolChoiceMCP

Ferramenta MCP

Use essa opção para forçar o modelo a chamar uma ferramenta específica em um servidor MCP remoto.

Name	Tipo	Description	Obrigatório
name	cadeia de caracteres (anulável)		No
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP a ser usado.	Yes
tipo	enumeração	Para ferramentas MCP, o tipo é sempre `mcp`. Valores possíveis: `mcp`	Yes

OpenAI.ToolChoiceParam

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.

Discriminador para OpenAI.ToolChoiceParam

Esse componente usa a propriedade type para discriminar entre diferentes tipos:

Valor do tipo	Schema
`allowed_tools`	OpenAI.ToolChoiceAllowed
`function`	OpenAI.ToolChoiceFunction
`mcp`	OpenAI.ToolChoiceMCP
`custom`	OpenAI.ToolChoiceCustom
`apply_patch`	OpenAI.SpecificApplyPatchParam
`shell`	OpenAI.SpecificFunctionShellParam
`file_search`	OpenAI.ToolChoiceFileSearch
`web_search_preview`	OpenAI.ToolChoiceWebSearchPreview
`computer_use_preview`	OpenAI.ToolChoiceComputerUsePreview
`web_search_preview_2025_03_11`	OpenAI.ToolChoiceWebSearchPreview20250311
`image_generation`	OpenAI.ToolChoiceImageGeneration
`code_interpreter`	OpenAI.ToolChoiceCodeInterpreter

Name	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ToolChoiceParamType		Yes

OpenAI.ToolChoiceParamType

Property	Valor
Tipo	cadeia
Valores	`allowed_tools` `function` `mcp` `custom` `apply_patch` `shell` `file_search` `web_search_preview` `computer_use_preview` `web_search_preview_2025_03_11` `image_generation` `code_interpreter`

OpenAI.ToolChoiceWebSearchPreview

Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas internas.

Name	Tipo	Description	Obrigatório	Default
tipo	enumeração	Valores possíveis: `web_search_preview`	Yes

OpenAI.ToolChoiceWebSearchPreview20250311

Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas internas.

Name	Tipo	Description	Obrigatório	Default
tipo	enumeração	Valores possíveis: `web_search_preview_2025_03_11`	Yes

OpenAI.ToolType

Property Valor

Tipo cadeia

Valores function
file_search
computer_use_preview
web_search
mcp
code_interpreter
image_generation
local_shell
shell
custom
web_search_preview
apply_patch
a2a_preview
bing_custom_search_preview
browser_automation_preview
fabric_dataagent_preview
sharepoint_grounding_preview
memory_search_preview
azure_ai_search
azure_function
bing_grounding
capture_structured_outputs
openapi

OpenAI.WebSearchApproximateLocation

Localização aproximada na busca na web

O local aproximado do usuário.

Name	Tipo	Description	Obrigatório	Default
city	cadeia de caracteres (anulável)		No
country	cadeia de caracteres (anulável)		No
região	cadeia de caracteres (anulável)		No
timezone	cadeia de caracteres (anulável)		No
tipo	enumeração	O tipo de aproximação de local. Sempre `approximate`. Valores possíveis: `approximate`	Yes	aproximado

OpenAI.WebSearchPreviewTool

Prévia de busca na web

Essa ferramenta pesquisa na Web resultados relevantes a serem usados em uma resposta. Saiba mais sobre a ferramenta de pesquisa na Web.

Name	Tipo	Description	Obrigatório	Default
tamanho_do_contexto_de_busca	OpenAI.SearchContextSize		No
tipo	enumeração	O tipo da ferramenta de pesquisa na Web. Um dos `web_search_preview` ou `web_search_preview_2025_03_11`. Valores possíveis: `web_search_preview`	Yes	web_search_preview
localização_do_usuario	OpenAI.ApproximateLocation (anulável)		No
└─ cidade	cadeia de caracteres (anulável)		No
└─ país	cadeia de caracteres (anulável)		No
└─ região	cadeia de caracteres (anulável)		No
└─ fuso horário	cadeia de caracteres (anulável)		No
└─ tipo	enumeração	O tipo de aproximação de local. Sempre `approximate`. Valores possíveis: `approximate`	Yes	aproximado

OpenAI.WebSearchTool

Pesquisa na Web

Pesquise na Internet fontes relacionadas ao prompt. Saiba mais sobre a ferramenta de busca na web.

Name	Tipo	Description	Obrigatório	Default
custom_search_configuration	WebSearchConfiguration	Uma configuração de pesquisa na Web para pesquisa personalizada do bing	No
└─ instance_name	cadeia	Nome da instância de configuração personalizada fornecida à configuração.	Yes
└─ project_connection_id	cadeia	Project id de conexão para aterramento com a pesquisa personalizada do bing	Yes
filters	OpenAI.WebSearchToolFilters (anulável)		No
└─ allowed_domains	matriz de cadeia de caracteres (anulável)		No
tamanho_do_contexto_de_busca	enumeração	Diretrizes de alto nível para a quantidade de espaço de janela de contexto a ser usada para a pesquisa. Uma opção entre `low`, `medium` ou `high`. `medium` é o padrão. Valores possíveis: `low`, , `mediumhigh`	No	meio
tipo	enumeração	O tipo da ferramenta de pesquisa na Web. Um dos `web_search` ou `web_search_2025_08_26`. Valores possíveis: `web_search`	Yes	pesquisa na web
localização_do_usuario	OpenAI.WebSearchApproximateLocation (anulável)	O local aproximado do usuário.	No
└─ cidade	cadeia de caracteres (anulável)		No
└─ país	cadeia de caracteres (anulável)		No
└─ região	cadeia de caracteres (anulável)		No
└─ fuso horário	cadeia de caracteres (anulável)		No
└─ tipo	enumeração	O tipo de aproximação de local. Sempre `approximate`. Valores possíveis: `approximate`	Yes	aproximado

OpenAI.WebSearchToolFilters

Name	Tipo	Description	Obrigatório	Default
allowed_domains	matriz de cadeia de caracteres (anulável)		No

OpenAI.integer

Tipo: inteiro

Formato: int64

OpenAI.numeric

Tipo: número

Formato: duplo

OpenApiAnonymousAuthDetails

Detalhes de segurança para autenticação anônima do OpenApi

Name	Tipo	Description	Obrigatório	Default
tipo	enumeração	O tipo de objeto, que é sempre 'anônimo'. Valores possíveis: `anonymous`	Yes

OpenApiAuthDetails

detalhes de autenticação para OpenApiFunctionDefinition

Discriminador para OpenApiAuthDetails

Esse componente usa a propriedade type para discriminar entre diferentes tipos:

Valor do tipo	Schema
`anonymous`	OpenApiAnonymousAuthDetails
`project_connection`	OpenApiProjectConnectionAuthDetails
`managed_identity`	OpenApiManagedAuthDetails

Name	Tipo	Description	Obrigatório	Default
tipo	OpenApiAuthType	Tipo de autenticação para o ponto de extremidade OpenApi. Os tipos permitidos são: – Anônimo (nenhuma autenticação necessária) - Project Connection (requer project_connection_id para o ponto de extremidade, como configuração na AI Foundry) - Managed_Identity (requer audiência para autenticação baseada em identidade)	Yes

OpenApiAuthType

Tipo de autenticação para o ponto de extremidade OpenApi. Os tipos permitidos são:

Anônimo (nenhuma autenticação necessária)
Project Connection (requer project_connection_id para o ponto de extremidade, como configuração na AI Foundry)
Managed_Identity (requer audiência para autenticação baseada em identidade)

Property	Valor
Description	Tipo de autenticação para o ponto de extremidade OpenApi. Os tipos permitidos são: – Anônimo (nenhuma autenticação necessária) - Project Connection (requer project_connection_id para o ponto de extremidade, como configuração na AI Foundry) - Managed_Identity (requer audiência para autenticação baseada em identidade)
Tipo	cadeia
Valores	`anonymous` `project_connection` `managed_identity`

OpenApiFunctionDefinition

As informações de definição de entrada para uma função openapi.

Name	Tipo	Description	Obrigatório
auth	OpenApiAuthDetails	detalhes de autenticação para OpenApiFunctionDefinition	Yes
└─ tipo	OpenApiAuthType	O tipo de autenticação deve ser anônimo/project_connection/managed_identity	Yes
default_params	matriz de strings	Lista de parâmetros de especificação OpenAPI que usarão padrões fornecidos pelo usuário	No
description	cadeia	Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função.	No
functions	matriz de objeto (somente leitura)	Lista de definições de função usadas pela ferramenta OpenApi	No
name	cadeia	O nome da função a ser chamada.	Yes
spec	objeto	A forma da função openapi, descrita como um objeto de esquema JSON.	Yes

OpenApiManagedAuthDetails

Detalhes de segurança para autenticação de managed_identity OpenApi

Name	Tipo	Description	Obrigatório
security_scheme	OpenApiManagedSecurityScheme	Esquema de segurança para autenticação de managed_identity OpenApi	Yes
└─ audiência	cadeia	Escopo de autenticação para managed_identity tipo de autenticação	Yes
tipo	enumeração	O tipo de objeto, que é sempre 'managed_identity'. Valores possíveis: `managed_identity`	Yes

OpenApiManagedSecurityScheme

Esquema de segurança para autenticação de managed_identity OpenApi

Name	Tipo	Description	Obrigatório	Default
Público	cadeia	Escopo de autenticação para managed_identity tipo de autenticação	Yes

OpenApiProjectConnectionAuthDetails

Detalhes de segurança da autenticação de conexão do projeto OpenApi

Name	Tipo	Description	Obrigatório
security_scheme	OpenApiProjectConnectionSecurityScheme	Esquema de segurança para autenticação de managed_identity OpenApi	Yes
└─ project_connection_id	cadeia	Project id de conexão para o tipo de autenticação de conexão Project	Yes
tipo	enumeração	O tipo de objeto, que é sempre 'project_connection'. Valores possíveis: `project_connection`	Yes

OpenApiProjectConnectionSecurityScheme

Esquema de segurança para autenticação de managed_identity OpenApi

Name	Tipo	Description	Obrigatório	Default
project_connection_id	cadeia	Project id de conexão para o tipo de autenticação de conexão Project	Yes

OpenApiTool

As informações de definição de entrada para uma ferramenta OpenAPI, conforme usado para configurar um agente.

Name	Tipo	Description	Obrigatório
Openapi	OpenApiFunctionDefinition	As informações de definição de entrada para uma função openapi.	Yes
└─ autenticação	OpenApiAuthDetails	Abrir detalhes de autenticação de API	Yes
└─ default_params	matriz de strings	Lista de parâmetros de especificação OpenAPI que usarão padrões fornecidos pelo usuário	No
└─ descrição	cadeia	Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função.	No
└─ funções	matriz de objeto (somente leitura)	Lista de definições de função usadas pela ferramenta OpenApi	No
└─ descrição	cadeia	Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função.	No
└─ nome	cadeia	O nome da função a ser chamada.	Yes
└─ parâmetros	objeto	Os parâmetros que as funções aceitam, descritos como um objeto de Esquema JSON.	Yes
└─ nome	cadeia	O nome da função a ser chamada.	Yes
└─ especificação	objeto	A forma da função openapi, descrita como um objeto de esquema JSON.	Yes
tipo	enumeração	O tipo de objeto, que é sempre 'openapi'. Valores possíveis: `openapi`	Yes

Pageorder

Property	Valor
Tipo	cadeia
Valores	`asc` `desc`

PromptAgentDefinition

A definição do agente de prompt

Name	Tipo	Description	Obrigatório	Default
instructions	cadeia de caracteres (anulável)	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo.	No
variante	enumeração	Valores possíveis: `prompt`	Yes
modelo	cadeia	A implantação de modelo a ser usada para este agente.	Yes
rai_config	RaiConfig	Configuração dos recursos de filtragem de conteúdo e segurança da RAI (Configuração para IA Responsável).	No
└─ rai_policy_name	cadeia	O nome da política RAI a ser aplicada.	Yes
reasoning	OpenAI.Reasoning (anulável)	somente modelos gpt-5 e série o Opções de configuração para modelos de raciocínio.	No
└─ esforço	Esforço de Raciocínio da OpenAI	Restringe o esforço no raciocínio para modelos de raciocínio. Os valores com suporte no momento são `none`, , `minimal`, `low`, `medium`, `high`e `xhigh`. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados sobre o raciocínio em uma resposta. - `gpt-5.1` o padrão é `none`, que não executa o raciocínio. Os valores de raciocínio com suporte são`gpt-5.1`, e `nonelowmedium`.`high` Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. - Todos os modelos antes `gpt-5.1` do padrão para `medium` o esforço de raciocínio e não dão suporte `none`. - O `gpt-5-pro` modelo usa como padrão o esforço de raciocínio (e só dá `high` suporte). - `xhigh` há suporte para todos os modelos após `gpt-5.1-codex-max`.	No
└─ gerar_resumo	enum (anulável)	Valores possíveis: `auto`, , `concisedetailed`	No
└─ resumo	enum (anulável)	Valores possíveis: `auto`, , `concisedetailed`	No
structured_inputs	objeto	Conjunto de entradas estruturadas que podem participar de substituição de modelo de prompt ou associações de argumento de ferramenta.	No
Temperatura	número (flutuante) (anulável)	Qual temperatura de amostragem usar, 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 isso ou `top_p` , mas não ambos. Restrições: mínimo: 0, máximo: 2	No	1
enviar SMS	PromptAgentDefinitionTextOptions	Opções de configuração para uma resposta de texto do modelo. Pode ser texto sem formatação ou dados JSON estruturados.	No
└─ Formato	OpenAI.TextResponseFormatConfiguration	Um objeto que especifica o formato que o modelo deve gerar. `{ "type": "json_schema" }` Configurar habilita saídas estruturadas, que garante que o modelo corresponda ao esquema JSON fornecido. Saiba mais no O formato padrão é `{ "type": "text" }` sem opções adicionais. Não recomendado para modelos gpt-4o e mais recentes: Definir para `{ "type": "json_object" }` habilita o modo JSON mais antigo, que garante que a mensagem gerada pelo modelo seja JSON válida. Usando `json_schema` é preferencial para modelos que dão suporte a isso.	No
tool_choice	string ou OpenAI.ToolChoiceParam	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.	No
tools	matriz de 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.	No
top_p	número (flutuante) (anulável)	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa apenas os tokens que compõem os 10% superiores da massa de probabilidade%. são considerados. Geralmente recomendamos alterar isso ou `temperature` , mas não ambos. Restrições: min: 0, max: 1	No	1

PromptAgentDefinitionTextOptions

Opções de configuração para uma resposta de texto do modelo. Pode ser texto sem formatação ou dados JSON estruturados.

Name	Tipo	Description	Obrigatório	Default
format	OpenAI.TextResponseFormatConfiguration	Um objeto que especifica o formato que o modelo deve gerar. `{ "type": "json_schema" }` Configurar habilita saídas estruturadas, que garante que o modelo corresponda ao esquema JSON fornecido. Saiba mais no O formato padrão é `{ "type": "text" }` sem opções adicionais. Não recomendado para modelos gpt-4o e mais recentes: Definir para `{ "type": "json_object" }` habilita o modo JSON mais antigo, que garante que a mensagem gerada pelo modelo seja JSON válida. Usando `json_schema` é preferencial para modelos que dão suporte a isso.	No

ProtocolVersionRecord

Um mapeamento de registro para um único protocolo e sua versão.

Name	Tipo	Description	Obrigatório	Default
protocolo	AgentProtocol		Yes
versão	cadeia	A cadeia de caracteres de versão do protocolo, por exemplo, 'v0.1.1'.	Yes

RaiConfig

Configuração dos recursos de filtragem de conteúdo e segurança da RAI (Configuração para IA Responsável).

Name	Tipo	Description	Obrigatório	Default
rai_policy_name	cadeia	O nome da política RAI a ser aplicada.	Yes

SharepointGroundingToolParameters

Os parâmetros da ferramenta de aterramento do sharepoint.

Name	Tipo	Description	Obrigatório	Default
project_connections	matriz de ToolProjectConnection	As conexões de projeto anexadas a essa ferramenta. Pode haver um máximo de 1 conexão recurso anexado à ferramenta. Restrições: maxItems: 1	No

SharepointPreviewTool

As informações de definição de entrada para uma ferramenta do sharepoint, conforme usado para configurar um agente.

Name	Tipo	Description	Obrigatório
sharepoint_grounding_preview	SharepointGroundingToolParameters	Os parâmetros da ferramenta de aterramento do sharepoint.	Yes
└─ project_connections	matriz de ToolProjectConnection	As conexões de projeto anexadas a essa ferramenta. Pode haver um máximo de 1 conexão recurso anexado à ferramenta. Restrições: maxItems: 1	No
tipo	enumeração	O tipo de objeto, que é sempre 'sharepoint_grounding_preview'. Valores possíveis: `sharepoint_grounding_preview`	Yes

StructuredInputDefinition

Uma entrada estruturada que pode participar de substituições de modelo de prompt e associação de argumentos de ferramenta.

Name	Tipo	Description	Obrigatório	Default
default_value		O valor padrão da entrada se nenhum valor em tempo de execução for fornecido.	No
description	cadeia	Uma descrição legível por humanos da entrada.	No
required	boolean	Se a propriedade de entrada é necessária quando o agente é invocado.	No	Falso
esquema	objeto	O esquema JSON para a entrada estruturada (opcional).	No

StructuredOutputDefinition

Uma saída estruturada que pode ser produzida pelo agente.

Name	Tipo	Description	Obrigatório
description	cadeia	Uma descrição da saída a ser emitida. Usado pelo modelo para determinar quando emitir a saída.	Yes
name	cadeia	O nome da saída estruturada.	Yes
esquema	objeto	O esquema JSON para a saída estruturada.	Yes
rigoroso	booliano (anulável)	Se a validação estrita deve ser imposta. Padrão `true`.	Yes

ToolProjectConnection

Um recurso de conexão de projeto.

Name	Tipo	Description	Obrigatório	Default
project_connection_id	cadeia	Uma conexão de projeto em um ToolProjectConnectionList anexado a essa ferramenta.	Yes

UpdateAgentFromManifestRequest

Name	Tipo	Description	Obrigatório
description	cadeia	Uma descrição legível por humanos do agente. Restrições: maxLength: 512	No
manifest_id	cadeia	A ID do manifesto da qual importar a versão do agente.	Yes
metadados	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No
parameter_values	objeto	As entradas para o manifesto que resultarão em um Agente totalmente materializado.	Yes

UpdateAgentRequest

Name	Tipo	Description	Obrigatório
definição	AgentDefinition		Yes
└─ tipo	AgentKind		Yes
└─ rai_config	RaiConfig	Configuração dos recursos de filtragem de conteúdo e segurança da RAI (Configuração para IA Responsável).	No
description	cadeia	Uma descrição legível por humanos do agente. Restrições: maxLength: 512	No
metadados	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No

WebSearchConfiguration

Uma configuração de pesquisa na Web para pesquisa personalizada do bing

Name	Tipo	Description	Obrigatório	Default
instance_name	cadeia	Nome da instância de configuração personalizada fornecida à configuração.	Yes
project_connection_id	cadeia	Project id de conexão para aterramento com a pesquisa personalizada do bing	Yes

WorkflowAgentDefinition

A definição do agente de fluxo de trabalho.

Name	Tipo	Description	Obrigatório
variante	enumeração	Valores possíveis: `workflow`	Yes
rai_config	RaiConfig	Configuração dos recursos de filtragem de conteúdo e segurança da RAI (Configuração para IA Responsável).	No
└─ rai_policy_name	cadeia	O nome da política RAI a ser aplicada.	Yes
fluxo de trabalho	cadeia	A definição de YAML do CSDL do fluxo de trabalho.	No

Last updated on 2026-06-01