Microsoft Foundry

Versão da API: v1

Authentication

Fluxo: implícito

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

Escopos:

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

Agents

Agentes – criar agente

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

Cria o agente.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Falso	cadeia Valores possíveis: `ContainerAgents=V1Preview`, , `HostedAgents=V1PreviewWorkflowAgents=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

Nome	Tipo	Description	Obrigatório
definição	AgentDefinition		Yes
└─ tipo	AgentKind		Yes
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).	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
nome	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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	AgentObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Agentes – listar agentes

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

Retorna a lista de todos os agentes.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
kind	consulta	No	cadeia Valores possíveis: `prompt`, , `hosted`, `container_appworkflow`	Filtrar agentes por tipo. Se não for fornecido, todos os agentes serão retornados.
limit	consulta	No	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
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.
Depois	consulta	No	cadeia	Um cursor para uso na paginação. `after` é uma 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.
before	consulta	No	cadeia	Um cursor para uso na paginação. `before` é uma 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.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Responses

Código de status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Agentes – obter agente

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

Recupera o agente.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	AgentObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	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 alguma alteração na definição do agente. Se nenhuma alteração, retorna a versão existente do agente.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Falso	cadeia Valores possíveis: `ContainerAgents=V1Preview`, , `HostedAgents=V1PreviewWorkflowAgents=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

Nome	Tipo	Description	Obrigatório
definição	AgentDefinition		Yes
└─ tipo	AgentKind		Yes
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).	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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	AgentObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Agentes – excluir agente

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

Exclui um agente.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	DeleteAgentResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	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, retorna a versão existente do agente.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	AgentObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	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

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Falso	cadeia Valores possíveis: `ContainerAgents=V1Preview`, , `HostedAgents=V1PreviewWorkflowAgents=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

Nome	Tipo	Description	Obrigatório
definição	AgentDefinition		Yes
└─ tipo	AgentKind		Yes
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).	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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	AgentVersionObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	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

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
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.
Depois	consulta	No	cadeia	Um cursor para uso na paginação. `after` é uma 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.
before	consulta	No	cadeia	Um cursor para uso na paginação. `before` é uma 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.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Responses

Código de status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	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

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	AgentVersionObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	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

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	DeleteAgentVersionResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	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

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	AgentVersionObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	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

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	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
nome	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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	AgentObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Contêineres de agente

Contêineres do agente – listar operações de contêiner do agente

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

Listar operações de contêiner para um agente.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
limit	consulta	No	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
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.
Depois	consulta	No	cadeia	Um cursor para uso na paginação. `after` é uma 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.
before	consulta	No	cadeia	Um cursor para uso na paginação. `before` é uma 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.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Contêineres do agente – obter operação de contêiner do agente

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

Obtenha o status de uma operação de contêiner para um agente.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
operation_id	caminho	Yes	cadeia	A ID da operação.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	AgentContainerOperationObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Contêineres do agente – obter contêiner do agente

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

Obtenha um contêiner para uma versão específica de um agente.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
agent_version	caminho	Yes	cadeia	A versão do agente.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	AgentContainerObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Contêineres do agente – listar operações de contêiner de versão do agente

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

Listar operações de contêiner para uma versão específica de um agente.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
agent_version	caminho	Yes	cadeia	A versão do agente.
limit	consulta	No	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
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.
Depois	consulta	No	cadeia	Um cursor para uso na paginação. `after` é uma 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.
before	consulta	No	cadeia	Um cursor para uso na paginação. `before` é uma 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.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Contêineres do agente – excluir contêiner do agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=v1

Exclua um contêiner para uma versão específica de um agente. Se o contêiner não existir, a operação será no-op. A operação é uma operação de execução prolongada. Seguindo as diretrizes de design para operações de execução longa nas APIs REST Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
agent_version	caminho	Yes	cadeia	A versão do agente.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

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

Responses

Código de status: 202

Descrição: a solicitação foi aceita para processamento, mas o processamento ainda não foi concluído.

Tipo de conteúdo	Type	Description
application/json	AgentContainerOperationObject

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
Operação-Localização	cadeia

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Contêineres do agente – logs de contêiner do agente de fluxo

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:logstream?api-version=v1

Entrada de log de contêiner transmitida do contêiner como partes de texto. Cada parte é uma cadeia de caracteres UTF-8 que pode ser uma linha de log de texto sem formatação ou uma entrada de log formatada em JSON, dependendo do tipo de log de contêiner que está sendo transmitido. Os clientes devem tratar cada parte como texto opaco e, se necessário, tentar analisá-la como JSON com base em seus requisitos de registro em log.

Para logs do sistema, o formato é JSON com a seguinte estrutura: {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Connecting to the events collector...","Reason":"StartingGettingEvent "EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Com êxito conectado a eventos server","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1}

Para logs de console, o formato é texto sem formatação, conforme emitido pelo stdout/stderr do contêiner. 2025-12-15T08:43:48.72656 Conectando-se ao contêiner 'agent-container'... 2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
agent_version	caminho	Yes	cadeia	A versão do agente.
kind	consulta	No	cadeia Valores possíveis: `console`, `system`	o console retorna stdout/stderr de contêiner, o sistema retorna o fluxo de eventos do aplicativo de contêiner. padrões para o console
replica_name	consulta	No	cadeia	Quando este é omitido, o servidor escolhe a primeira réplica para os logs do console. Necessário para direcionar uma réplica específica.
cauda	consulta	No	inteiro	Número de linhas finais retornadas. Imposto a 1-300. O padrão é 20
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Contêineres do agente – iniciar contêiner do agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=v1

Inicie um contêiner para uma versão específica de um agente. Se o contêiner já estiver em execução, a operação será no-op. A operação é uma operação de execução prolongada. Seguindo as diretrizes de design para operações de execução longa nas APIs REST Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
agent_version	caminho	Yes	cadeia	A versão do agente.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Falso	cadeia Valores possíveis: `ContainerAgents=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

Nome	Tipo	Description	Obrigatório	Default
max_replicas	inteiro	O número máximo de réplicas. O valor padrão é 1.	No	1
min_replicas	inteiro	O número mínimo de réplicas. O valor padrão é 1.	No	1

Responses

Código de status: 202

Descrição: a solicitação foi aceita para processamento, mas o processamento ainda não foi concluído.

Tipo de conteúdo	Type	Description
application/json	AgentContainerOperationObject

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
Operação-Localização	cadeia

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Contêineres do agente – interromper contêiner do agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=v1

Interrompa um contêiner para uma versão específica de um agente. Se o contêiner não estiver em execução ou já parado, a operação será no-op. A operação é uma operação de execução prolongada. Seguindo as diretrizes de design para operações de execução longa nas APIs REST Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
agent_version	caminho	Yes	cadeia	A versão do agente.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

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

Responses

Código de status: 202

Descrição: a solicitação foi aceita para processamento, mas o processamento ainda não foi concluído.

Tipo de conteúdo	Type	Description
application/json	AgentContainerOperationObject

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
Operação-Localização	cadeia

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Contêineres do agente – atualizar contêiner do agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=v1

Atualize um contêiner para uma versão específica de um agente. Se o contêiner não estiver rodando, a operação será no-op. A operação é uma operação de execução prolongada. Seguindo as diretrizes de design para operações de execução longa nas APIs REST Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
agent_version	caminho	Yes	cadeia	A versão do agente.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Falso	cadeia Valores possíveis: `ContainerAgents=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

Nome	Tipo	Description	Obrigatório	Default
max_replicas	inteiro	O número máximo de réplicas.	No
min_replicas	inteiro	O número mínimo de réplicas.	No

Responses

Código de status: 202

Descrição: a solicitação foi aceita para processamento, mas o processamento ainda não foi concluído.

Tipo de conteúdo	Type	Description
application/json	AgentContainerOperationObject

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
Operação-Localização	cadeia

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Connections

Conexões – lista

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

Listar todas as conexões no projeto, sem preencher credenciais de conexão

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
tipo de conexão	consulta	No	cadeia Valores possíveis: `AzureOpenAI`, , `AzureBlob`, `AzureStorageAccount`, `CognitiveSearch`, `CosmosDB`, `ApiKey`, , `AppConfig`, `AppInsights`, , , , `CustomKeysRemoteTool_Preview`	Listar conexões desse tipo específico
defaultConnection	consulta	No	boolean	Listar conexões que são conexões padrão

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id	Falso	cadeia	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	PagedConnection

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-client-request-id		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Conexões – obter

GET {endpoint}/connections/{name}?api-version=v1

Obter uma conexão por nome, sem preencher credenciais de conexão

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome amigável da conexão, fornecido pelo usuário.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id	Falso	cadeia	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	Connection

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-client-request-id		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Conexões – obter credenciais

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=v1

Obter uma conexão por nome, com suas credenciais de conexão

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome amigável da conexão, fornecido pelo usuário.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id	Falso	cadeia	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	Connection

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-client-request-id		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Datasets

Conjuntos de dados – listar mais recente

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

Listar a versão mais recente de cada DatasetVersion

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	PagedDatasetVersion

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Conjuntos de dados – versões de lista

GET {endpoint}/datasets/{name}/versions?api-version=v1

Listar todas as versões do DatasetVersion especificado

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	PagedDatasetVersion

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Conjuntos de dados – obter versão

GET {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Obtenha a versão específica do DatasetVersion. O serviço retornará o erro 404 Not Found se o DatasetVersion não existir.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A ID de versão específica do DatasetVersion a ser recuperado.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	DatasetVersion

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Conjuntos de dados – excluir versão

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Exclua a versão específica do DatasetVersion. O serviço retornará 204 Sem Conteúdo se o DatasetVersion tiver sido excluído com êxito ou se o DatasetVersion não existir.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A versão do DatasetVersion a ser excluída.

Responses

Código de status: 204

Descrição: não há conteúdo a ser enviado para essa solicitação, mas os cabeçalhos podem ser úteis.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Conjuntos de dados – criar ou atualizar a versão

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Criar um novo ou atualizar um DatasetVersion existente com a ID de versão fornecida

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A ID de versão específica do DatasetVersion a ser criada ou atualizada.

Corpo da solicitação

Tipo de Conteúdo: application/merge-patch+json

Nome	Tipo	Description	Obrigatório
description	cadeia	O texto de descrição do ativo.	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No
tipo	DatasetType	Enumerar para determinar o tipo de dados.	Yes

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	DatasetVersion

Código de status: 201

Descrição: a solicitação foi bem-sucedida e um novo recurso foi criado como resultado.

Tipo de conteúdo	Type	Description
application/json	DatasetVersion

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Conjuntos de dados – obter credenciais

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=v1

Obtenha a credencial SAS para acessar a conta de armazenamento associada a uma versão do conjunto de dados.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A ID de versão específica do DatasetVersion no qual operar.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	AssetCredentialResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Conjuntos de dados – iniciar a versão de carregamento pendente

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=v1

Inicie um novo ou obtenha um upload pendente existente de um conjunto de dados para uma versão específica.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A ID de versão específica do DatasetVersion no qual operar.

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
Connectionname	cadeia	Nome da conexão da Conta de Armazenamento do Azure a ser usado para gerar o token SAS temporário	No
pendingUploadId	cadeia	Se PendingUploadId não for fornecido, um GUID aleatório será usado.	No
pendingUploadType	enumeração	BlobReference é o único tipo com suporte. Valores possíveis: `BlobReference`	Yes

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	PendingUploadResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Implantações

Implantações – lista

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

Listar todos os modelos implantados no projeto

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
modelPublisher	consulta	No	cadeia	Modelar o publicador para filtrar modelos por
modelName	consulta	No	cadeia	Nome do modelo (o nome específico do editor) para filtrar modelos por
deploymentType	consulta	No	cadeia Valores possíveis: `ModelDeployment`	Tipo de implantação para filtrar lista por

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id	Falso	cadeia	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	PagedDeployment

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-client-request-id		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Implantações – obter

GET {endpoint}/deployments/{name}?api-version=v1

Obtém um modelo implantado.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	Nome da implantação

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id	Falso	cadeia	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	Implantação

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-client-request-id		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Taxonomias de avaliação

Taxonomias de avaliação – lista

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

Listar taxonomias de avaliação

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
inputName	consulta	No	cadeia	Filtre pelo nome de entrada de avaliação.
Inputtype	consulta	No	cadeia	Filtrar por tipo de entrada de taxonomia.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	PagedEvaluationTaxonomy

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Taxonomias de avaliação – get

GET {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Obtenha uma avaliação executada pelo nome.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	EvaluationTaxonomy

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Taxonomias de avaliação – excluir

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Exclua uma taxonomia de avaliação por nome.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso

Cabeçalho da solicitação

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

Responses

Código de status: 204

Descrição: não há conteúdo a ser enviado para essa solicitação, mas os cabeçalhos podem ser úteis.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Taxonomias de avaliação – criar

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Crie uma taxonomia de avaliação.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome da taxonomia de avaliação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Verdade	cadeia Valores possíveis: `Evaluations=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

Nome	Tipo	Description	Obrigatório
description	cadeia	O texto de descrição do ativo.	No
properties	objeto	Propriedades adicionais para a taxonomia de avaliação.	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No
taxonomyCategories	matriz de TaxonomyCategory	Lista de categorias de taxonomia.	No
taxonomyInput	EvaluationTaxonomyInput	Configuração de entrada para a taxonomia de avaliação.	Yes
└─ tipo	EvaluationTaxonomyInputType	Tipo de entrada da taxonomia de avaliação.	Yes

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	EvaluationTaxonomy

Código de status: 201

Descrição: a solicitação foi bem-sucedida e um novo recurso foi criado como resultado.

Tipo de conteúdo	Type	Description
application/json	EvaluationTaxonomy

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Taxonomias de avaliação – atualização

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Atualize uma taxonomia de avaliação.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome da taxonomia de avaliação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Verdade	cadeia Valores possíveis: `Evaluations=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

Nome	Tipo	Description	Obrigatório
description	cadeia	O texto de descrição do ativo.	No
properties	objeto	Propriedades adicionais para a taxonomia de avaliação.	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No
taxonomyCategories	matriz de TaxonomyCategory	Lista de categorias de taxonomia.	No
taxonomyInput	EvaluationTaxonomyInputUpdate	Configuração de entrada para a taxonomia de avaliação.	No
└─ tipo	EvaluationTaxonomyInputType	Tipo de entrada da taxonomia de avaliação.	Yes

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	EvaluationTaxonomy

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Regras de avaliação

Regras de avaliação – lista

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

Listar todas as regras de avaliação.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
actionType	consulta	No	cadeia Valores possíveis: `continuousEvaluation`, `humanEvaluationPreview`	Filtrar pelo tipo de regra de avaliação.
nome_do_agente	consulta	No	cadeia	Filtre pelo nome do agente.
enabled	consulta	No	boolean	Filtre pelo status habilitado.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	PagedEvaluationRule

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Regras de avaliação – obter

GET {endpoint}/evaluationrules/{id}?api-version=v1

Obtenha uma regra de avaliação.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
id	caminho	Yes	cadeia	Identificador exclusivo para a regra de avaliação.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	EvaluationRule

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Regras de avaliação – excluir

DELETE {endpoint}/evaluationrules/{id}?api-version=v1

Excluir uma regra de avaliação.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
id	caminho	Yes	cadeia	Identificador exclusivo para a regra de avaliação.

Responses

Código de status: 204

Descrição: não há conteúdo a ser enviado para essa solicitação, mas os cabeçalhos podem ser úteis.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Regras de avaliação – criar ou atualizar

PUT {endpoint}/evaluationrules/{id}?api-version=v1

Crie ou atualize uma regra de avaliação.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
id	caminho	Yes	cadeia	Identificador exclusivo para a regra de avaliação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Falso	cadeia Valores possíveis: `Evaluations=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

Nome	Tipo	Description	Obrigatório
ação	EvaluationRuleAction	Modelo de ação de avaliação.	Yes
└─ tipo	EvaluationRuleActionType	Tipo de ação de avaliação.	Yes
description	cadeia	Descrição da regra de avaliação.	No
displayName	cadeia	Nome de Exibição para a regra de avaliação.	No
enabled	boolean	Indica se a regra de avaliação está habilitada. O padrão é true.	Yes
eventType	EvaluationRuleEventType	Tipo do evento de regra de avaliação.	Yes
filtro	EvaluationRuleFilter	Modelo de filtro de avaliação.	No
└─ agentName	cadeia	Filtrar pelo nome do agente.	Yes
id	cadeia de caracteres (somente leitura)	Identificador exclusivo para a regra de avaliação.	Yes
systemData	objeto (somente leitura)	Metadados do sistema para a regra de avaliação.	Yes

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	EvaluationRule

Código de status: 201

Descrição: a solicitação foi bem-sucedida e um novo recurso foi criado como resultado.

Tipo de conteúdo	Type	Description
application/json	EvaluationRule

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Avaliadores

Avaliadores – listar versões mais recentes

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

Liste a versão mais recente de cada avaliador

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
tipo	consulta	No	cadeia Valores possíveis: `builtin`, , `customall`	Filtrar avaliadores por tipo. Valores possíveis: 'all', 'custom', 'builtin'.
limit	consulta	No	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o padrão é 20.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	PagedEvaluatorVersion

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Avaliadores – listar versões

GET {endpoint}/evaluators/{name}/versions?api-version=v1

Listar todas as versões do avaliador fornecido

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso
tipo	consulta	No	cadeia Valores possíveis: `builtin`, , `customall`	Filtrar avaliadores por tipo. Valores possíveis: 'all', 'custom', 'builtin'.
limit	consulta	No	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o padrão é 20.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	PagedEvaluatorVersion

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Avaliadores – criar versão

POST {endpoint}/evaluators/{name}/versions?api-version=v1

Criar um novo EvaluatorVersion com ID de versão incrementada automaticamente

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Verdade	cadeia Valores possíveis: `Evaluations=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

Nome	Tipo	Description	Obrigatório
categories	matriz de EvaluatorCategory	As categorias do avaliador	Yes
definição	EvaluatorDefinition	Configuração do avaliador base com discriminador	Yes
└─ data_schema	objeto	O esquema JSON (rascunho 2020-12) para os dados de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	No
└─ init_parameters	objeto	O esquema JSON (Rascunho 2020-12) para os parâmetros de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	No
└─ métricas	objeto	Lista de métricas de saída produzidas por este avaliador	No
└─ tipo	EvaluatorDefinitionType	O tipo de definição do avaliador	Yes
description	cadeia	O texto de descrição do ativo.	No
display_name	cadeia	Nome de exibição para o avaliador. Ajuda a encontrar o avaliador facilmente no AI Foundry. Não precisa ser único.	No
evaluator_type	EvaluatorType	O tipo de avaliador	Yes
metadados	objeto	Metadados sobre o avaliador	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No

Responses

Código de status: 201

Descrição: a solicitação foi bem-sucedida e um novo recurso foi criado como resultado.

Tipo de conteúdo	Type	Description
application/json	EvaluatorVersion

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Avaliadores – obter versão

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Obtenha a versão específica do EvaluatorVersion. O serviço retornará o erro 404 Not Found se o EvaluatorVersion não existir.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A ID de versão específica do EvaluatorVersion a ser recuperado.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	EvaluatorVersion

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Avaliadores – excluir versão

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Exclua a versão específica do EvaluatorVersion. O serviço retornará 204 Sem Conteúdo se o EvaluatorVersion foi excluído com êxito ou se o EvaluatorVersion não existe.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A versão do EvaluatorVersion a ser excluída.

Cabeçalho da solicitação

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

Responses

Código de status: 204

Descrição: não há conteúdo a ser enviado para essa solicitação, mas os cabeçalhos podem ser úteis.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Avaliadores – versão de atualização

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Atualizar um EvaluatorVersion existente com o ID de versão fornecido

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A versão do EvaluatorVersion a ser atualizada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Verdade	cadeia Valores possíveis: `Evaluations=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

Nome	Tipo	Description	Obrigatório
categories	matriz de EvaluatorCategory	As categorias do avaliador	No
description	cadeia	O texto de descrição do ativo.	No
display_name	cadeia	Nome de exibição para o avaliador. Ajuda a encontrar o avaliador facilmente no AI Foundry. Não precisa ser único.	No
metadados	objeto	Metadados sobre o avaliador	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	EvaluatorVersion

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Indexes

Índices – listar mais recente

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

Listar a versão mais recente de cada Índice

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	PagedIndex

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Índices – listar versões

GET {endpoint}/indexes/{name}/versions?api-version=v1

Listar todas as versões do índice fornecido

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	PagedIndex

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Índices – obter versão

GET {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Obtenha a versão específica do Índice. O serviço retornará o erro 404 Not Found se o índice não existir.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A ID de versão específica do Índice a ser recuperado.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	Índice

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Índices – excluir versão

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Exclua a versão específica do Índice. O serviço retornará 204 Sem Conteúdo se o Índice tiver sido excluído com êxito ou se o Índice não existir.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A versão do Índice a ser excluída.

Responses

Código de status: 204

Descrição: não há conteúdo a ser enviado para essa solicitação, mas os cabeçalhos podem ser úteis.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Índices – criar ou atualizar a versão

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Criar um índice novo ou atualizado com a ID de versão fornecida

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A ID de versão específica do Índice a ser criada ou atualizada.

Corpo da solicitação

Tipo de Conteúdo: application/merge-patch+json

Nome	Tipo	Description	Obrigatório
description	cadeia	O texto de descrição do ativo.	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No
tipo	IndexType		Yes

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	Índice

Código de status: 201

Descrição: a solicitação foi bem-sucedida e um novo recurso foi criado como resultado.

Tipo de conteúdo	Type	Description
application/json	Índice

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Insights

Insights – gerar

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

Gerar Insights

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Verdade	cadeia Valores possíveis: `Insights=V1Preview`	Uma aceitação de sinalizador de recurso necessária ao usar operações de visualização ou modificar recursos de visualização persistentes.
Repetibilidade-Request-ID	Falso	cadeia	Identificador exclusivo gerado pelo cliente para garantir a idempotência da solicitação. Use a mesma ID para novas tentativas para evitar avaliações duplicadas.
Repetibilidade-First-Sent	Falso	cadeia	Carimbo de data/hora que indica quando essa solicitação foi iniciada pela primeira vez. Usado em conjunto com repeatability-request-id para controle de idempotência.

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
displayName	cadeia	Nome de exibição amigável para o insight.	Yes
id	cadeia de caracteres (somente leitura)	O identificador exclusivo do relatório de insights.	Yes
metadados	InsightsMetadata (somente leitura)	Metadados sobre os insights.	Yes
└─ concluído At	cadeia	O carimbo de data/hora quando os insights foram concluídos.	No
└─ criadoAt	cadeia	O carimbo de data/hora quando os insights foram criados.	Yes
solicitação	InsightRequest	A solicitação do relatório de insights.	Yes
└─ tipo	InsightType	O tipo de solicitação.	Yes
Resultado	InsightResult (somente leitura)	O resultado dos insights.	No
└─ tipo	InsightType	O tipo de resultado de insights.	Yes
estado	Azure. Core.Foundations.OperationState (somente leitura)	Enumeração que descreve os estados de operação permitidos.	Yes

Responses

Código de status: 201

Descrição: a solicitação foi bem-sucedida e um novo recurso foi criado como resultado.

Tipo de conteúdo	Type	Description
application/json	Insights

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Insights – lista

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

Listar todos os insights em ordem cronológica inversa (primeiro mais recente).

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
tipo	consulta	No	cadeia Valores possíveis: `EvaluationRunClusterInsight`, , `AgentClusterInsightEvaluationComparison`	Filtre pelo tipo de análise.
evalId	consulta	No	cadeia	Filtre pela ID de avaliação.
runId	consulta	No	cadeia	Filtre pela ID da execução de avaliação.
nome_do_agente	consulta	No	cadeia	Filtre pelo nome do agente.
includeCoordinates	consulta	No	boolean	Se as coordenadas para visualização devem ser incluídas na resposta. O padrão é false.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	PagedInsight

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Insights – obter

GET {endpoint}/insights/{id}?api-version=v1

Obtenha um insight específico por ID.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
id	caminho	Yes	cadeia	O identificador exclusivo do relatório de insights.
includeCoordinates	consulta	No	boolean	Se as coordenadas para visualização devem ser incluídas na resposta. O padrão é false.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	Insights

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Repositórios de Memória

Criar repositório de memória

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

Crie um armazenamento de memória.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Verdade	cadeia Valores possíveis: `MemoryStores=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

Nome	Tipo	Description	Obrigatório
definição	MemoryStoreDefinition	Definição de base para configurações de armazenamento de memória.	Yes
└─ tipo	MemoryStoreKind	O tipo do repositório de memória.	Yes
description	cadeia	Uma descrição legível pelo ser humano do repositório de memória. Restrições: maxLength: 512	No
metadados	objeto	Metadados arbitrários de chave-valor a serem associados ao repositório de memória.	No
nome	cadeia	O nome do repositório de memória. Restrições: maxLength: 256	Yes

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	MemoryStoreObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Listar repositórios de memória

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

Liste todos os armazenamentos de memória.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
limit	consulta	No	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
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.
Depois	consulta	No	cadeia	Um cursor para uso na paginação. `after` é uma 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.
before	consulta	No	cadeia	Um cursor para uso na paginação. `before` é uma 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.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Atualizar o repositório de memória

POST {endpoint}/memory_stores/{name}?api-version=v1

Atualize um armazenamento de memória.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
nome	caminho	Yes	cadeia	O nome do repositório de memória a ser atualizado.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Verdade	cadeia Valores possíveis: `MemoryStores=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

Nome	Tipo	Description	Obrigatório	Default
description	cadeia	Uma descrição legível pelo ser humano do repositório de memória. Restrições: maxLength: 512	No
metadados	objeto	Metadados arbitrários de chave-valor a serem associados ao repositório de memória.	No

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	MemoryStoreObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Obter repositório de memória

GET {endpoint}/memory_stores/{name}?api-version=v1

Recupere um armazenamento de memória.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
nome	caminho	Yes	cadeia	O nome do repositório de memória a ser recuperado.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	MemoryStoreObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Excluir repositório de memória

DELETE {endpoint}/memory_stores/{name}?api-version=v1

Exclua um armazenamento de memória.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
nome	caminho	Yes	cadeia	O nome do repositório de memória a ser excluído.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	DeleteMemoryStoreResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Obter o resultado da atualização

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=v1

Obtenha o resultado da atualização do armazenamento de memória.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
nome	caminho	Yes	cadeia	O nome do repositório de memória.
update_id	caminho	Yes	cadeia	A ID da operação de atualização de memória.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	MemoryStoreUpdateResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Excluir memórias de escopo

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=v1

Exclua todas as memórias associadas a um escopo específico de um armazenamento de memória.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
nome	caminho	Yes	cadeia	O nome do repositório de memória.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Verdade	cadeia Valores possíveis: `MemoryStores=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

Nome	Tipo	Description	Obrigatório	Default
escopo	cadeia	O namespace que agrupa e isola logicamente as memórias a serem excluídas, como uma ID de usuário.	Yes

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	MemoryStoreDeleteScopeResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Pesquisar memórias

POST {endpoint}/memory_stores/{name}:search_memories?api-version=v1

Pesquise memórias relevantes de um armazenamento de memória com base no contexto da conversa.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
nome	caminho	Yes	cadeia	O nome do repositório de memória a ser pesquisado.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Verdade	cadeia Valores possíveis: `MemoryStores=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

Nome	Tipo	Description	Obrigatório
items	matriz de OpenAI.InputItem	Itens para os quais pesquisar memórias relevantes.	No
Opções	MemorySearchOptions	Opções de pesquisa de memória.	No
└─ max_memories	inteiro	Número máximo de itens de memória a serem retornados.	No
previous_search_id	cadeia	A ID exclusiva da solicitação de pesquisa anterior, habilitando a pesquisa de memória incremental de onde a última operação parou.	No
escopo	cadeia	O namespace que agrupa e isola logicamente as memórias, como um ID do usuário.	Yes

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	MemoryStoreSearchResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Atualizar memórias

POST {endpoint}/memory_stores/{name}:update_memories?api-version=v1

Atualize o armazenamento de memória com memórias de conversa.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
nome	caminho	Yes	cadeia	O nome do repositório de memória a ser atualizado.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Verdade	cadeia Valores possíveis: `MemoryStores=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

Nome	Tipo	Description	Obrigatório	Default
items	matriz de OpenAI.InputItem	Itens de conversa dos quais extrair memórias.	No
previous_update_id	cadeia	A ID exclusiva da solicitação de atualização anterior, habilitando atualizações de memória incrementais de onde a última operação parou.	No
escopo	cadeia	O namespace que agrupa e isola logicamente as memórias, como um ID do usuário.	Yes
update_delay	inteiro	Período de tempo limite antes de processar a atualização de memória em segundos. Se uma nova solicitação de atualização for recebida durante esse período, ela cancelará a solicitação atual e redefinirá o tempo limite. Defina como 0 para disparar imediatamente a atualização sem atraso. O padrão é 300 (5 minutos).	No	300

Responses

Código de status: 202

Descrição: a solicitação foi aceita para processamento, mas o processamento ainda não foi concluído.

Tipo de conteúdo	Type	Description
application/json	MemoryStoreUpdateResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
Operação-Localização	cadeia	O local para monitorar o estado da operação.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Conversas

Criar conversa

POST {endpoint}/openai/v1/conversations

Crie uma conversa.

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório	Default
items	matriz de OpenAI.InputItem		No
metadados	OpenAI.Metadata (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.	No

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.ConversationResource

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Listar conversas

GET {endpoint}/openai/v1/conversations

Retorna a lista de todas as conversas.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
limit	consulta	No	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
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.
Depois	consulta	No	cadeia	Um cursor para uso na paginação. `after` é uma 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.
before	consulta	No	cadeia	Um cursor para uso na paginação. `before` é uma 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.
agent_name	consulta	No	cadeia	Filtrar pelo nome do agente. Se fornecido, somente os itens associados ao agente especificado serão retornados.
agent_id	consulta	No	cadeia	Filtrar por ID do agente no formato `name:version`. Se fornecido, somente os itens associados à ID do agente especificado serão retornados.

Responses

Código de status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Atualizar conversa

POST {endpoint}/openai/v1/conversations/{conversation_id}

Atualize uma conversa.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
conversation_id	caminho	Yes	cadeia	A ID da conversa a ser atualizada.

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório	Default
metadados	OpenAI.Metadata (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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.ConversationResource

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Obter conversa

GET {endpoint}/openai/v1/conversations/{conversation_id}

Recupera uma conversa.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
conversation_id	caminho	Yes	cadeia	A ID da conversa a ser recuperada.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.ConversationResource

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Excluir conversa

DELETE {endpoint}/openai/v1/conversations/{conversation_id}

Exclui uma conversa.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
conversation_id	caminho	Yes	cadeia	A ID da conversa a ser excluída.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.DeletedConversationResource

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Criar itens de conversa

POST {endpoint}/openai/v1/conversations/{conversation_id}/items

Crie itens em uma conversa com a ID fornecida.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
conversation_id	caminho	Yes	cadeia	A ID da conversa na qual o item precisa ser criado.
Incluem	consulta	No	matriz	Campos adicionais a serem incluídos na resposta. Consulte o `include` parâmetro para listar itens de conversa para obter mais informações.

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório	Default
items	matriz de OpenAI.Item	Os itens a serem adicionados à conversa. Você pode adicionar até 20 itens por vez.	Yes

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.ConversationItemList

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Listar itens de conversa

GET {endpoint}/openai/v1/conversations/{conversation_id}/items

Liste todos os itens para uma conversa com a ID fornecida.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
conversation_id	caminho	Yes	cadeia	A ID da conversa na qual os itens precisam ser listados.
limit	consulta	No	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
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.
Depois	consulta	No	cadeia	Um cursor para uso na paginação. `after` é uma 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.
before	consulta	No	cadeia	Um cursor para uso na paginação. `before` é uma 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.
item_type	consulta	No	cadeia Valores possíveis: `message`, , `output_message`, `file_search_call`, `computer_call`, `computer_call_output`, `web_search_call`, `function_call`, `function_call_output`, , `reasoning`, `compaction`, `image_generation_call`, `code_interpreter_call`, , `local_shell_call`, , `local_shell_call_output`, `shell_call`, `shell_call_output`, `apply_patch_call`, `apply_patch_call_output`, , `mcp_list_toolsmcp_approval_request`, `mcp_approval_response`, `mcp_call`, `custom_tool_call_output`, `custom_tool_call`, `structured_outputs`, `oauth_consent_request`, `memory_search_callworkflow_action`	Filtrar por tipo de item. Se fornecido, somente itens do tipo especificado serão retornados.

Responses

Código de status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Obter item de conversa

GET {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Obtenha um único item de uma conversa com as IDs fornecidas.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
conversation_id	caminho	Yes	cadeia	A ID da conversa que contém o item.
item_id	caminho	Yes	cadeia	A ID do item de conversa a ser recuperado.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.OutputItem

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Excluir item de conversa

DELETE {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Exclua um item de uma conversa com as IDs fornecidas.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
conversation_id	caminho	Yes	cadeia	A ID da conversa da qual o item precisa ser excluído.
item_id	caminho	Yes	cadeia	A ID do item de conversa a ser excluído.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.ConversationResource

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Avaliações

Avaliações – listar valores

GET {endpoint}/openai/v1/evals

Listar todas as avaliações Listar avaliações de um projeto.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
Depois	consulta	No	cadeia	Identificador da última execução da solicitação de paginação anterior.
limit	consulta	No	inteiro	Número de execuções a serem recuperadas.
ordem	consulta	No	cadeia Valores possíveis: `asc`, `desc`	Ordem de classificação das execuções por carimbo de data/hora. Use `asc` para ordem crescente ou `desc` para ordem decrescente. Usa `asc` como padrão.
ordenar_por	consulta	No	cadeia Valores possíveis: `created_at`, `updated_at`	Os valores podem ser ordenados por hora de criação ou hora da última atualização. Use `created_at` para a hora de criação ou `updated_at` para a hora da última atualização.

Responses

Código de status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Avaliações – criar a avaliação

POST {endpoint}/openai/v1/evals

Criar avaliação Crie a estrutura de uma avaliação que pode ser usada para testar o desempenho de um modelo. Uma avaliação é um conjunto de critérios de teste e a configuração de uma fonte de dados, que determina o esquema dos dados usados na avaliação. Depois de criar uma avaliação, você pode executá-la em diferentes modelos e parâmetros de modelo. Oferecemos suporte a vários tipos de grades e fontes de dados. Para obter mais informações, consulte o

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
configuração_da_fonte_de_dados	OpenAI.CreateEvalCustomDataSourceConfig ou OpenAI.CreateEvalLogsDataSourceConfig ou OpenAI.CreateEvalStoredCompletionsDataSourceConfig ou AzureAIDataSourceConfig	A configuração da fonte de dados usada para as execuções de avaliação. Determina o esquema dos dados usados na avaliação.	Yes
metadados	OpenAI.Metadata (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.	No
nome	cadeia	O nome da avaliação.	No
properties	objeto	Conjunto de 16 pares chave-valor imutáveis que podem ser anexados a um objeto para armazenar informações adicionais. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No
critérios_de_teste	matriz de OpenAI.EvalGraderLabelModel ou OpenAI.EvalGraderStringCheck ou OpenAI.EvalGraderTextSimilarity ou OpenAI.EvalGraderPython ou OpenAI.EvalGraderScoreModel ou EvalGraderAzureAIEvaluator	Uma lista de avaliadores para todas as execuções de avaliação neste grupo. Os alunos podem fazer referência a variáveis na fonte de dados usando notação de chaves duplas, como `{{item.variable_name}}`. Para fazer referência à saída do modelo, use o `sample` namespace (ou seja, `{{sample.output_text}}`).	Yes

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	Eval

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Avaliações – excluir a avaliação

DELETE {endpoint}/openai/v1/evals/{eval_id}

Excluir uma avaliação Excluir uma avaliação.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
eval_id	caminho	Yes	cadeia	A ID da avaliação a ser excluída.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	DeleteEvalResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Avaliações – obter a avaliação

GET {endpoint}/openai/v1/evals/{eval_id}

Obtenha uma avaliação Obter uma avaliação por ID.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
eval_id	caminho	Yes	cadeia	A ID da avaliação a ser recuperada.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	Eval

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Avaliações – atualizar a avaliação

POST {endpoint}/openai/v1/evals/{eval_id}

Atualize uma avaliação Atualizar determinadas propriedades de uma avaliação.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
eval_id	caminho	Yes	cadeia	A ID da avaliação a ser atualizada.

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
metadados	OpenAI.Metadata (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.	No
nome	cadeia		No
properties	objeto	Conjunto de 16 pares chave-valor imutáveis que podem ser anexados a um objeto para armazenar informações adicionais. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	Eval

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Avaliações – lista de execuções

GET {endpoint}/openai/v1/evals/{eval_id}/runs

Obtenha uma lista de execuções para uma avaliação Obter uma lista de execuções para uma avaliação.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
eval_id	caminho	Yes	cadeia	A ID da avaliação para a qual recuperar as execuções.
Depois	consulta	No	cadeia	Identificador da última execução da solicitação de paginação anterior.
limit	consulta	No	inteiro	Número de execuções a serem recuperadas.
ordem	consulta	No	cadeia Valores possíveis: `asc`, `desc`	Ordem de classificação das execuções por carimbo de data/hora. Use `asc` para ordem crescente ou `desc` para ordem decrescente. Usa `asc` como padrão.
status	consulta	No	cadeia Valores possíveis: `queued`, , `in_progress`, `completed`, `canceled`. `failed` Filtrar execuções por status. Um de `queued`, `in_progress`, `failed`, , `completed`. `canceled`

Responses

Código de status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Avaliações – criar execução de avaliação

POST {endpoint}/openai/v1/evals/{eval_id}/runs

Criar execução de avaliação

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
eval_id	caminho	Yes	cadeia	A ID da avaliação para a qual criar uma execução.

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
fonte_de_dados	OpenAI.CreateEvalJsonlRunDataSource ou OpenAI.CreateEvalCompletionsRunDataSource ou OpenAI.CreateEvalResponsesRunDataSource ou EvalRunDataSource	Detalhes sobre a fonte de dados da execução.	Yes
metadados	OpenAI.Metadata (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.	No
nome	cadeia	O nome da execução.	No
properties	objeto	Conjunto de 16 pares chave-valor imutáveis que podem ser anexados a um objeto para armazenar informações adicionais. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	EvalRun

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Avaliações – excluir execução de avaliação

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Excluir a execução de avaliação Excluir uma execução de avaliação.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
eval_id	caminho	Yes	cadeia	A ID da avaliação da qual excluir a execução.
run_id	caminho	Yes	cadeia	A ID da execução a ser excluída.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	DeleteEvalRunResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Avaliações – obter execução de avaliação

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Obtenha uma execução de avaliação Obter uma avaliação executada por ID.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
eval_id	caminho	Yes	cadeia	A ID da avaliação para a qual recuperar as execuções.
run_id	caminho	Yes	cadeia	A ID da execução a ser recuperada.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	EvalRun

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Avaliações – cancelar a execução de avaliação

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Cancelar a execução de avaliação Cancelar uma execução de avaliação contínua.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
eval_id	caminho	Yes	cadeia	A ID da avaliação cuja execução você deseja cancelar.
run_id	caminho	Yes	cadeia	A ID da execução a ser cancelada.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	EvalRun

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Avaliações – obter itens de saída de execução de avaliação

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items

Obter itens de saída de execução de avaliação Obtenha uma lista de itens de saída para uma execução de avaliação.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
eval_id	caminho	Yes	cadeia
run_id	caminho	Yes	cadeia	A ID da execução para a qual recuperar itens de saída.
Depois	consulta	No	cadeia	Identificador da última execução da solicitação de paginação anterior.
limit	consulta	No	inteiro	Número de execuções a serem recuperadas.
ordem	consulta	No	cadeia Valores possíveis: `asc`, `desc`	Ordem de classificação das execuções por carimbo de data/hora. Use `asc` para ordem crescente ou `desc` para ordem decrescente. Usa `asc` como padrão.
status	consulta	No	cadeia Valores possíveis: `fail`, `pass`	Filtrar itens de saída por status. Usar `failed` para filtrar por saída com falha itens ou `pass` para filtrar por itens de saída passados.

Responses

Código de status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Evals – obter o item de saída de execução de avaliação

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}

Obtenha um item de saída de uma execução de avaliação Obter um item de saída de execução de avaliação por ID.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
eval_id	caminho	Yes	cadeia	A ID da avaliação para a qual recuperar as execuções.
run_id	caminho	Yes	cadeia	A ID da execução a ser recuperada.
output_item_id	caminho	Yes	cadeia	A ID do item de saída a ser recuperado.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	EvalRunOutputItem

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Fine-Tuning

Criar um trabalho de ajuste fino

POST {endpoint}/openai/v1/fine_tuning/jobs?api-version=v1

Cria um trabalho de ajuste fino que inicia o processo de criação de um novo modelo a partir de um determinado conjunto de dados.

A resposta inclui detalhes do trabalho enfileirado, incluindo o status do trabalho e o nome dos modelos ajustados após a conclusão.

Saiba mais sobre ajuste fino

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório	Default
hiperparâmetros	OpenAI.CreateFineTuningJobRequestHyperparameters		No
└─ tamanho_do_lote (batch_size)	string ou OpenAI.integer		No	automático
└─ multiplicador_da_taxa_de_aprendizagem	string ou OpenAI.numeric		No
└─ n_epochs	string ou OpenAI.integer		No	automático
Integrações	matriz de OpenAI.CreateFineTuningJobRequestIntegrations	Uma lista de integrações para habilitar seu trabalho de ajuste fino.	No
metadados	OpenAI.Metadata (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.	No
método	OpenAI.FineTuneMethod	O método usado para ajuste fino.	No
modelo	cadeia de caracteres (veja os modelos válidos abaixo)	O nome do modelo a ser afinado. Você pode selecionar um dos c0.	Yes
seed	OpenAI.integer (anulável)		No
Sufixo	cadeia de caracteres (anulável)	Uma cadeia de caracteres de até 64 caracteres que será adicionada ao seu nome de modelo ajustado. Por exemplo, um `suffix` "custom-model-name" produziria um nome de modelo como `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`. Restrições: minLength: 1, maxLength: 64	No
arquivo_de_treinamento	cadeia	A ID de um arquivo carregado que contém dados de treinamento. Consulte o arquivo de upload para saber como carregar um arquivo. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Além disso, você deve carregar seu arquivo com a finalidade `fine-tune`. O conteúdo do arquivo deve ser diferente dependendo se o modelo usar o chat, o formato de conclusão ou se o método de ajuste fino usar o formato de preferência . Veja o guia de ajuste fino para mais detalhes.	Yes
arquivo_de_validação	cadeia de caracteres (anulável)	A ID de um arquivo carregado que contém dados de validação. Se você fornecer esse arquivo, os dados serão usados para gerar validação métricas periodicamente durante o ajuste fino. Essas métricas podem ser exibidas em o arquivo de resultados de ajuste fino. Os mesmos dados não devem estar presentes nos arquivos de treinamento e validação. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Você deve carregar seu arquivo com a finalidade `fine-tune`. Veja o guia de ajuste fino para mais detalhes.	No

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.FineTuningJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Listar trabalhos de ajuste fino paginado

GET {endpoint}/openai/v1/fine_tuning/jobs?api-version=v1

Listar os trabalhos de ajuste fino da sua organização

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
Depois	consulta	No	cadeia	Identificador do último trabalho da solicitação de paginação anterior.
limit	consulta	No	inteiro	Número de trabalhos de ajuste fino a serem recuperados.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Recuperar trabalho de ajuste fino

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=v1

Obtenha informações sobre um trabalho de ajuste fino.

Saiba mais sobre ajuste fino

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.FineTuningJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Cancelar o trabalho de ajuste fino

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=v1

Cancele imediatamente um trabalho de ajuste fino.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino a ser cancelado.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.FineTuningJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Listar pontos de verificação de trabalho de ajuste fino

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=v1

Listar pontos de verificação para um trabalho de ajuste fino.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino para o qual obter pontos de verificação.
Depois	consulta	No	cadeia	Identificador da última ID do ponto de verificação da solicitação de paginação anterior.
limit	consulta	No	inteiro	Número de pontos de verificação a serem recuperados.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Listar eventos de trabalho de ajuste fino

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=v1

Obtenha atualizações de status refinadas para um trabalho de ajuste fino.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino para o qual obter eventos.
Depois	consulta	No	cadeia	Identificador do último evento da solicitação de paginação anterior.
limit	consulta	No	inteiro	Número de eventos a serem recuperados.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.ListFineTuningJobEventsResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Pausar o trabalho de ajuste fino

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=v1

Pausar um trabalho de ajuste fino em execução.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino para pausar.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.FineTuningJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Retomar o trabalho de ajuste fino

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=v1

Retome um trabalho de ajuste fino em pausa.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino a ser retomado.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.FineTuningJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Responses

Criar resposta – criar fluxo de resposta

POST {endpoint}/openai/v1/responses

Cria uma resposta de modelo. Cria uma resposta de modelo (resposta de streaming).

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório	Default
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
em segundo plano	booliano (anulável)		No
conversa	OpenAI.ConversationParam (anulável)	A conversa à qual essa resposta pertence. Os itens dessa conversa são anexados a `input_items` essa solicitação de resposta. Itens de entrada e itens de saída dessa resposta são adicionados automaticamente a essa conversa após a conclusão dessa resposta.	No
Incluem	matriz de OpenAI.IncludeEnum		No
entrada	OpenAI.InputParam	Entradas de texto, imagem ou arquivo para o modelo, usadas para gerar uma resposta. Saiba mais: - Entradas e saídas de texto - Entradas de imagem - Entradas de arquivo - Estado da conversa - Chamada de função	No
instructions	cadeia de caracteres (anulável)		No
max_output_tokens	OpenAI.integer (anulável)		No
max_tool_calls	OpenAI.integer (anulável)		No
metadados	OpenAI.Metadata (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.	No
modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	No
parallel_tool_calls	booliano (anulável)		No	Verdade
previous_response_id	cadeia de caracteres (anulável)		No
solicitação	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis. Saiba mais.	No
prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo. Saiba mais.	No
prompt_cache_retention	enumeração	Valores possíveis: `in-memory`, `24h`	No
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	enumeração	Valores possíveis: `auto`, , `concisedetailed`	No
└─ resumo	enumeração	Valores possíveis: `auto`, , `concisedetailed`	No
safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. As IDs devem ser uma cadeia de caracteres que identifique exclusivamente cada usuário. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Saiba mais.	No
nível de serviço	OpenAI.ServiceTier	Especifica o tipo de processamento usado para atender à solicitação. - Se definido como 'automático', a solicitação será processada com a camada de serviço configurada nas configurações de Project. A menos que esteja configurado de outra forma, o Project usará "padrão". - Se definido como 'padrão', a solicitação será processada com o preço padrão e o desempenho do modelo selecionado. - Se definido como 'flex' ou 'priority', a solicitação será processada com a camada de serviço correspondente. - Quando não definido, o comportamento padrão é 'auto'. Quando o `service_tier` parâmetro for definido, o corpo da resposta incluirá o `service_tier` valor com base no modo de processamento realmente usado para atender à solicitação. Esse valor de resposta pode ser diferente do valor definido no parâmetro.	No
armazenar	booliano (anulável)		No	Verdade
fluxo	booliano (anulável)		No
stream_options	OpenAI.ResponseStreamOptions (anulável)	Opções para respostas de streaming. Defina isso somente quando você definir `stream: true`.	No
└─ include_obfuscation	boolean	Quando true, a ofuscação de fluxo será habilitada. Adiciones de ofuscação de fluxo caracteres aleatórios para um `obfuscation` campo em eventos delta de streaming para normalize os tamanhos de carga como uma mitigação para determinados ataques de canal lateral. Esses campos de ofuscação são incluídos por padrão, mas adicionam uma pequena quantidade de sobrecarga para o fluxo de dados. Você pode definir `include_obfuscation` como false para otimizar para largura de banda se você confiar nos links de rede entre seu aplicativo e a API OpenAI.	No
structured_inputs	objeto	As entradas estruturadas para a resposta que podem participar de substituição de modelo de prompt ou associações de argumento de ferramenta.	No
Temperatura	OpenAI.numeric (anulável )		No	1
enviar SMS	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas estruturadas	No
tool_choice	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivo. Saiba mais sobre ferramentas internas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas do MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre chamada de função. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
top_logprobs	OpenAI.integer (anulável)		No
top_p	OpenAI.numeric (anulável )		No	1
truncation	enumeração	Valores possíveis: `auto`, `disabled`	No
usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos. Saiba mais.	No

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Listar respostas

GET {endpoint}/openai/v1/responses

Retorna a lista de todas as respostas.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
limit	consulta	No	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
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.
Depois	consulta	No	cadeia	Um cursor para uso na paginação. `after` é uma 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.
before	consulta	No	cadeia	Um cursor para uso na paginação. `before` é uma 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.
agent_name	consulta	No	cadeia	Filtrar pelo nome do agente. Se fornecido, somente os itens associados ao agente especificado serão retornados.
agent_id	consulta	No	cadeia	Filtrar por ID do agente no formato `name:version`. Se fornecido, somente os itens associados à ID do agente especificado serão retornados.
conversation_id	consulta	No	cadeia	Filtrar por ID da conversa. Se fornecido, somente as respostas associadas à conversa especificada serão retornadas.

Responses

Código de status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Conversa de resposta compacta

POST {endpoint}/openai/v1/responses/compact

Produz uma compactação de uma conversa de respostas.

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
entrada	cadeia de caracteres ou matriz de OpenAI.InputItem		No
instructions	cadeia de caracteres (anulável)		No
modelo	OpenAI.ModelIdsCompaction	ID do modelo usada para gerar a resposta, como `gpt-5` ou `o3`. O OpenAI oferece uma ampla gama de modelos com diferentes funcionalidades, características de desempenho e pontos de preço. Consulte o guia do modelo para procurar e comparar os modelos disponíveis.	Yes
previous_response_id	cadeia de caracteres (anulável)		No

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.CompactResource

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Obter resposta – obter fluxo de resposta

GET {endpoint}/openai/v1/responses/{response_id}

Recupera uma resposta de modelo com a ID fornecida. Recupera uma resposta de modelo com a ID fornecida (resposta de streaming).

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
response_id	caminho	Yes	cadeia
include[]	consulta	No	matriz
fluxo	consulta	No	boolean
starting_after	consulta	No	inteiro

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
aceitar	Falso	cadeia Valores possíveis: `text/event-stream`

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Excluir resposta

DELETE {endpoint}/openai/v1/responses/{response_id}

Exclui uma resposta de modelo.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
response_id	caminho	Yes	cadeia	A ID da resposta a ser excluída.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	DeleteResponseResult

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Cancelar resposta

POST {endpoint}/openai/v1/responses/{response_id}/cancel

Cancela uma resposta de modelo.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
response_id	caminho	Yes	cadeia	A ID da resposta a ser cancelada.

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	OpenAI.Response

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Listar itens de entrada

GET {endpoint}/openai/v1/responses/{response_id}/input_items

Retorna uma lista de itens de entrada para uma determinada resposta.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
response_id	caminho	Yes	cadeia
limit	consulta	No	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
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.
Depois	consulta	No	cadeia	Um cursor para uso na paginação. `after` é uma 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.
before	consulta	No	cadeia	Um cursor para uso na paginação. `before` é uma 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.

Responses

Código de status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Redteams

Redteams - lista

GET {endpoint}/redTeams/runs?api-version=v1

Listar um redteam pelo nome.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	PagedRedTeam

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Redteams - get

GET {endpoint}/redTeams/runs/{name}?api-version=v1

Obtenha um redteam pelo nome.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
nome	caminho	Yes	cadeia	Identificador da execução da equipe vermelha.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	RedTeam

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Redteams – criar

POST {endpoint}/redTeams/runs:run?api-version=v1

Cria uma execução redteam.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Verdade	cadeia Valores possíveis: `RedTeams=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

Nome	Tipo	Description	Obrigatório	Default
applicationScenario	cadeia	Cenário de aplicativo para a operação de equipe vermelha, para gerar ataques específicos do cenário.	No
attackStrategies	matriz de AttackStrategy	Lista de estratégias de ataque ou listas aninhadas de estratégias de ataque.	No
displayName	cadeia	Nome da execução da equipe vermelha.	No
id	cadeia de caracteres (somente leitura)	Identificador da execução da equipe vermelha.	Yes
numTurns	inteiro	Número de rodadas de simulação.	No
properties	objeto	Propriedades da equipe vermelha. Ao contrário das marcas, as propriedades são somente suplementos. Depois de adicionada, uma propriedade não pode ser removida.	No
riskCategories	matriz de RiskCategory	Lista de categorias de risco para as quais gerar objetivos de ataque.	No
simulationOnly	boolean	Somente simulação ou simulação + avaliação. Falso padrão, se verdadeiro, a conversa de saída de verificação não resultará na avaliação.	No	Falso
status	cadeia de caracteres (somente leitura)	Status da equipe vermelha. Ele é definido por serviço e é somente leitura.	No
tags	objeto	Marcas da equipe vermelha. Ao contrário das propriedades, as marcas são totalmente mutáveis.	No
destino	TargetConfig	Classe abstrata para configuração de destino.	Yes
└─ tipo	cadeia	Tipo da configuração do modelo.	Yes

Responses

Código de status: 201

Descrição: a solicitação foi bem-sucedida e um novo recurso foi criado como resultado.

Tipo de conteúdo	Type	Description
application/json	RedTeam

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Schedules

Agendas – lista

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

Listar todos os agendamentos.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
tipo	consulta	No	cadeia Valores possíveis: `Evaluation`, `Insight`	Filtrar pelo tipo de agendamento.
enabled	consulta	No	boolean	Filtre pelo status habilitado.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	PagedSchedule

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Agendamentos – excluir

DELETE {endpoint}/schedules/{id}?api-version=v1

Exclua uma agenda.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
id	caminho	Yes	cadeia	Identificador do agendamento.

Cabeçalho da solicitação

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

Responses

Código de status: 204

Descrição: não há conteúdo a ser enviado para essa solicitação, mas os cabeçalhos podem ser úteis.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Agendas – obter

GET {endpoint}/schedules/{id}?api-version=v1

Obtenha uma agenda por ID.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
id	caminho	Yes	cadeia	Identificador do agendamento.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	Schedule

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Agendamentos – criar ou atualizar

PUT {endpoint}/schedules/{id}?api-version=v1

Criar ou atualizar o modelo de operação.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
id	caminho	Yes	cadeia	Identificador do agendamento.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Foundry-Features	Verdade	cadeia Valores possíveis: `Schedules=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

Nome	Tipo	Description	Obrigatório
description	cadeia	Descrição da agenda.	No
displayName	cadeia	Nome da agenda.	No
enabled	boolean	Status habilitado do agendamento.	Yes
id	cadeia de caracteres (somente leitura)	Identificador do agendamento.	Yes
properties	objeto	Propriedades do agendamento. Ao contrário das marcas, as propriedades são somente suplementos. Depois de adicionada, uma propriedade não pode ser removida.	No
status de provisionamento	ScheduleProvisioningStatus (somente leitura)	Agende o status de provisionamento.	No
systemData	objeto (somente leitura)	Metadados do sistema para o recurso.	Yes
tags	objeto	Marcas de agendamento. Ao contrário das propriedades, as marcas são totalmente mutáveis.	No
tarefa	ScheduleTask	Modelo de tarefa de agendamento.	Yes
Configuração do └─	objeto	Configuração da tarefa.	No
└─ tipo	ScheduleTaskType	Tipo da tarefa.	Yes
disparador	Trigger	Modelo base para Trigger do agendamento.	Yes
└─ tipo	Tipo de gatilho	Tipo do gatilho.	Yes

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	Schedule

Código de status: 201

Descrição: a solicitação foi bem-sucedida e um novo recurso foi criado como resultado.

Tipo de conteúdo	Type	Description
application/json	Schedule

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Agendas – listar execuções

GET {endpoint}/schedules/{id}/runs?api-version=v1

Listar todas as execuções de agendamento.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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.
id	caminho	Yes	cadeia	Identificador do agendamento.
tipo	consulta	No	cadeia Valores possíveis: `Evaluation`, `Insight`	Filtrar pelo tipo de agendamento.
enabled	consulta	No	boolean	Filtre pelo status habilitado.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	PagedScheduleRun

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
x-ms-error-code	cadeia	Código de erro de cadeia de caracteres que indica o que deu errado.

Agendamentos – obter execução

GET {endpoint}/schedules/{schedule_id}/runs/{run_id}?api-version=v1

Obtenha uma execução de agenda por ID.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	caminho	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"
Schedule_id	caminho	Yes	cadeia	O identificador exclusivo do agendamento.
run_id	caminho	Yes	cadeia	O identificador exclusivo da execução do agendamento.
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

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

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	ScheduleRun

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	ApiErrorResponse

Components

A2APreviewTool

Um agente que implementa o protocolo A2A.

Nome	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 é `/.well-known/agent-card.json`	No
base_url	cadeia	URL base do agente.	No
project_connection_id	cadeia	A ID de conexão no project para o 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.

Nome	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 a ferramenta Pesquisa de IA do Azure .	No
top_k	inteiro	Número de documentos a serem recuperados da pesquisa e presentes no modelo.	No

AgentClusterInsightRequest

Insights sobre o conjunto de resultados da avaliação do agente

Nome	Tipo	Description	Obrigatório
nome_do_agente	cadeia	Identificador do agente.	Yes
modelConfiguration	InsightModelConfiguration	Configuração do modelo usado na geração de insights.	No
└─ modelDeploymentName	cadeia	A implantação do modelo a ser avaliada. Aceita o nome da implantação sozinho ou com o nome da conexão como `{connectionName}/<modelDeploymentName>`.	Yes
tipo	enumeração	O tipo de solicitação. Valores possíveis: `AgentClusterInsight`	Yes

AgentClusterInsightResult

Insights da análise de cluster de agentes.

Nome	Tipo	Description	Obrigatório	Default
clusterInsight	ClusterInsightResult	Insights da análise de cluster.	Yes
tipo	enumeração	O tipo de resultado de insights. Valores possíveis: `AgentClusterInsight`	Yes

AgentContainerObject

Os detalhes do contêiner de uma versão específica de um agente.

Nome	Tipo	Description	Obrigatório
contêiner	ContainerDetails (somente leitura)	Informações detalhadas sobre o contêiner.	No
└─ health_state	cadeia	O estado de integridade do contêiner.	Yes
└─ provisioning_error	cadeia	O erro de provisionamento do contêiner, se houver.	No
└─ provisioning_state	cadeia	O estado de provisionamento do contêiner.	Yes
└─ réplicas	matriz de ContainerReplica	A lista de réplicas no contêiner.	Yes
└─ estado	cadeia	O estado do contêiner.	Yes
└─ updated_on	cadeia	A hora da última atualização do contêiner.	Yes
criado_em	cadeia	A hora de criação do contêiner.	Yes
Error_message	cadeia de caracteres (somente leitura)	A mensagem de erro se o contêiner não funcionar, se houver.	No
id	cadeia de caracteres (somente leitura)	O identificador do contêiner.	No
max_replicas	inteiro	O número máximo de réplicas para o contêiner. O padrão é 1.	No
min_replicas	inteiro	O número mínimo de réplicas para o contêiner. O padrão é 1.	No
objeto	enumeração	O tipo de objeto, que é sempre 'agent.container'. Valores possíveis: `agent.container`	Yes
status	AgentContainerStatus (somente leitura)	Status do contêiner de uma versão específica de um agente.	Yes
updated_at	cadeia	A hora da última atualização do contêiner.	Yes

AgentContainerOperationError

Os detalhes do erro da operação de contêiner, se houver.

Nome	Tipo	Description	Obrigatório
codificar	cadeia	O código de erro da operação de contêiner, se houver.	Yes
mensagem	cadeia	A mensagem de erro da operação de contêiner, se houver.	Yes
tipo	cadeia	O tipo de erro da operação de contêiner, se houver.	Yes

AgentContainerOperationObject

A operação de contêiner para uma versão específica de um agente.

Nome	Tipo	Description	Obrigatório
agent_id	cadeia	A ID do agente.	Yes
agent_version_id	cadeia	A ID da versão do agente.	Yes
contêiner	AgentContainerObject	Os detalhes do contêiner de uma versão específica de um agente.	No
└─ contêiner	ContainerDetails (somente leitura)	As informações detalhadas do contêiner.	No
└─ created_at	cadeia de caracteres (somente leitura)	A hora de criação do contêiner.	Yes
└─ error_message	cadeia de caracteres (somente leitura)	A mensagem de erro se o contêiner não funcionar, se houver.	No
└─ id	cadeia de caracteres (somente leitura)	O identificador do contêiner.	No
└─ max_replicas	inteiro	O número máximo de réplicas para o contêiner. O padrão é 1.	No
└─ min_replicas	inteiro	O número mínimo de réplicas para o contêiner. O padrão é 1.	No
└─ objeto	enumeração	O tipo de objeto, que é sempre 'agent.container'. Valores possíveis: `agent.container`	Yes
└─ estado	AgentContainerStatus (somente leitura)	O status do contêiner de uma versão específica de um agente.	Yes
└─ updated_at	cadeia de caracteres (somente leitura)	A hora da última atualização do contêiner.	Yes
erro	AgentContainerOperationError	Os detalhes do erro da operação de contêiner, se houver.	No
└─ código	cadeia	O código de erro da operação de contêiner, se houver.	Yes
Mensagem └─	cadeia	A mensagem de erro da operação de contêiner, se houver.	Yes
└─ tipo	cadeia	O tipo de erro da operação de contêiner, se houver.	Yes
id	cadeia	A ID da operação de contêiner. Essa ID é um identificador exclusivo em todo o sistema.	Yes
status	AgentContainerOperationStatus	Status da operação de contêiner para uma versão específica de um agente.	Yes

AgentContainerOperationStatus

Status da operação de contêiner para uma versão específica de um agente.

Property	Valor
Type	cadeia
Valores	`NotStarted` `InProgress` `Succeeded` `Failed`

AgentContainerStatus

Status do contêiner de uma versão específica de um agente.

Property	Valor
Type	cadeia
Valores	`Starting` `Running` `Stopping` `Stopped` `Failed` `Deleting` `Deleted` `Updating`

AgentDefinition

Discriminador para AgentDefinition

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

Digite um valor	Schema
`prompt`	PromptAgentDefinition
`workflow`	WorkflowAgentDefinition
`hosted`	HostedAgentDefinition
`container_app`	ContainerAppAgentDefinition

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

AgentKind

Property	Valor
Type	cadeia
Valores	`prompt` `hosted` `container_app` `workflow`

AgentObject

Nome	Tipo	Description	Obrigatório
id	cadeia	O identificador exclusivo do agente.	Yes
nome	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
Type	cadeia
Valores	`activity_protocol` `responses`

AgentReference

Nome	Tipo	Description	Obrigatório
nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
tipo	enumeração	Valores possíveis: `agent_reference`	Yes
versão	cadeia	O identificador de versão do agente.	No

AgentTaxonomyInput

Configuração de entrada para a taxonomia de avaliação quando o tipo de entrada é agente.

Nome	Tipo	Description	Obrigatório
riskCategories	matriz de RiskCategory	Lista de categorias de risco a serem avaliadas.	Yes
destino	Target (destino)	Classe base para destinos com suporte a discriminadores.	Yes
└─ tipo	cadeia	O tipo de destino.	Yes
tipo	enumeração	Tipo de entrada da taxonomia de avaliação. Valores possíveis: `agent`	Yes

AgentTaxonomyInputUpdate

Configuração de entrada para a taxonomia de avaliação quando o tipo de entrada é agente.

Nome	Tipo	Description	Obrigatório
riskCategories	matriz de RiskCategory	Lista de categorias de risco a serem avaliadas.	No
destino	TargetUpdate	Classe base para destinos com suporte a discriminadores.	No
└─ tipo	cadeia	O tipo de destino.	Yes
tipo	enumeração	Tipo de entrada da taxonomia de avaliação. Valores possíveis: `agent`	Yes

AgentVersionObject

Nome	Tipo	Description	Obrigatório
criado_em	inteiro	O carimbo de data/hora do Unix (segundos) quando o agente foi criado.	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
nome	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

AgenticIdentityPreviewCredentials

Definição de credencial de identidade agêntica

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	O tipo de credencial Valores possíveis: `AgenticIdentityToken_Preview`	Yes

ApiErrorResponse

Resposta de erro para falhas de API.

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

ApiKeyCredentials

Definição de credencial de chave de API

Nome	Tipo	Description	Obrigatório	Default
chave	cadeia de caracteres (somente leitura)	Chave de API	No
tipo	enumeração	O tipo de credencial Valores possíveis: `ApiKey`	Yes

AssetCredentialResponse

Representa uma referência a um blob para consumo

Nome	Tipo	Description	Obrigatório
blobReference	BlobReference	Detalhes de referência de blob.	Yes
└─ blobUri	cadeia	Caminho do URI do blob para o cliente carregar dados. Exemplo: `https://blob.windows.core.net/Container/Path`	Yes
└─ credencial	SasCredential	Informações de credencial para acessar a conta de armazenamento.	Yes
└─ storageAccountArmId	cadeia	ID do ARM da conta de armazenamento a ser usada.	Yes

ID do Ativo

Identificador de um ativo salvo.

Tipo: cadeia de caracteres

AttackStrategy

Estratégias para ataques.

Property	Valor
Description	Estratégias para ataques.
Type	cadeia
Valores	`easy` `moderate` `difficult` `ascii_art` `ascii_smuggler` `atbash` `base64` `binary` `caesar` `character_space` `jailbreak` `ansi_attack` `character_swap` `suffix_append` `string_join` `unicode_confusable` `unicode_substitution` `diacritic` `flip` `leetspeak` `rot13` `morse` `url` `baseline` `indirect_jailbreak` `tense` `multi_turn` `crescendo`

Azure. Core.Foundations.Error

O objeto de erro.

Nome	Tipo	Description	Obrigatório
codificar	cadeia	Um de um conjunto de códigos de erro definidos pelo servidor.	Yes
details	matriz de Azure. Core.Foundations.Error	Uma série de detalhes sobre erros específicos que levaram a esse erro relatado.	No
innererror	Azure. Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.	No
└─ código	cadeia	Um de um conjunto de códigos de erro definidos pelo servidor.	No
└─ innererror	Azure. Core.Foundations.InnerError	Erro interno.	No
mensagem	cadeia	Uma representação legível do erro.	Yes
destino	cadeia	O destino do erro.	No

Azure. Core.Foundations.ErrorResponse

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description	Obrigatório
erro	Azure. Core.Foundations.Error	O objeto de erro.	Yes
└─ código	cadeia	Um de um conjunto de códigos de erro definidos pelo servidor.	Yes
└─ detalhes	matriz de Azure. Core.Foundations.Error	Uma série de detalhes sobre erros específicos que levaram a esse erro relatado.	No
└─ innererror	Azure. Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.	No
Mensagem └─	cadeia	Uma representação legível do erro.	Yes
└─ destino	cadeia	O destino do erro.	No

Azure. Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome	Tipo	Description	Obrigatório
codificar	cadeia	Um de um conjunto de códigos de erro definidos pelo servidor.	No
innererror	Azure. Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.	No
└─ código	cadeia	Um de um conjunto de códigos de erro definidos pelo servidor.	No
└─ innererror	Azure. Core.Foundations.InnerError	Erro interno.	No

Azure. Core.Foundations.OperationState

Enumeração que descreve os estados de operação permitidos.

Property	Valor
Description	Enumeração que descreve os estados de operação permitidos.
Type	cadeia
Valores	`NotStarted` `Running` `Succeeded` `Failed` `Canceled`

Azure. Core.uuid

Identificador Universalmente Exclusivo

Tipo: cadeia de caracteres

Formato: uuid

AzureAIAgentTarget

Representa um alvo especificando um agente de IA do Azure.

Nome	Tipo	Description	Obrigatório
nome	cadeia	O identificador exclusivo do agente de IA Azure.	Yes
tool_descriptions	matriz de ToolDescription	Os parâmetros usados para controlar o comportamento de amostragem do agente durante a geração de texto.	No
tipo	enumeração	O tipo de alvo, sempre `azure_ai_agent`. Valores possíveis: `azure_ai_agent`	Yes
versão	cadeia	A versão do agente de IA Azure.	No

AzureAIAgentTargetUpdate

Representa um alvo especificando um agente de IA do Azure.

Nome	Tipo	Description	Obrigatório
nome	cadeia	O identificador exclusivo do agente de IA Azure.	No
tool_descriptions	matriz de ToolDescription	Os parâmetros usados para controlar o comportamento de amostragem do agente durante a geração de texto.	No
tipo	enumeração	O tipo de alvo, sempre `azure_ai_agent`. Valores possíveis: `azure_ai_agent`	Yes
versão	cadeia	A versão do agente de IA Azure.	No

AzureAIDataSourceConfig

Nome	Tipo	Description	Obrigatório
cenário	enumeração	Cenário de esquema de dados. Valores possíveis: `red_team`, , `responses`, `traces_previewsynthetic_data_gen_preview`	Yes
esquema	objeto	O esquema JSON de objeto geral para os itens de fonte de dados de execução.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `azure_ai_source`. Valores possíveis: `azure_ai_source`	Yes

AzureAIModelTarget

Representa um alvo especificando um modelo de IA do Azure para operações que exigem seleção de modelo.

Nome	Tipo	Description	Obrigatório
modelo	cadeia	O identificador exclusivo do modelo de IA Azure.	No
sampling_params	ModelSamplingParams	Representa um conjunto de parâmetros usados para controlar o comportamento de amostragem de um modelo de linguagem durante a geração de texto.	No
└─ max_completion_tokens (máximo de tokens de conclusão)	inteiro	O número máximo de tokens permitidos na conclusão.	Yes
└─ semente	inteiro	A semente aleatória para reprodutibilidade.	Yes
└─ temperatura	número	O parâmetro de temperatura para amostragem.	Yes
└─ top_p	número	O parâmetro top-p para amostragem de núcleo.	Yes
tipo	enumeração	O tipo de alvo, sempre `azure_ai_model`. Valores possíveis: `azure_ai_model`	Yes

AzureAIModelTargetUpdate

Representa um alvo especificando um modelo de IA do Azure para operações que exigem seleção de modelo.

Nome	Tipo	Description	Obrigatório
modelo	cadeia	O identificador exclusivo do modelo de IA Azure.	No
sampling_params	ModelSamplingParamsUpdate	Representa um conjunto de parâmetros usados para controlar o comportamento de amostragem de um modelo de linguagem durante a geração de texto.	No
└─ max_completion_tokens (máximo de tokens de conclusão)	inteiro	O número máximo de tokens permitidos na conclusão.	No
└─ semente	inteiro	A semente aleatória para reprodutibilidade.	No
└─ temperatura	número	O parâmetro de temperatura para amostragem.	No
└─ top_p	número	O parâmetro top-p para amostragem de núcleo.	No
tipo	enumeração	O tipo de alvo, sempre `azure_ai_model`. Valores possíveis: `azure_ai_model`	Yes

AzureAIResponsesEvalRunDataSource

Representa uma fonte de dados para execuções de avaliação específicas para cenários de Avaliação Contínua.

Nome	Tipo	Description	Obrigatório
event_configuration_id	cadeia	O nome da configuração do evento associado a essa execução de avaliação.	Yes
item_generation_params	ResponseRetrievalItemGenerationParams	Representa os parâmetros para a geração de item de recuperação de resposta.	Yes
└─ data_mapping	objeto	Mapeamento de campos de origem para response_id campo, necessário para recuperar o histórico de chat.	Yes
└─ max_num_turns	inteiro	O número máximo de turnos do histórico de chat a ser avaliado.	Yes
└─ origem	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource	A origem da qual o conteúdo JSONL é lido.	Yes
└─ tipo	enumeração	O tipo de parâmetros de geração de item, sempre `response_retrieval`. Valores possíveis: `response_retrieval`	Yes
max_runs_hourly	inteiro	Número máximo de execuções de avaliação permitidas por hora.	Yes
tipo	enumeração	O tipo de fonte de dados, always `azure_ai_responses`. Valores possíveis: `azure_ai_responses`	Yes

Índice de Busca do AzureAI

Definição de índice Pesquisa de IA do Azure

Nome	Tipo	Description	Obrigatório
id	cadeia de caracteres (somente leitura)	ID do ativo, um identificador exclusivo para o ativo	No
nome	cadeia de caracteres (somente leitura)	O nome do recurso	Yes
tipo	enumeração	Tipo de índice Valores possíveis: `AzureSearch`	Yes
versão	cadeia de caracteres (somente leitura)	A versão do recurso	Yes

AzureAISearchIndexUpdate

Definição de índice Pesquisa de IA do Azure

Nome	Tipo	Description	Obrigatório
description	cadeia	O texto de descrição do ativo.	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No
tipo	enumeração	Tipo de índice Valores possíveis: `AzureSearch`	Yes

AzureAISearchQueryType

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

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

AzureAISearchTool

A informação de definição de entrada para uma ferramenta de busca de IA do Azure usada para configurar um agente.

Nome	Tipo	Description	Obrigatório
azure_ai_search	AzureAISearchToolResource	Um conjunto de recursos de índice usados pela ferramenta `azure_ai_search`.	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 ferramenta azure_ai_search.

Nome	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.	Yes

AzureFunctionBinding

A estrutura para manter storage nome e URI da fila.

Nome	Tipo	Description	Obrigatório
storage_queue	AzureFunctionStorageQueue	A estrutura para manter storage nome e URI da fila.	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 de função Azure.

Nome	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 storage nome e URI da fila.	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 storage nome e URI da fila.	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 storage nome e URI da fila.

Nome	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

A informação de definição de entrada para uma Ferramenta de Função do Azure, usada para configurar um Agente.

Nome	Tipo	Description	Obrigatório
azure_function	AzureFunctionDefinition	A definição de 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

AzureOpenAIModelConfiguration

Azure OpenAI configuração de modelos. A versão da API seria selecionada pelo serviço para consultar o modelo.

Nome	Tipo	Description	Obrigatório	Default
modelDeploymentName	cadeia	Nome da implantação do modelo AOAI. Exemplo: gpt-4o se estiver em AIServices ou baseado em `connection_name/deployment_name` conexão (por exemplo). `my-aoai-connection/gpt-4o`	Yes
tipo	enumeração	Valores possíveis: `AzureOpenAIModel`	Yes

BaseCredentials

Uma classe base para credenciais de conexão

Discriminatório para BaseCredentials

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

Digite um valor	Schema
`ApiKey`	ApiKeyCredentials
`AAD`	EntraIDCredentials
`CustomKeys`	Customcredential
`SAS`	SASCredentials
`None`	NoAuthenticationCredentials
`AgenticIdentityToken_Preview`	AgenticIdentityPreviewCredentials

Nome	Tipo	Description	Obrigatório	Default
tipo	CredentialType (somente leitura)	O tipo de credencial usado pela conexão	Yes

BingCustomSearchConfiguration

Uma bing configuração de pesquisa personalizada.

Nome	Tipo	Description	Obrigatório
count	inteiro	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 um Bing ferramenta de pesquisa personalizada, conforme usado para configurar um agente.

Nome	Tipo	Description	Obrigatório
bing_custom_search_preview	BingCustomSearchToolParameters	O bing parâmetros da ferramenta de pesquisa personalizada.	Yes
└─ search_configurations	matriz de BingCustomSearchConfiguration	O project conexões 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

O bing parâmetros da ferramenta de pesquisa personalizada.

Nome	Tipo	Description	Obrigatório	Default
search_configurations	matriz de BingCustomSearchConfiguration	O project conexões anexadas a essa ferramenta. Pode haver um máximo de 1 conexão recurso anexado à ferramenta.	Yes

BingGroundingSearchConfiguration

Configuração de pesquisa para a base de Bing

Nome	Tipo	Description	Obrigatório
count	inteiro	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

O bing parâmetros da ferramenta de pesquisa de aterramento.

Nome	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.	Yes

BingGroundingTool

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

Nome	Tipo	Description	Obrigatório
bing_grounding	BingGroundingSearchToolParameters	O bing parâmetros da ferramenta de pesquisa de aterramento.	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

BlobReference

Detalhes de referência de blob.

Nome	Tipo	Description	Obrigatório
blobUri	cadeia	Caminho do URI do blob para o cliente carregar dados. Exemplo: `https://blob.windows.core.net/Container/Path`	Yes
credencial	SasCredential	Definição de credencial SAS	Yes
└─ sasUri	cadeia de caracteres (somente leitura)	URI de SAS	Yes
└─ tipo	enumeração	Tipo de credencial Valores possíveis: `SAS`	Yes
storageAccountArmId	cadeia	ID do ARM da conta de armazenamento a ser usada.	Yes

BrowserAutomationPreviewTool

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

Nome	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.

Nome	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.

Nome	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

Nome	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

ChartCoordinate

Coordenadas para o gráfico de análise.

Nome	Tipo	Description	Obrigatório
size	inteiro	Tamanho do elemento de gráfico.	Yes
x	inteiro	Coordenada do eixo X.	Yes
y	inteiro	Coordenada do eixo Y.	Yes

ChatSummaryMemoryItem

Um item de memória que contém um resumo extraído de conversas.

Nome	Tipo	Description	Obrigatório
conteúdo	cadeia	O conteúdo da memória.	Yes
kind	enumeração	O tipo do item de memória. Valores possíveis: `chat_summary`	Yes
memory_id	cadeia	A ID exclusiva do item de memória.	Yes
escopo	cadeia	O namespace que agrupa e isola logicamente as memórias, como um ID do usuário.	Yes
updated_at	inteiro	A hora da última atualização do item de memória.	Yes

ClusterInsightResult

Insights da análise de cluster.

Nome	Tipo	Description	Obrigatório
clusters	matriz de InsightCluster	Lista de clusters identificados nos insights.	Yes
Coordenadas	objeto	Mapeamento opcional de IDs para coordenadas 2D usadas pela UX para visualização. As chaves de mapa são identificadores de cadeia de caracteres (por exemplo, uma ID de cluster ou uma ID de exemplo) e os valores são as coordenadas e o tamanho do visual para renderização em um gráfico 2D. Essa propriedade é omitida a menos que o cliente solicite coordenadas (por exemplo, passando `includeCoordinates=true` como um parâmetro de consulta). Exemplo: `<br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br>` As coordenadas são destinadas apenas à visualização do lado do cliente e não modifique os resultados de insights canônicos.	No
resumo	InsightSummary	Resumo da análise do cluster de erros.	Yes
Método └─	cadeia	Método usado para clustering.	Yes
└─ Contagem de Amostras	inteiro	Número total de amostras analisadas.	Yes
└─ uniqueClusterCount	inteiro	Número total de clusters exclusivos.	Yes
└─ uniqueSubclusterCount	inteiro	Número total de rótulos de subcluster exclusivos.	Yes
└─ uso	ClusterTokenUsage	Uso de token durante a execução da análise de clustering	Yes

ClusterTokenUsage

Uso de token para análise de cluster

Nome	Tipo	Description	Obrigatório
inputTokenUsage	inteiro	uso de token de entrada	Yes
outputTokenUsage	inteiro	uso do token de saída	Yes
totalTokenUsage	inteiro	uso total de token	Yes

CodeBasedEvaluatorDefinition

Definição de avaliador baseada em código usando código python

Nome	Tipo	Description	Obrigatório
code_text	cadeia	Texto de código embutido para o avaliador	Yes
data_schema	objeto	O esquema JSON (rascunho 2020-12) para os dados de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	No
init_parameters	objeto	O esquema JSON (Rascunho 2020-12) para os parâmetros de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	No
métricas	objeto	Lista de métricas de saída produzidas por este avaliador	No
tipo	enumeração	Valores possíveis: `code`	Yes

CompletionMessageToolCallChunk

Detalhes da chamada da ferramenta em uma mensagem.

Nome	Tipo	Description	Obrigatório
função	FunctionToolCall	Detalhes de uma chamada de ferramenta de função.	No
└─ Argumentos	cadeia	Os argumentos com os quais chamar a função, conforme gerado pelo modelo no formato JSON.	Yes
└─ nome	cadeia	O nome da função a ser chamada.	Yes
id	cadeia	A ID da chamada da ferramenta.	Yes
tipo	enumeração	O tipo de chamada de ferramenta, que é sempre "função". Valores possíveis: `function`	Yes

Conexão

Resposta da lista e operações get connections

Nome	Tipo	Description	Obrigatório
credenciais	BaseCredentials (somente leitura)	Uma classe base para credenciais de conexão	Yes
└─ tipo	CredentialType (somente leitura)	O tipo de credencial usado pela conexão	Yes
id	cadeia de caracteres (somente leitura)	Um identificador exclusivo para a conexão, gerado pelo serviço	Yes
isDefault	booliano (somente leitura)	Se a conexão é marcada como a conexão padrão de seu tipo	Yes
metadados	objeto (somente leitura)	Metadados da conexão	Yes
nome	cadeia de caracteres (somente leitura)	O nome amigável da conexão, fornecido pelo usuário.	Yes
destino	cadeia de caracteres (somente leitura)	A URL de conexão a ser usada para este serviço	Yes
tipo	ConnectionType (somente leitura)	O tipo (ou categoria) da conexão	Yes

ConnectionType

O tipo (ou categoria) da conexão

Property	Valor
Description	O tipo (ou categoria) da conexão
Type	cadeia
Valores	`AzureOpenAI` `AzureBlob` `AzureStorageAccount` `CognitiveSearch` `CosmosDB` `ApiKey` `AppConfig` `AppInsights` `CustomKeys` `RemoteTool_Preview`

ContainerAppAgentDefinition

A definição do agente do aplicativo de contêiner.

Nome	Tipo	Description	Obrigatório
container_app_resource_id	cadeia	A ID do recurso do aplicativo de contêiner Azure que hospeda esse agente. Não mutável entre versões.	Yes
container_protocol_versions	matriz de ProtocolVersionRecord	Os protocolos aos quais o agente dá suporte para a comunicação de entrada dos contêineres.	Yes
ingress_subdomain_suffix	cadeia	O sufixo a ser aplicado ao subdomínio do aplicativo ao enviar a entrada para o agente. Isso pode ser um rótulo (por exemplo, '---currente'), uma revisão específica (por exemplo, '--0000001') ou vazio para usar o ponto de extremidade padrão para o aplicativo de contêiner.	Yes
kind	enumeração	Valores possíveis: `container_app`	Yes
rai_config	RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).	No
└─ rai_policy_name	cadeia	O nome da política RAI a ser aplicada.	Yes

ContainerDetails

Informações detalhadas sobre o contêiner.

Nome	Tipo	Description	Obrigatório
health_state	cadeia	O estado de integridade do contêiner.	Yes
provisioning_error	cadeia	O erro de provisionamento do contêiner, se houver.	No
provisioning_state	cadeia	O estado de provisionamento do contêiner.	Yes
replicas	matriz de ContainerReplica	A lista de réplicas no contêiner.	Yes
estado	cadeia	O estado do contêiner.	Yes
updated_on	cadeia	A hora da última atualização do contêiner.	Yes

ContainerLogKind

O tipo de logs a serem transmitidos de um contêiner.

Property	Valor
Type	cadeia
Valores	`console` `system`

ContainerReplica

Informações sobre uma réplica de contêiner.

Nome	Tipo	Description	Obrigatório
container_state	cadeia	O estado do contêiner da réplica.	Yes
nome	cadeia	O nome da réplica.	Yes
estado	cadeia	O estado da réplica.	Yes

ContinuousEvaluationRuleAction

Ação de regra de avaliação para avaliação contínua.

Nome	Tipo	Description	Obrigatório
evalId	cadeia	Eval Id para adicionar execuções de avaliação contínua.	Yes
maxHourlyRuns	inteiro	Número máximo de execuções de avaliação permitidas por hora.	No
tipo	enumeração	Valores possíveis: `continuousEvaluation`	Yes

Índice CosmosDB

Definição de índice do repositório de vetores do CosmosDB

Nome	Tipo	Description	Obrigatório
id	cadeia de caracteres (somente leitura)	ID do ativo, um identificador exclusivo para o ativo	No
nome	cadeia de caracteres (somente leitura)	O nome do recurso	Yes
tipo	enumeração	Tipo de índice Valores possíveis: `CosmosDBNoSqlVectorStore`	Yes
versão	cadeia de caracteres (somente leitura)	A versão do recurso	Yes

CosmosDBIndexUpdate

Definição de índice do repositório de vetores do CosmosDB

Nome	Tipo	Description	Obrigatório
description	cadeia	O texto de descrição do ativo.	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No
tipo	enumeração	Tipo de índice Valores possíveis: `CosmosDBNoSqlVectorStore`	Yes

CreateAgentFromManifestRequest

Nome	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
nome	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

Nome	Tipo	Description	Obrigatório
definição	AgentDefinition		Yes
└─ tipo	AgentKind		Yes
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).	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
nome	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

Nome	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

Nome	Tipo	Description	Obrigatório
definição	AgentDefinition		Yes
└─ tipo	AgentKind		Yes
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).	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

CriarSolicitacaoDeAvaliacao

Nome	Tipo	Description	Obrigatório
configuração_da_fonte_de_dados	OpenAI.CreateEvalCustomDataSourceConfig ou OpenAI.CreateEvalLogsDataSourceConfig ou OpenAI.CreateEvalStoredCompletionsDataSourceConfig ou AzureAIDataSourceConfig	A configuração da fonte de dados usada para as execuções de avaliação. Determina o esquema dos dados usados na avaliação.	Yes
metadados	OpenAI.Metadata (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.	No
nome	cadeia	O nome da avaliação.	No
properties	objeto	Conjunto de 16 pares chave-valor imutáveis que podem ser anexados a um objeto para armazenar informações adicionais. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No
critérios_de_teste	matriz de OpenAI.EvalGraderLabelModel ou OpenAI.EvalGraderStringCheck ou OpenAI.EvalGraderTextSimilarity ou OpenAI.EvalGraderPython ou OpenAI.EvalGraderScoreModel ou EvalGraderAzureAIEvaluator	Uma lista de avaliadores para todas as execuções de avaliação neste grupo. Os alunos podem fazer referência a variáveis na fonte de dados usando notação de chaves duplas, como `{{item.variable_name}}`. Para fazer referência à saída do modelo, use o `sample` namespace (ou seja, `{{sample.output_text}}`).	Yes

CreateEvalRunRequest

Nome	Tipo	Description	Obrigatório
fonte_de_dados	OpenAI.CreateEvalJsonlRunDataSource ou OpenAI.CreateEvalCompletionsRunDataSource ou OpenAI.CreateEvalResponsesRunDataSource ou EvalRunDataSource	Detalhes sobre a fonte de dados da execução.	Yes
metadados	OpenAI.Metadata (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.	No
nome	cadeia	O nome da execução.	No
properties	objeto	Conjunto de 16 pares chave-valor imutáveis que podem ser anexados a um objeto para armazenar informações adicionais. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No

CredentialType

O tipo de credencial usado pela conexão

Property	Valor
Description	O tipo de credencial usado pela conexão
Type	cadeia
Valores	`ApiKey` `AAD` `SAS` `CustomKeys` `None` `AgenticIdentityToken_Preview`

CronTrigger

Gatilho baseado em cron.

Nome	Tipo	Description	Obrigatório	Default
endTime	cadeia	Hora de término do cronograma cron no formato ISO 8601.	No
expressão	cadeia	Expressão cron que define a frequência do agendamento.	Yes
startTime	cadeia	Hora de início do agendamento cron no formato ISO 8601.	No
timeZone	cadeia	Fuso horário para o agendamento do cron.	No	UTC
tipo	enumeração	Valores possíveis: `Cron`	Yes

Customcredential

Definição de credencial personalizada

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	O tipo de credencial Valores possíveis: `CustomKeys`	Yes

Esse objeto também aceita propriedades adicionais do tipo: cadeia de caracteres

DailyRecurrenceSchedule

Cronograma diário de recorrência.

Nome	Tipo	Description	Obrigatório	Default
hours	matriz de inteiro	Horas para o agendamento de recorrência.	Yes
tipo	enumeração	Tipo de recorrência diária. Valores possíveis: `Daily`	Yes

DataSourceConfig

Classe base para executar fontes de dados com suporte discriminatório.

Discriminador para DataSourceConfig

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

Digite um valor	Schema

Nome	Tipo	Description	Obrigatório	Default
esquema	objeto	O esquema JSON de objeto geral para os itens de fonte de dados de execução.	Yes
tipo	cadeia	O tipo de fonte de dados discriminatório.	Yes

DatasetType

Enumerar para determinar o tipo de dados.

Property	Valor
Description	Enumerar para determinar o tipo de dados.
Type	cadeia
Valores	`uri_file` `uri_folder`

DatasetVersion

Definição de DatasetVersion

Discriminador para DatasetVersion

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

Digite um valor	Schema
`uri_file`	FileDatasetVersion
`uri_folder`	FolderDatasetVersion

Nome	Tipo	Description	Obrigatório
Connectionname	cadeia	O nome da conexão da conta de Armazenamento do Azure. Obrigatório se startPendingUploadVersion não foi chamado antes de criar o conjunto de dados	No
dataUri	cadeia	URI dos dados (exemplo) Restrições: minLength: 1, padrão: `[a-zA-Z0-9_]`	Yes
id	cadeia de caracteres (somente leitura)	ID do ativo, um identificador exclusivo para o ativo	No
Isreference	booliano (somente leitura)	Indica se o conjunto de dados contém uma referência ao armazenamento ou se o conjunto de dados gerencia o próprio armazenamento. Se for true, os dados subjacentes não serão excluídos quando a versão do conjunto de dados for excluída	No
nome	cadeia de caracteres (somente leitura)	O nome do recurso	Yes
tipo	DatasetType	Enumerar para determinar o tipo de dados.	Yes
versão	cadeia de caracteres (somente leitura)	A versão do recurso	Yes

DatasetVersionUpdate

Definição de DatasetVersion

Discriminador para DatasetVersionUpdate

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

Digite um valor	Schema
`uri_file`	FileDatasetVersionUpdate
`uri_folder`	FolderDatasetVersionUpdate

Nome	Tipo	Description	Obrigatório
description	cadeia	O texto de descrição do ativo.	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No
tipo	DatasetType	Enumerar para determinar o tipo de dados.	Yes

Dayofweek

Dias da semana para cronograma de recorrência.

Property	Valor
Description	Dias da semana para cronograma de recorrência.
Type	cadeia
Valores	`Sunday` `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday`

DeleteAgentResponse

Um objeto de agente excluído

Nome	Tipo	Description	Obrigatório
excluído	boolean	Se o agente foi excluído com êxito.	Yes
nome	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

Nome	Tipo	Description	Obrigatório
excluído	boolean	Se o agente foi excluído com êxito.	Yes
nome	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

DeleteEvalResponse

Um objeto de avaliação excluído

Nome	Tipo	Description	Obrigatório
excluído	boolean	Se a avaliação foi excluída com êxito.	Yes
eval_id	cadeia	ID da eval.	Yes
objeto	enumeração	O tipo de objeto. Sempre 'eval.deleted'. Valores possíveis: `eval.deleted`	Yes

DeleteEvalRunResponse

Um objeto de execução de avaliação excluído.

Nome	Tipo	Description	Obrigatório
excluído	boolean	Se a avaliação foi excluída com êxito.	No
objeto	enumeração	O tipo de objeto. Sempre 'eval.deleted'. Valores possíveis: `eval.deleted`	No
run_id	cadeia	ID da eval.	No

DeleteMemoryStoreResponse

Nome	Tipo	Description	Obrigatório
excluído	boolean	Se o repositório de memória foi excluído com êxito.	Yes
nome	cadeia	O nome do repositório de memória.	Yes
objeto	enumeração	O tipo de objeto. Sempre 'memory_store.deleted'. Valores possíveis: `memory_store.deleted`	Yes

DeleteResponseResult

O resultado de uma operação de resposta de exclusão.

Nome	Tipo	Description	Obrigatório
excluído	enumeração	Sempre retornar true Valores possíveis: `True`	Yes
id	cadeia	A ID da operação.	Yes
objeto	enumeração	Sempre retorne "resposta". Valores possíveis: `response`	Yes

Deployment

Definição de implantação de modelo

Discriminatório para implantação

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

Digite um valor	Schema
`ModelDeployment`	ModelDeployment

Nome	Tipo	Description	Obrigatório	Default
nome	cadeia de caracteres (somente leitura)	Nome da implantação	Yes
tipo	Deploymenttype		Yes

Deploymenttype

Property	Valor
Type	cadeia
Valores	`ModelDeployment`

EntraIDCredentials

Entra ID definição de credenciais

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	O tipo de credencial Valores possíveis: `AAD`	Yes

Eval

Um objeto Eval com critérios de teste e configuração de fonte de dados. Uma avaliação representa uma tarefa a ser concluída na sua integração de LLM. Como:

Melhorar a qualidade do meu chatbot
Veja como meu chatbot lida bem com o suporte ao cliente
Verifique se o o4-mini é melhor em meu uso do que gpt-4o

Nome	Tipo	Description	Obrigatório
criado_em	inteiro	O carimbo de data/hora Unix (em segundos) da criação da avaliação.	Yes
created_by	cadeia	o nome da pessoa que criou a execução.	No
configuração_da_fonte_de_dados	OpenAI.CreateEvalCustomDataSourceConfig ou OpenAI.CreateEvalLogsDataSourceConfig ou OpenAI.CreateEvalStoredCompletionsDataSourceConfig ou AzureAIDataSourceConfig	Configuração de fontes de dados usadas em execuções da avaliação.	Yes
id	cadeia	Identificador exclusivo para a avaliação.	Yes
metadados	OpenAI.Metadata (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
modified_at	inteiro		No
nome	cadeia	O nome da avaliação.	Yes
objeto	enumeração	O tipo de objeto. Valores possíveis: `eval`	Yes
properties	objeto	Conjunto de 16 pares chave-valor imutáveis que podem ser anexados a um objeto para armazenar informações adicionais. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No
critérios_de_teste	matriz de OpenAI.EvalGraderLabelModel ou OpenAI.EvalGraderStringCheck ou OpenAI.EvalGraderTextSimilarity ou OpenAI.EvalGraderPython ou OpenAI.EvalGraderScoreModel ou EvalGraderAzureAIEvaluator	Uma lista de critérios de teste.	Yes

EvalCsvFileIdSource

Representa uma referência a um arquivo CSV carregado usado como fonte para dados de avaliação.

Nome	Tipo	Description	Obrigatório	Default
id	cadeia	O identificador do arquivo CSV carregado.	Yes
tipo	enumeração	O tipo de origem, sempre `file_id`. Valores possíveis: `file_id`	Yes

EvalCsvRunDataSource

Representa uma fonte de dados CSV para execuções de avaliação.

Nome	Tipo	Description	Obrigatório
fonte	EvalCsvFileIdSource	Representa uma referência a um arquivo CSV carregado usado como fonte para dados de avaliação.	Yes
└─ id	cadeia	O identificador do arquivo CSV carregado.	Yes
└─ tipo	enumeração	O tipo de origem, sempre `file_id`. Valores possíveis: `file_id`	Yes
tipo	enumeração	O tipo de fonte de dados, always `csv`. Valores possíveis: `csv`	Yes

EvalGraderAzureAIEvaluator

Nome	Tipo	Description	Obrigatório
mapeamento de dados	objeto	O modelo a ser usado para a avaliação. Deve dar suporte a saídas estruturadas.	No
evaluator_name	cadeia	O nome do avaliador.	Yes
evaluator_version	cadeia	A versão do avaliador. Versão mais recente, se não for especificada.	No
initialization_parameters	objeto	Os parâmetros de inicialização para a avaliação. Deve dar suporte a saídas estruturadas.	No
nome	cadeia	O nome do avaliador.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `azure_ai_evaluator`. Valores possíveis: `azure_ai_evaluator`	Yes

EvalResult

Resultado da avaliação.

Nome	Tipo	Description	Obrigatório
nome	cadeia	nome da verificação	Yes
Passado	boolean	indica se a verificação foi aprovada ou falhou	Yes
pontuação	número	pontuação	Yes
tipo	cadeia	tipo da verificação	Yes

EvalRun

Um esquema que representa um processo de avaliação.

Nome	Tipo	Description	Obrigatório
criado_em	inteiro	Carimbo de data/hora Unix (em segundos) da criação da execução de avaliação.	Yes
created_by	cadeia	o nome da pessoa que criou a execução.	No
fonte_de_dados	OpenAI.CreateEvalJsonlRunDataSource ou OpenAI.CreateEvalCompletionsRunDataSource ou OpenAI.CreateEvalResponsesRunDataSource ou EvalRunDataSource	Informações sobre a fonte de dados da execução.	Yes
erro	OpenAI.EvalApiError	Um objeto que representa uma resposta de erro da API de Eval.	Yes
eval_id	cadeia	O identificador da avaliação associada.	Yes
id	cadeia	Identificador exclusivo para a execução da avaliação.	Yes
metadados	OpenAI.Metadata (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
modelo	cadeia	O modelo que é avaliado, se aplicável.	Yes
modified_at	inteiro		No
nome	cadeia	O nome da execução da avaliação.	Yes
objeto	enumeração	O tipo do objeto. Sempre "eval.run". Valores possíveis: `eval.run`	Yes
per_model_usage	matriz de OpenAI.EvalRunPerModelUsage	Estatísticas de uso para cada modelo durante a execução da avaliação.	Yes
resultados_por_critério_de_teste	matriz de OpenAI.EvalRunPerTestingCriteriaResults	Resultados por critérios de teste aplicados durante a execução da avaliação.	Yes
properties	objeto	Conjunto de 16 pares chave-valor imutáveis que podem ser anexados a um objeto para armazenar informações adicionais. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No
report_url	cadeia	A URL para o relatório da execução da avaliação no painel da interface do usuário.	Yes
contagem_de_resultados	OpenAI.EvalRunResultCounts		Yes
└─ erro	OpenAI.integer		Yes
└─ falha	OpenAI.integer		Yes
└─ aprovado	OpenAI.integer		Yes
└─ Total	OpenAI.integer		Yes
status	cadeia	O status da execução da avaliação.	Yes

EvalRunDataSource

Classe base para executar fontes de dados com suporte discriminatório.

Discriminador para EvalRunDataSource

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

Digite um valor	Schema
`azure_ai_traces_preview`	TracesPreviewEvalRunDataSource
`azure_ai_synthetic_data_gen_preview`	SyntheticDataGenerationPreviewEvalRunDataSource
`azure_ai_responses`	AzureAIResponsesEvalRunDataSource
`azure_ai_target_completions`	TargetCompletionEvalRunDataSource
`csv`	EvalCsvRunDataSource
`azure_ai_red_team`	RedTeamEvalRunDataSource

Nome	Tipo	Description	Obrigatório	Default
tipo	cadeia	O tipo de fonte de dados discriminatório.	Yes

EvalRunOutputItem

Um esquema que representa um item de saída de um processo de avaliação.

Nome	Tipo	Description	Obrigatório
criado_em	inteiro	Carimbo de data/hora Unix (em segundos) da criação da execução de avaliação.	Yes
datasource_item	objeto	Detalhes do item da fonte de dados de entrada.	Yes
identificador_do_item_da_fonte_de_dados	OpenAI.integer		Yes
eval_id	cadeia	O identificador do grupo de avaliação.	Yes
id	cadeia	Identificador exclusivo para o item de saída da execução da avaliação.	Yes
objeto	enumeração	O tipo do objeto. Sempre "eval.run.output_item". Valores possíveis: `eval.run.output_item`	Yes
results	matriz de EvalRunOutputItemResult	Uma lista de resultados do classificador para este item de saída.	Yes
run_id	cadeia	O identificador da execução de avaliação associada a este item de saída.	Yes
amostra	OpenAI.EvalRunOutputItemSample		Yes
└─ erro	OpenAI.EvalApiError	Um objeto que representa uma resposta de erro da API de Eval.	Yes
└─ motivo_de_conclusão	cadeia		Yes
└─ entrada	matriz de EvalRunOutputItemSampleInput		Yes
└─ max_completion_tokens (máximo de tokens de conclusão)	OpenAI.integer		Yes
└─ modelo	cadeia		Yes
└─ saída	matriz de EvalRunOutputItemSampleOutput		Yes
└─ semente	OpenAI.integer		Yes
└─ temperatura	OpenAI.numeric		Yes
└─ top_p	OpenAI.numeric		Yes
└─ uso	OpenAI.EvalRunOutputItemSampleUsage		Yes
status	cadeia	O status da execução da avaliação.	Yes

EvalRunOutputItemResult

Um único resultado de grade para um item de saída de execução de avaliação.

Nome	Tipo	Description	Obrigatório
etiqueta	cadeia	O rótulo associado à métrica de critérios de teste (por exemplo, "pass", "fail", "good", "bad").	No
métrica	cadeia	O nome da métrica (por exemplo, "fluência", "f1_score").	No
nome	cadeia	O nome do avaliador.	Yes
Passado	boolean	Se o classificador considerou a saída uma passagem.	Yes
properties	objeto	Detalhes adicionais sobre a métrica de critérios de teste.	No
reason	cadeia	O motivo da métrica de critérios de teste.	No
amostra	objeto (anulável)	Exemplo opcional ou dados intermediários produzidos pelo classificador.	No
pontuação	OpenAI.numeric		Yes
limite	número	O limite usado para determinar a aprovação/falha para esse critério de teste, se for numérico.	No
tipo	cadeia	O tipo de classificador (por exemplo, "string-check-grader").	No

Esse objeto também aceita propriedades adicionais.

EvalRunOutputItemSampleInput

Uma mensagem na execução da avaliação.

Nome	Tipo	Description	Obrigatório
conteúdo	cadeia		Yes
função	cadeia		Yes
tool_calls	matriz de CompletionMessageToolCallChunk	Chamadas de ferramenta feitas dentro da mensagem, se houver.	Yes

EvalRunOutputItemSampleOutput

Uma mensagem na execução da avaliação.

Nome	Tipo	Description	Obrigatório
conteúdo	cadeia		No
função	cadeia		No
tool_calls	matriz de CompletionMessageToolCallChunk	Chamadas de ferramenta feitas dentro da mensagem, se houver.	Yes

EvalRunResultCompareItem

Comparação métrica para um tratamento em relação à linha de base.

Nome	Tipo	Description	Obrigatório
deltaEstimate	número	Diferença estimada entre o tratamento e a linha de base.	Yes
Pvalue	número	Valor P para o efeito de tratamento.	Yes
treatmentEffect	TreatmentEffectType	Tipo de efeito de tratamento.	Yes
treatmentRunId	cadeia	A ID da execução do tratamento.	Yes
treatmentRunSummary	EvalRunResultSummary	Estatísticas resumidas de uma métrica em uma execução de avaliação.	Yes
└─ média	número	Valor médio da métrica na execução da avaliação.	Yes
└─ runId	cadeia	A ID da execução de avaliação.	Yes
└─ Contagem de Amostras	inteiro	Número de exemplos na execução de avaliação.	Yes
└─ Desvio padrão	número	Desvio padrão da métrica na execução da avaliação.	Yes

EvalRunResultComparison

Os resultados da comparação para o tratamento são executados em relação à linha de base.

Nome	Tipo	Description	Obrigatório
baselineRunSummary	EvalRunResultSummary	Estatísticas resumidas de uma métrica em uma execução de avaliação.	Yes
└─ média	número	Valor médio da métrica na execução da avaliação.	Yes
└─ runId	cadeia	A ID da execução de avaliação.	Yes
└─ Contagem de Amostras	inteiro	Número de exemplos na execução de avaliação.	Yes
└─ Desvio padrão	número	Desvio padrão da métrica na execução da avaliação.	Yes
compareItems	matriz de EvalRunResultCompareItem	Lista de resultados de comparação para cada execução de tratamento.	Yes
Avaliador	cadeia	Nome do avaliador para esses critérios de teste.	Yes
métrica	cadeia	Métrica que está sendo avaliada.	Yes
testingCriteria	cadeia	Nome dos critérios de teste.	Yes

EvalRunResultSummary

Estatísticas resumidas de uma métrica em uma execução de avaliação.

Nome	Tipo	Description	Obrigatório
Média	número	Valor médio da métrica na execução da avaliação.	Yes
runId	cadeia	A ID da execução de avaliação.	Yes
sampleCount	inteiro	Número de exemplos na execução de avaliação.	Yes
standardDeviation	número	Desvio padrão da métrica na execução da avaliação.	Yes

EvaluationComparisonInsightRequest

Solicitação de comparação de avaliação

Nome	Tipo	Description	Obrigatório
baselineRunId	cadeia	A ID de execução da linha de base para comparação.	Yes
evalId	cadeia	Identificador para a avaliação.	Yes
treatmentRunIds	matriz de strings	Lista de IDs de execução de tratamento para comparação.	Yes
tipo	enumeração	O tipo de solicitação. Valores possíveis: `EvaluationComparison`	Yes

EvaluationComparisonInsightResult

Insights da comparação de avaliação.

Nome	Tipo	Description	Obrigatório
Comparações	matriz de EvalRunResultComparison	Resultados de comparação para cada tratamento executado em relação à linha de base.	Yes
método	cadeia	O método estatístico usado para comparação.	Yes
tipo	enumeração	O tipo de resultado de insights. Valores possíveis: `EvaluationComparison`	Yes

EvaluationResultSample

Uma amostra do resultado da avaliação.

Nome	Tipo	Description	Obrigatório
correlationInfo	objeto	Informações sobre a correlação do exemplo de análise.	Yes
evaluationResult	EvalResult	Resultado da avaliação.	Yes
└─ nome	cadeia	nome da verificação	Yes
└─ aprovado	boolean	indica se a verificação foi aprovada ou falhou	Yes
└─ pontuação	número	pontuação	Yes
└─ tipo	cadeia	tipo da verificação	Yes
features	objeto	Recursos para ajudar na filtragem adicional de dados no UX.	Yes
id	cadeia	O identificador exclusivo do exemplo de análise.	Yes
tipo	enumeração	Tipo de exemplo de resultado de avaliação Valores possíveis: `EvaluationResultSample`	Yes

Regra de avaliação

Modelo de regra de avaliação.

Nome	Tipo	Description	Obrigatório
ação	EvaluationRuleAction	Modelo de ação de avaliação.	Yes
└─ tipo	EvaluationRuleActionType	Tipo de ação de avaliação.	Yes
description	cadeia	Descrição da regra de avaliação.	No
displayName	cadeia	Nome de Exibição para a regra de avaliação.	No
enabled	boolean	Indica se a regra de avaliação está habilitada. O padrão é true.	Yes
eventType	EvaluationRuleEventType	Tipo do evento de regra de avaliação.	Yes
filtro	EvaluationRuleFilter	Modelo de filtro de avaliação.	No
└─ agentName	cadeia	Filtrar pelo nome do agente.	Yes
id	cadeia de caracteres (somente leitura)	Identificador exclusivo para a regra de avaliação.	Yes
systemData	objeto (somente leitura)	Metadados do sistema para a regra de avaliação.	Yes

EvaluationRuleAction

Modelo de ação de avaliação.

Discriminador para EvaluationRuleAction

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

Digite um valor	Schema
`continuousEvaluation`	ContinuousEvaluationRuleAction
`humanEvaluationPreview`	HumanEvaluationPreviewRuleAction

Nome	Tipo	Description	Obrigatório	Default
tipo	EvaluationRuleActionType	Tipo de ação de avaliação.	Yes

EvaluationRuleActionType

Tipo de ação de avaliação.

Property	Valor
Description	Tipo de ação de avaliação.
Type	cadeia
Valores	`continuousEvaluation` `humanEvaluationPreview`

EvaluationRuleEventType

Tipo do evento de regra de avaliação.

Property	Valor
Description	Tipo do evento de regra de avaliação.
Type	cadeia
Valores	`responseCompleted` `manual`

EvaluationRuleFilter

Modelo de filtro de avaliação.

Nome	Tipo	Description	Obrigatório	Default
nome_do_agente	cadeia	Filtrar pelo nome do agente.	Yes

EvaluationRunClusterInsightRequest

Insights sobre o conjunto de resultados da avaliação

Nome	Tipo	Description	Obrigatório
evalId	cadeia	ID de avaliação para os insights.	Yes
modelConfiguration	InsightModelConfiguration	Configuração do modelo usado na geração de insights.	No
└─ modelDeploymentName	cadeia	A implantação do modelo a ser avaliada. Aceita o nome da implantação sozinho ou com o nome da conexão como `{connectionName}/<modelDeploymentName>`.	Yes
runIds	matriz de strings	Lista de IDs de execução de avaliação para os insights.	Yes
tipo	enumeração	O tipo de solicitação de insights. Valores possíveis: `EvaluationRunClusterInsight`	Yes

EvaluationRunClusterInsightResult

Os insights da análise de cluster de execução de avaliação.

Nome	Tipo	Description	Obrigatório	Default
clusterInsight	ClusterInsightResult	Insights da análise de cluster.	Yes
tipo	enumeração	O tipo de resultado de insights. Valores possíveis: `EvaluationRunClusterInsight`	Yes

EvaluationScheduleTask

Tarefa de avaliação para o cronograma.

Nome	Tipo	Description	Obrigatório
configuração	objeto	Configuração da tarefa.	No
evalId	cadeia	Identificador do grupo de avaliação.	Yes
evalRun	objeto	O conteúdo da execução de avaliação.	Yes
tipo	enumeração	Valores possíveis: `Evaluation`	Yes

EvaluationTaxonomy

Definição de taxonomia de avaliação

Nome	Tipo	Description	Obrigatório
id	cadeia de caracteres (somente leitura)	ID do ativo, um identificador exclusivo para o ativo	No
nome	cadeia de caracteres (somente leitura)	O nome do recurso	Yes
properties	objeto	Propriedades adicionais para a taxonomia de avaliação.	No
taxonomyCategories	matriz de TaxonomyCategory	Lista de categorias de taxonomia.	No
taxonomyInput	EvaluationTaxonomyInput	Configuração de entrada para a taxonomia de avaliação.	Yes
└─ tipo	EvaluationTaxonomyInputType	Tipo de entrada da taxonomia de avaliação.	Yes
versão	cadeia de caracteres (somente leitura)	A versão do recurso	Yes

EvaluationTaxonomyCreateOrUpdate

Definição de taxonomia de avaliação

Nome	Tipo	Description	Obrigatório
description	cadeia	O texto de descrição do ativo.	No
properties	objeto	Propriedades adicionais para a taxonomia de avaliação.	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No
taxonomyCategories	matriz de TaxonomyCategory	Lista de categorias de taxonomia.	No
taxonomyInput	EvaluationTaxonomyInput	Configuração de entrada para a taxonomia de avaliação.	Yes
└─ tipo	EvaluationTaxonomyInputType	Tipo de entrada da taxonomia de avaliação.	Yes

EvaluationTaxonomyInput

Configuração de entrada para a taxonomia de avaliação.

Discriminador para EvaluationTaxonomyInput

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

Digite um valor	Schema
`agent`	AgentTaxonomyInput

Nome	Tipo	Description	Obrigatório	Default
tipo	EvaluationTaxonomyInputType	Tipo de entrada da taxonomia de avaliação.	Yes

EvaluationTaxonomyInputType

Tipo de entrada da taxonomia de avaliação.

Property	Valor
Description	Tipo de entrada da taxonomia de avaliação.
Type	cadeia
Valores	`agent` `policy`

EvaluationTaxonomyInputUpdate

Configuração de entrada para a taxonomia de avaliação.

Discriminador para EvaluationTaxonomyInputUpdate

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

Digite um valor	Schema
`agent`	AgentTaxonomyInputUpdate

Nome	Tipo	Description	Obrigatório	Default
tipo	EvaluationTaxonomyInputType	Tipo de entrada da taxonomia de avaliação.	Yes

EvaluationTaxonomyUpdate

Definição de taxonomia de avaliação

Nome	Tipo	Description	Obrigatório
description	cadeia	O texto de descrição do ativo.	No
properties	objeto	Propriedades adicionais para a taxonomia de avaliação.	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No
taxonomyCategories	matriz de TaxonomyCategory	Lista de categorias de taxonomia.	No
taxonomyInput	EvaluationTaxonomyInputUpdate	Configuração de entrada para a taxonomia de avaliação.	No
└─ tipo	EvaluationTaxonomyInputType	Tipo de entrada da taxonomia de avaliação.	Yes

EvaluatorCategory

A categoria do avaliador

Property	Valor
Description	A categoria do avaliador
Type	cadeia
Valores	`quality` `safety` `agents`

EvaluatorDefinition

Configuração do avaliador base com discriminador

Discriminador para EvaluatorDefinition

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

Digite um valor	Schema
`code`	CodeBasedEvaluatorDefinition
`prompt`	PromptBasedEvaluatorDefinition

Nome	Tipo	Description	Obrigatório
data_schema	objeto	O esquema JSON (rascunho 2020-12) para os dados de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	No
init_parameters	objeto	O esquema JSON (Rascunho 2020-12) para os parâmetros de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	No
métricas	objeto	Lista de métricas de saída produzidas por este avaliador	No
tipo	EvaluatorDefinitionType	O tipo de definição do avaliador	Yes

EvaluatorDefinitionType

O tipo de definição do avaliador

Property	Valor
Description	O tipo de definição do avaliador
Type	cadeia
Valores	`prompt` `code` `prompt_and_code` `service` `openai_graders`

EvaluatorMetric

Métrica do avaliador

Nome	Tipo	Description	Obrigatório
desirable_direction	EvaluatorMetricDirection	A direção da métrica que indica se um valor mais alto é melhor, um valor mais baixo é melhor ou neutro	No
is_primary	boolean	Indica se essa métrica é primária quando há várias métricas.	No
Max_value	número	Valor máximo para a métrica. Se não for especificado, supõe-se que ele não esteja associado.	No
Min_value	número	Valor mínimo para a métrica	No
tipo	EvaluatorMetricType	O tipo de avaliador	No

EvaluatorMetricDirection

A direção da métrica que indica se um valor mais alto é melhor, um valor mais baixo é melhor ou neutro

Property	Valor
Description	A direção da métrica que indica se um valor mais alto é melhor, um valor mais baixo é melhor ou neutro
Type	cadeia
Valores	`increase` `decrease` `neutral`

EvaluatorMetricType

O tipo de avaliador

Property	Valor
Description	O tipo de avaliador
Type	cadeia
Valores	`ordinal` `continuous` `boolean`

EvaluatorType

O tipo de avaliador

Property	Valor
Description	O tipo de avaliador
Type	cadeia
Valores	`builtin` `custom`

EvaluatorVersion

Definição de avaliador

Nome	Tipo	Description	Obrigatório
categories	matriz de EvaluatorCategory	As categorias do avaliador	Yes
criado_em	cadeia de caracteres (somente leitura)	Data/hora de criação do avaliador	Yes
created_by	cadeia de caracteres (somente leitura)	Criador do avaliador	Yes
definição	EvaluatorDefinition	Configuração do avaliador base com discriminador	Yes
└─ data_schema	objeto	O esquema JSON (rascunho 2020-12) para os dados de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	No
└─ init_parameters	objeto	O esquema JSON (Rascunho 2020-12) para os parâmetros de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	No
└─ métricas	objeto	Lista de métricas de saída produzidas por este avaliador	No
└─ tipo	EvaluatorDefinitionType	O tipo de definição do avaliador	Yes
display_name	cadeia	Nome de exibição para o avaliador. Ajuda a encontrar o avaliador facilmente no AI Foundry. Não precisa ser único.	No
evaluator_type	EvaluatorType	O tipo de avaliador	Yes
id	cadeia de caracteres (somente leitura)	ID do ativo, um identificador exclusivo para o ativo	No
metadados	objeto	Metadados sobre o avaliador	No
modified_at	cadeia de caracteres (somente leitura)	Data/hora da última modificação do avaliador	Yes
nome	cadeia de caracteres (somente leitura)	O nome do recurso	Yes
versão	cadeia de caracteres (somente leitura)	A versão do recurso	Yes

EvaluatorVersionCreate

Definição de avaliador

Nome	Tipo	Description	Obrigatório
categories	matriz de EvaluatorCategory	As categorias do avaliador	Yes
definição	EvaluatorDefinition	Configuração do avaliador base com discriminador	Yes
└─ data_schema	objeto	O esquema JSON (rascunho 2020-12) para os dados de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	No
└─ init_parameters	objeto	O esquema JSON (Rascunho 2020-12) para os parâmetros de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	No
└─ métricas	objeto	Lista de métricas de saída produzidas por este avaliador	No
└─ tipo	EvaluatorDefinitionType	O tipo de definição do avaliador	Yes
description	cadeia	O texto de descrição do ativo.	No
display_name	cadeia	Nome de exibição para o avaliador. Ajuda a encontrar o avaliador facilmente no AI Foundry. Não precisa ser único.	No
evaluator_type	EvaluatorType	O tipo de avaliador	Yes
metadados	objeto	Metadados sobre o avaliador	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No

EvaluatorVersionUpdate

Definição de avaliador

Nome	Tipo	Description	Obrigatório
categories	matriz de EvaluatorCategory	As categorias do avaliador	No
description	cadeia	O texto de descrição do ativo.	No
display_name	cadeia	Nome de exibição para o avaliador. Ajuda a encontrar o avaliador facilmente no AI Foundry. Não precisa ser único.	No
metadados	objeto	Metadados sobre o avaliador	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No

FabricDataAgentToolParameters

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

Nome	Tipo	Description	Obrigatório	Default
project_connections	matriz de ToolProjectConnection	O project conexões anexadas a essa ferramenta. Pode haver um máximo de 1 conexão recurso anexado à ferramenta.	No

FileDatasetVersion

Definição de FileDatasetVersion

Nome	Tipo	Description	Obrigatório
Connectionname	cadeia	O nome da conexão da conta de Armazenamento do Azure. Obrigatório se startPendingUploadVersion não foi chamado antes de criar o conjunto de dados	No
dataUri	cadeia	URI dos dados (exemplo) Restrições: minLength: 1, padrão: `[a-zA-Z0-9_]`	Yes
id	cadeia de caracteres (somente leitura)	ID do ativo, um identificador exclusivo para o ativo	No
Isreference	booliano (somente leitura)	Indica se o conjunto de dados contém uma referência ao armazenamento ou se o conjunto de dados gerencia o próprio armazenamento. Se for true, os dados subjacentes não serão excluídos quando a versão do conjunto de dados for excluída	No
nome	cadeia de caracteres (somente leitura)	O nome do recurso	Yes
tipo	enumeração	Tipo de conjunto de dados Valores possíveis: `uri_file`	Yes
versão	cadeia de caracteres (somente leitura)	A versão do recurso	Yes

FileDatasetVersionUpdate

Definição de FileDatasetVersion

Nome	Tipo	Description	Obrigatório
description	cadeia	O texto de descrição do ativo.	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No
tipo	enumeração	Tipo de conjunto de dados Valores possíveis: `uri_file`	Yes

FolderDatasetVersion

Definição de FileDatasetVersion

Nome	Tipo	Description	Obrigatório
Connectionname	cadeia	O nome da conexão da conta de Armazenamento do Azure. Obrigatório se startPendingUploadVersion não foi chamado antes de criar o conjunto de dados	No
dataUri	cadeia	URI dos dados (exemplo) Restrições: minLength: 1, padrão: `[a-zA-Z0-9_]`	Yes
id	cadeia de caracteres (somente leitura)	ID do ativo, um identificador exclusivo para o ativo	No
Isreference	booliano (somente leitura)	Indica se o conjunto de dados contém uma referência ao armazenamento ou se o conjunto de dados gerencia o próprio armazenamento. Se for true, os dados subjacentes não serão excluídos quando a versão do conjunto de dados for excluída	No
nome	cadeia de caracteres (somente leitura)	O nome do recurso	Yes
tipo	enumeração	Tipo de conjunto de dados Valores possíveis: `uri_folder`	Yes
versão	cadeia de caracteres (somente leitura)	A versão do recurso	Yes

FolderDatasetVersionUpdate

Definição de FileDatasetVersion

Nome	Tipo	Description	Obrigatório
description	cadeia	O texto de descrição do ativo.	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No
tipo	enumeração	Tipo de conjunto de dados Valores possíveis: `uri_folder`	Yes

FunctionToolCall

Detalhes de uma chamada de ferramenta de função.

Nome	Tipo	Description	Obrigatório	Default
arguments	cadeia	Os argumentos com os quais chamar a função, conforme gerado pelo modelo no formato JSON.	Yes
nome	cadeia	O nome da função a ser chamada.	Yes

HostedAgentDefinition

A definição do agente hospedado.

Nome	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
kind	enumeração	Valores possíveis: `hosted`	Yes
memória	cadeia	A configuração de memória para o agente hospedado.	Yes
rai_config	RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).	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

HourlyRecurrenceSchedule

Cronograma de recorrência por hora.

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

HumanEvaluationPreviewRuleAction

Ação de regra de avaliação para avaliação humana.

Nome	Tipo	Description	Obrigatório	Default
templateId	AssetId	Identificador de um ativo salvo.	Yes
tipo	enumeração	Valores possíveis: `humanEvaluationPreview`	Yes

Índice

Definição de recurso de índice

Discriminador para Índice

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

Digite um valor	Schema
`AzureSearch`	AzureAISearchIndex
`ManagedAzureSearch`	ManagedAzureAISearchIndex
`CosmosDBNoSqlVectorStore`	CosmosDBIndex

Nome	Tipo	Description	Obrigatório
id	cadeia de caracteres (somente leitura)	ID do ativo, um identificador exclusivo para o ativo	No
nome	cadeia de caracteres (somente leitura)	O nome do recurso	Yes
tipo	IndexType		Yes
versão	cadeia de caracteres (somente leitura)	A versão do recurso	Yes

IndexType

Property	Valor
Type	cadeia
Valores	`AzureSearch` `CosmosDBNoSqlVectorStore` `ManagedAzureSearch`

IndexUpdate

Definição de recurso de índice

Discriminatório para IndexUpdate

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

Digite um valor	Schema
`AzureSearch`	AzureAISearchIndexUpdate
`ManagedAzureSearch`	ManagedAzureAISearchIndexUpdate
`CosmosDBNoSqlVectorStore`	CosmosDBIndexUpdate

Nome	Tipo	Description	Obrigatório
description	cadeia	O texto de descrição do ativo.	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No
tipo	IndexType		Yes

Insight

O corpo da resposta para insights de cluster.

Nome	Tipo	Description	Obrigatório
displayName	cadeia	Nome de exibição amigável para o insight.	Yes
id	cadeia de caracteres (somente leitura)	O identificador exclusivo do relatório de insights.	Yes
metadados	InsightsMetadata (somente leitura)	Metadados sobre os insights.	Yes
└─ concluído At	cadeia	O carimbo de data/hora quando os insights foram concluídos.	No
└─ criadoAt	cadeia	O carimbo de data/hora quando os insights foram criados.	Yes
solicitação	InsightRequest	A solicitação do relatório de insights.	Yes
└─ tipo	InsightType	O tipo de solicitação.	Yes
Resultado	InsightResult (somente leitura)	O resultado dos insights.	No
└─ tipo	InsightType	O tipo de resultado de insights.	Yes
estado	Azure. Core.Foundations.OperationState (somente leitura)	Enumeração que descreve os estados de operação permitidos.	Yes

InsightCluster

Um conjunto de amostras de análise.

Nome	Tipo	Description	Obrigatório
description	cadeia	Descrição do cluster de análise.	Yes
id	cadeia	A ID do cluster de análise.	Yes
etiqueta	cadeia	Rótulo para o cluster	Yes
Amostras	matriz de InsightSample	Lista de exemplos que pertencem a esse cluster. Vazio se os exemplos fizerem parte de subclusters.	No
subClusters	matriz de InsightCluster	Lista de subclusters dentro desse cluster. Vazio se nenhum subcluster existir.	No
sugestão	cadeia	Sugestão para o cluster	Yes
suggestionTitle	cadeia	O título da sugestão para o cluster	Yes
weight	inteiro	O peso do cluster de análise. Isso indica o número de exemplos no cluster.	Yes

InsightModelConfiguration

Configuração do modelo usado na geração de insights.

Nome	Tipo	Description	Obrigatório	Default
modelDeploymentName	cadeia	A implantação do modelo a ser avaliada. Aceita o nome da implantação sozinho ou com o nome da conexão como `{connectionName}/<modelDeploymentName>`.	Yes

InsightRequest

A solicitação do relatório de insights.

Discriminador para InsightRequest

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

Digite um valor	Schema
`EvaluationRunClusterInsight`	EvaluationRunClusterInsightRequest
`AgentClusterInsight`	AgentClusterInsightRequest
`EvaluationComparison`	EvaluationComparisonInsightRequest

Nome	Tipo	Description	Obrigatório	Default
tipo	InsightType	O pedido dos insights.	Yes

InsightResult

O resultado dos insights.

Discriminador para InsightResult

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

Digite um valor	Schema
`EvaluationComparison`	EvaluationComparisonInsightResult
`EvaluationRunClusterInsight`	EvaluationRunClusterInsightResult
`AgentClusterInsight`	AgentClusterInsightResult

Nome	Tipo	Description	Obrigatório	Default
tipo	InsightType	O pedido dos insights.	Yes

InsightSample

Uma amostra da análise.

Discriminador para InsightSample

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

Digite um valor	Schema
`EvaluationResultSample`	EvaluationResultSample

Nome	Tipo	Description	Obrigatório
correlationInfo	objeto	Informações sobre a correlação do exemplo de análise.	Yes
features	objeto	Recursos para ajudar na filtragem adicional de dados no UX.	Yes
id	cadeia	O identificador exclusivo do exemplo de análise.	Yes
tipo	Sampletype	O tipo de amostra usada na análise.	Yes

InsightScheduleTask

Tarefa de insight para o agendamento.

Nome	Tipo	Description	Obrigatório
configuração	objeto	Configuração da tarefa.	No
insight	Insights	O corpo da resposta para insights de cluster.	Yes
└─ displayName	cadeia	Nome de exibição amigável para o insight.	Yes
└─ id	cadeia de caracteres (somente leitura)	O identificador exclusivo do relatório de insights.	Yes
└─ metadados	InsightsMetadata (somente leitura)	Metadados sobre o relatório de insights.	Yes
└─ solicitação	InsightRequest	Solicite a análise de insights.	Yes
└─ resultado	InsightResult (somente leitura)	O resultado do relatório de insights.	No
└─ estado	Azure. Core.Foundations.OperationState (somente leitura)	O estado atual dos insights.	Yes
tipo	enumeração	Valores possíveis: `Insight`	Yes

InsightSummary

Resumo da análise do cluster de erros.

Nome	Tipo	Description	Obrigatório
método	cadeia	Método usado para clustering.	Yes
sampleCount	inteiro	Número total de amostras analisadas.	Yes
uniqueClusterCount	inteiro	Número total de clusters exclusivos.	Yes
uniqueSubclusterCount	inteiro	Número total de rótulos de subcluster exclusivos.	Yes
uso	ClusterTokenUsage	Uso de token para análise de cluster	Yes
└─ inputTokenUsage	inteiro	uso de token de entrada	Yes
└─ outputTokenUsage	inteiro	uso do token de saída	Yes
└─ totalTokenUsage	inteiro	uso total de token	Yes

InsightType

O pedido dos insights.

Property	Valor
Description	O pedido dos insights.
Type	cadeia
Valores	`EvaluationRunClusterInsight` `AgentClusterInsight` `EvaluationComparison`

InsightsMetadata

Metadados sobre os insights.

Nome	Tipo	Description	Obrigatório	Default
completedAt	cadeia	O carimbo de data/hora quando os insights foram concluídos.	No
createdAt	cadeia	O carimbo de data/hora quando os insights foram criados.	Yes

ItemGenerationParams

Representa o conjunto de parâmetros usados para controlar as operações de geração de item.

Discriminador para ItemGenerationParams

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

Digite um valor	Schema
`red_team`	RedTeamItemGenerationParams
`red_team_seed_prompts`	RedTeamSeedPromptsItemGenerationParams
`red_team_taxonomy`	RedTeamTaxonomyItemGenerationParams
`response_retrieval`	ResponseRetrievalItemGenerationParams

Nome	Tipo	Description	Obrigatório	Default
tipo	ItemGenerationParamsType	Os tipos de parâmetros para a geração de item de equipe vermelha.	Yes

ItemGenerationParamsType

Os tipos de parâmetros para a geração de item de equipe vermelha.

Property	Valor
Description	Os tipos de parâmetros para a geração de item de equipe vermelha.
Type	cadeia
Valores	`red_team` `response_retrieval` `red_team_seed_prompts` `red_team_taxonomy` `synthetic_data_gen_preview`

ManagedAzureAISearchIndex

Definição de índice de Pesquisa de IA do Azure gerenciado

Nome	Tipo	Description	Obrigatório
id	cadeia de caracteres (somente leitura)	ID do ativo, um identificador exclusivo para o ativo	No
nome	cadeia de caracteres (somente leitura)	O nome do recurso	Yes
tipo	enumeração	Tipo de índice Valores possíveis: `ManagedAzureSearch`	Yes
versão	cadeia de caracteres (somente leitura)	A versão do recurso	Yes

ManagedAzureAISearchIndexUpdate

Definição de índice de Pesquisa de IA do Azure gerenciado

Nome	Tipo	Description	Obrigatório
description	cadeia	O texto de descrição do ativo.	No
tags	objeto	Dicionário de tags. As marcas podem ser adicionadas, removidas e atualizadas.	No
tipo	enumeração	Tipo de índice Valores possíveis: `ManagedAzureSearch`	Yes

MemoryItem

Um único item de memória armazenado no armazenamento de memória, contendo conteúdo e metadados.

Discriminador para MemoryItem

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

Digite um valor	Schema
`user_profile`	UserProfileMemoryItem
`chat_summary`	ChatSummaryMemoryItem

Nome	Tipo	Description	Obrigatório
conteúdo	cadeia	O conteúdo da memória.	Yes
kind	MemoryItemKind	Tipo de item de memória.	Yes
memory_id	cadeia	A ID exclusiva do item de memória.	Yes
escopo	cadeia	O namespace que agrupa e isola logicamente as memórias, como um ID do usuário.	Yes
updated_at	inteiro	A hora da última atualização do item de memória.	Yes

MemoryItemKind

Tipo de item de memória.

Property	Valor
Description	Tipo de item de memória.
Type	cadeia
Valores	`user_profile` `chat_summary`

MemoryOperation

Representa uma única operação de memória (criar, atualizar ou excluir) executada em um item de memória.

Nome	Tipo	Description	Obrigatório
kind	MemoryOperationKind	Tipo de operação de memória.	Yes
memory_item	MemoryItem	Um único item de memória armazenado no armazenamento de memória, contendo conteúdo e metadados.	Yes
└─ conteúdo	cadeia	O conteúdo da memória.	Yes
└─ tipo	MemoryItemKind	O tipo do item de memória.	Yes
└─ memory_id	cadeia	A ID exclusiva do item de memória.	Yes
└─ escopo	cadeia	O namespace que agrupa e isola logicamente as memórias, como um ID do usuário.	Yes
└─ updated_at	inteiro	A hora da última atualização do item de memória.	Yes

MemoryOperationKind

Tipo de operação de memória.

Property	Valor
Description	Tipo de operação de memória.
Type	cadeia
Valores	`create` `update` `delete`

MemorySearchItem

Um item de memória recuperado da pesquisa de memória.

Nome	Tipo	Description	Obrigatório
memory_item	MemoryItem	Um único item de memória armazenado no armazenamento de memória, contendo conteúdo e metadados.	Yes
└─ conteúdo	cadeia	O conteúdo da memória.	Yes
└─ tipo	MemoryItemKind	O tipo do item de memória.	Yes
└─ memory_id	cadeia	A ID exclusiva do item de memória.	Yes
└─ escopo	cadeia	O namespace que agrupa e isola logicamente as memórias, como um ID do usuário.	Yes
└─ updated_at	inteiro	A hora da última atualização do item de memória.	Yes

MemorySearchOptions

Opções de pesquisa de memória.

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

MemorySearchPreviewTool

Uma ferramenta para integrar memórias ao agente.

Nome	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 um ID de usuário. Limita quais memórias podem ser recuperadas ou atualizadas. Use uma variável `{{$userId}}` especial para definir o escopo das memórias para o usuário conectado atual.	Yes
search_options	MemorySearchOptions	Opções de pesquisa de memória.	No
└─ max_memories	inteiro	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	Tempo de espera antes de atualizar as memórias após inatividade (segundos). Padrão 300.	No	300

MemorySearchToolCallItemParam

Nome	Tipo	Description	Obrigatório	Default
results	matriz de MemorySearchItem	Os resultados retornados da pesquisa de memória.	No
tipo	enumeração	Valores possíveis: `memory_search_call`	Yes

MemorySearchToolCallItemResource

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
response_id	cadeia	A resposta na qual o item é criado.	No
results	matriz de MemorySearchItem	Os resultados retornados da pesquisa de memória.	No
status	enumeração	O status da chamada da ferramenta de pesquisa de memória. Uma opção entre `in_progress`, `searching` `completed`, `incomplete`ou `failed`, Valores possíveis: `in_progress`, , `searching`, `completed`, `incomplete`, `failed`	Yes
tipo	enumeração	Valores possíveis: `memory_search_call`	Yes

MemoryStoreDefaultDefinition

Implementação de armazenamento de memória padrão.

Nome	Tipo	Description	Obrigatório	Default
chat_model	cadeia	O nome ou identificador da implantação do modelo de conclusão de chat usado para processamento de memória.	Yes
embedding_model	cadeia	O nome ou identificador da implantação do modelo de inserção usado para processamento de memória.	Yes
kind	enumeração	O tipo do repositório de memória. Valores possíveis: `default`	Yes
Opções	MemoryStoreDefaultOptions	Configurações padrão do armazenamento de memória.	No
└─ chat_summary_enabled	boolean	Se deseja habilitar a extração de resumo de chat e storage. O padrão é true.	Yes	Verdade
└─ user_profile_details	cadeia	Categorias ou tipos específicos de informações de perfil de usuário a serem extraídas e armazenadas.	No
└─ user_profile_enabled	boolean	Se deseja habilitar a extração de perfil de usuário e storage. O padrão é true.	Yes	Verdade

MemoryStoreDefaultOptions

Configurações padrão do armazenamento de memória.

Nome	Tipo	Description	Obrigatório	Default
chat_summary_enabled	boolean	Se deseja habilitar a extração de resumo de chat e storage. O padrão é true.	Yes	Verdade
user_profile_details	cadeia	Categorias ou tipos específicos de informações de perfil de usuário a serem extraídas e armazenadas.	No
user_profile_enabled	boolean	Se deseja habilitar a extração de perfil de usuário e storage. O padrão é true.	Yes	Verdade

MemoryStoreDefinition

Definição de base para configurações de armazenamento de memória.

Discriminador para MemoryStoreDefinition

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

Digite um valor	Schema
`default`	MemoryStoreDefaultDefinition

Nome	Tipo	Description	Obrigatório	Default
kind	MemoryStoreKind	O tipo de implementação de armazenamento de memória a ser usada.	Yes

MemoryStoreDeleteScopeResponse

Resposta para excluir memórias de um escopo.

Nome	Tipo	Description	Obrigatório
excluído	boolean	Se a operação de exclusão foi bem-sucedida.	Yes
nome	cadeia	O nome do repositório de memória.	Yes
objeto	enumeração	O tipo de objeto. Sempre 'memory_store.scope.deleted'. Valores possíveis: `memory_store.scope.deleted`	Yes
escopo	cadeia	O escopo do qual as memórias foram excluídas.	Yes

MemoryStoreKind

O tipo de implementação de armazenamento de memória a ser usada.

Property	Valor
Description	O tipo de implementação de armazenamento de memória a ser usada.
Type	cadeia
Valores	`default`

MemoryStoreObject

Um armazenamento de memória que pode armazenar e recuperar memórias do usuário.

Nome	Tipo	Description	Obrigatório
criado_em	inteiro	O carimbo de data/hora Unix (segundos) quando o repositório de memória foi criado.	Yes
definição	MemoryStoreDefinition	Definição de base para configurações de armazenamento de memória.	Yes
└─ tipo	MemoryStoreKind	O tipo do repositório de memória.	Yes
description	cadeia	Uma descrição legível pelo ser humano do repositório de memória. Restrições: maxLength: 512	No
id	cadeia	O identificador exclusivo do repositório de memória.	Yes
metadados	objeto	Metadados arbitrários de chave-valor a serem associados ao repositório de memória.	No
nome	cadeia	O nome do repositório de memória. Restrições: maxLength: 256	Yes
objeto	enumeração	O tipo de objeto, que é sempre "memory_store". Valores possíveis: `memory_store`	Yes
updated_at	inteiro	O carimbo de data/hora unix (segundos) quando o repositório de memória foi atualizado pela última vez.	Yes

MemoryStoreOperationUsage

Estatísticas de uso de uma operação de armazenamento de memória.

Nome	Tipo	Description	Obrigatório
embedding_tokens	inteiro	O número de tokens de inserção.	Yes
input_tokens	OpenAI.integer		Yes
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Yes
└─ tokens em cache	OpenAI.integer		Yes
output_tokens	OpenAI.integer		Yes
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Yes
└─ tokens_de_raciocínio	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

MemoryStoreSearchResponse

Resposta de pesquisa de memória.

Nome	Tipo	Description	Obrigatório
Memórias	matriz de MemorySearchItem	Itens de memória relacionados encontrados durante a operação de pesquisa.	Yes
search_id	cadeia	A ID exclusiva dessa solicitação de pesquisa. Use esse valor como previous_search_id em solicitações subsequentes para executar pesquisas incrementais.	Yes
uso	MemoryStoreOperationUsage	Estatísticas de uso de uma operação de armazenamento de memória.	Yes
└─ embedding_tokens	inteiro	O número de tokens de inserção.	Yes
└─ tokens de entrada	OpenAI.integer	O número de tokens de entrada.	Yes
└─ detalhes_de_tokens_de_entrada	OpenAI.ResponseUsageInputTokensDetails	Um detalhamento detalhado dos tokens de entrada.	Yes
└─ tokens_de_saída	OpenAI.integer	O número de tokens de saída.	Yes
└─ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Um detalhamento detalhado dos tokens de saída.	Yes
└─ tokens_totais	OpenAI.integer	O número total de tokens usados.	Yes

MemoryStoreUpdateCompletedResult

Resultado da atualização da memória.

Nome	Tipo	Description	Obrigatório
memory_operations	matriz de MemoryOperation	Uma lista de operações de memória individuais que foram executadas durante a atualização.	Yes
uso	MemoryStoreOperationUsage	Estatísticas de uso de uma operação de armazenamento de memória.	Yes
└─ embedding_tokens	inteiro	O número de tokens de inserção.	Yes
└─ tokens de entrada	OpenAI.integer	O número de tokens de entrada.	Yes
└─ detalhes_de_tokens_de_entrada	OpenAI.ResponseUsageInputTokensDetails	Um detalhamento detalhado dos tokens de entrada.	Yes
└─ tokens_de_saída	OpenAI.integer	O número de tokens de saída.	Yes
└─ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Um detalhamento detalhado dos tokens de saída.	Yes
└─ tokens_totais	OpenAI.integer	O número total de tokens usados.	Yes

MemoryStoreUpdateResponse

Fornece o status de uma operação de atualização do repositório de memória.

Nome	Tipo	Description	Obrigatório
erro	OpenAI.Error		No
└─ Informação adicional	objeto		No
└─ código	cadeia de caracteres (anulável)		Yes
└─ debugInfo	objeto		No
└─ detalhes	matriz de OpenAI.Error		No
Mensagem └─	cadeia		Yes
└─ Param	cadeia de caracteres (anulável)		No
└─ tipo	cadeia		No
Resultado	MemoryStoreUpdateCompletedResult	Resultado da atualização da memória.	No
└─ memory_operations	matriz de MemoryOperation	Uma lista de operações de memória individuais que foram executadas durante a atualização.	Yes
└─ uso	MemoryStoreOperationUsage	Estatísticas de uso associadas à operação de atualização de memória.	Yes
status	MemoryStoreUpdateStatus	Status de uma operação de atualização do repositório de memória.	Yes
superseded_by	cadeia	O update_id a operação foi substituído por quando o status é "substituído".	No
update_id	cadeia	A ID exclusiva desta solicitação de atualização. Use esse valor como previous_update_id em solicitações subsequentes para executar atualizações incrementais.	Yes

MemoryStoreUpdateStatus

Status de uma operação de atualização do repositório de memória.

Property	Valor
Type	cadeia
Valores	`queued` `in_progress` `completed` `failed` `superseded`

MicrosoftFabricPreviewTool

A informação de definição de entrada para uma ferramenta Microsoft Fabric usada para configurar um agente.

Nome	Tipo	Description	Obrigatório
fabric_dataagent_preview	FabricDataAgentToolParameters	Os parâmetros da ferramenta do agente de dados de malha.	Yes
└─ project_connections	matriz de ToolProjectConnection	O project conexões 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

ModelDeployment

Definição de implantação de modelo

Nome	Tipo	Description	Obrigatório
capabilities	objeto (somente leitura)	Funcionalidades do modelo implantado	Yes
Connectionname	cadeia de caracteres (somente leitura)	Nome da conexão da qual a implantação vem	No
modelName	cadeia de caracteres (somente leitura)	Publisher nome específico do modelo implantado	Yes
modelPublisher	cadeia de caracteres (somente leitura)	Nome do editor do modelo implantado	Yes
modelVersion	cadeia de caracteres (somente leitura)	Publisher versão específica do modelo implantado	Yes
nome	cadeia de caracteres (somente leitura)	Nome da implantação	Yes
sku	Sku (somente leitura)	Informações de SKU	Yes
└─ capacidade	inteiro	Capacidade de SKU	Yes
└─ família	cadeia	Família Sku	Yes
└─ nome	cadeia	Nome do SKU	Yes
└─ tamanho	cadeia	Tamanho do SKU	Yes
└─ camada	cadeia	Camada de SKU	Yes
tipo	enumeração	O tipo da implantação Valores possíveis: `ModelDeployment`	Yes

ModelSamplingParams

Representa um conjunto de parâmetros usados para controlar o comportamento de amostragem de um modelo de linguagem durante a geração de texto.

Nome	Tipo	Description	Obrigatório
max_completion_tokens	inteiro	O número máximo de tokens permitidos na conclusão.	Yes
seed	inteiro	A semente aleatória para reprodutibilidade.	Yes
Temperatura	número	O parâmetro de temperatura para amostragem.	Yes
top_p	número	O parâmetro top-p para amostragem de núcleo.	Yes

ModelSamplingParamsUpdate

Representa um conjunto de parâmetros usados para controlar o comportamento de amostragem de um modelo de linguagem durante a geração de texto.

Nome	Tipo	Description	Obrigatório
max_completion_tokens	inteiro	O número máximo de tokens permitidos na conclusão.	No
seed	inteiro	A semente aleatória para reprodutibilidade.	No
Temperatura	número	O parâmetro de temperatura para amostragem.	No
top_p	número	O parâmetro top-p para amostragem de núcleo.	No

MonthlyRecurrenceSchedule

Cronograma mensal de recorrência.

Nome	Tipo	Description	Obrigatório	Default
daysOfMonth	matriz de inteiro	Dias do mês para o agendamento de recorrência.	Yes
tipo	enumeração	Tipo de recorrência mensal. Valores possíveis: `Monthly`	Yes

NoAuthenticationCredentials

Credenciais que não exigem autenticação

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	O tipo de credencial Valores possíveis: `None`	Yes

OAuthConsentRequestOutputItem

Solicitação do serviço para que o usuário execute o consentimento do OAuth.

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
consent_link	cadeia	O link que o usuário pode usar para executar o consentimento do OAuth.	Yes
id	cadeia		Yes
response_id	cadeia	A resposta na qual o item é criado.	No
etiqueta_do_servidor	cadeia	O rótulo do servidor para a solicitação de consentimento OAuth.	Yes
tipo	enumeração	Valores possíveis: `oauth_consent_request`	Yes

OneTimeTrigger

Gatilho único.

Nome	Tipo	Description	Obrigatório	Default
timeZone	cadeia	Fuso horário para o gatilho único.	No	UTC
triggerAt	cadeia	Data e hora do gatilho único no formato ISO 8601.	Yes
tipo	enumeração	Valores possíveis: `OneTime`	Yes

OpenAI.Annotation

Uma anotação que se aplica a um intervalo de texto de saída.

Discriminador para OpenAI.Annotation

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

Digite um valor	Schema
`file_citation`	OpenAI.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.AnnotationType		Yes

OpenAI.AnnotationType

Property	Valor
Type	cadeia
Valores	`file_citation` `url_citation` `container_file_citation` `file_path`

OpenAI.ApplyPatchCallOutputStatus

Property	Valor
Type	cadeia
Valores	`completed` `failed`

OpenAI.ApplyPatchCallOutputStatusParam

Valores de resultado relatados para saídas de chamada de ferramenta de apply_patch.

Property	Valor
Type	cadeia
Valores	`completed` `failed`

OpenAI.ApplyPatchCallStatus

Property	Valor
Type	cadeia
Valores	`in_progress` `completed`

OpenAI.ApplyPatchCallStatusParam

Valores de status relatados para chamadas de ferramenta de apply_patch.

Property	Valor
Type	cadeia
Valores	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

Instrução que descreve como criar um arquivo por meio da ferramenta apply_patch.

Nome	Tipo	Description	Obrigatório
Diff	cadeia	Difusão a ser aplicada.	Yes
caminho	cadeia	Caminho do arquivo a ser criado.	Yes
tipo	enumeração	Crie um novo arquivo com a diferença fornecida. Valores possíveis: `create_file`	Yes

OpenAI.ApplyPatchCreateFileOperationParam

Instrução para criar um novo arquivo por meio da ferramenta apply_patch.

Nome	Tipo	Description	Obrigatório
Diff	cadeia	Conteúdo unificado para aplicar ao criar o arquivo. Restrições: maxLength: 10485760	Yes
caminho	cadeia	Caminho do arquivo a ser criado em relação à raiz do workspace. Restrições: minLength: 1	Yes
tipo	enumeração	O tipo de operação. Sempre `create_file`. Valores possíveis: `create_file`	Yes

OpenAI.ApplyPatchDeleteFileOperation

Instrução que descreve como excluir um arquivo por meio da ferramenta apply_patch.

Nome	Tipo	Description	Obrigatório	Default
caminho	cadeia	Caminho do arquivo a ser excluído.	Yes
tipo	enumeração	Exclua o arquivo especificado. Valores possíveis: `delete_file`	Yes

OpenAI.ApplyPatchDeleteFileOperationParam

Instrução para excluir um arquivo existente por meio da ferramenta apply_patch.

Nome	Tipo	Description	Obrigatório	Default
caminho	cadeia	Caminho do arquivo a ser excluído em relação à raiz do workspace. Restrições: minLength: 1	Yes
tipo	enumeração	O tipo de operação. Sempre `delete_file`. Valores possíveis: `delete_file`	Yes

OpenAI.ApplyPatchFileOperation

Uma das operações de create_file, delete_file ou update_file aplicadas por meio de apply_patch.

Discriminador para OpenAI.ApplyPatchFileOperation

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

Digite um valor	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ApplyPatchFileOperationType		Yes

OpenAI.ApplyPatchFileOperationType

Property	Valor
Type	cadeia
Valores	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchOperationParam

Uma das operações de create_file, delete_file ou update_file fornecidas à ferramenta apply_patch.

Discriminador para OpenAI.ApplyPatchOperationParam

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

Digite um valor	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperationParam
`delete_file`	OpenAI.ApplyPatchDeleteFileOperationParam
`update_file`	OpenAI.ApplyPatchUpdateFileOperationParam

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ApplyPatchOperationParamType		Yes

OpenAI.ApplyPatchOperationParamType

Property	Valor
Type	cadeia
Valores	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

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

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

OpenAI.ApplyPatchUpdateFileOperation

Instrução que descreve como atualizar um arquivo por meio da ferramenta apply_patch.

Nome	Tipo	Description	Obrigatório
Diff	cadeia	Difusão a ser aplicada.	Yes
caminho	cadeia	Caminho do arquivo a ser atualizado.	Yes
tipo	enumeração	Atualize um arquivo existente com a diferença fornecida. Valores possíveis: `update_file`	Yes

OpenAI.ApplyPatchUpdateFileOperationParam

Instrução para atualizar um arquivo existente por meio da ferramenta apply_patch.

Nome	Tipo	Description	Obrigatório
Diff	cadeia	Conteúdo diferencial unificado para aplicar ao arquivo existente. Restrições: maxLength: 10485760	Yes
caminho	cadeia	Caminho do arquivo a ser atualizado em relação à raiz do workspace. Restrições: minLength: 1	Yes
tipo	enumeração	O tipo de operação. Sempre `update_file`. Valores possíveis: `update_file`	Yes

OpenAI.ApproximateLocation

Nome	Tipo	Description	Obrigatório
Cidade	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

Ferramenta de Conclusão de Chat da OpenAI

Uma ferramenta de função que pode ser usada para gerar uma resposta.

Nome	Tipo	Description	Obrigatório	Default
função	OpenAI.FunctionObject		Yes
tipo	enumeração	O tipo da ferramenta. Atualmente, há suporte apenas para `function`. Valores possíveis: `function`	Yes

OpenAI.ChatModel

Property Valor

Type cadeia

Valores gpt-5.2
gpt-5.2-2025-12-11
gpt-5.2-chat-latest
gpt-5.2-pro
gpt-5.2-pro-2025-12-11
gpt-5.1
gpt-5.1-2025-11-13
gpt-5.1-codex
gpt-5.1-mini
gpt-5.1-chat-latest
gpt-5
gpt-5-mini
gpt-5-nano
gpt-5-2025-08-07
gpt-5-mini-2025-08-07
gpt-5-nano-2025-08-07
gpt-5-chat-latest
gpt-4.1
gpt-4.1-mini
gpt-4.1-nano
gpt-4.1-2025-04-14
gpt-4.1-mini-2025-04-14
gpt-4.1-nano-2025-04-14
o4-mini
o4-mini-2025-04-16
o3
o3-2025-04-16
o3-mini
o3-mini-2025-01-31
o1
o1-2024-12-17
o1-preview
o1-preview-2024-09-12
o1-mini
o1-mini-2024-09-12
gpt-4o
gpt-4o-2024-11-20
gpt-4o-2024-08-06
gpt-4o-2024-05-13
gpt-4o-audio-preview
gpt-4o-audio-preview-2024-10-01
gpt-4o-audio-preview-2024-12-17
gpt-4o-audio-preview-2025-06-03
gpt-4o-mini-audio-preview
gpt-4o-mini-audio-preview-2024-12-17
gpt-4o-search-preview
gpt-4o-mini-search-preview
gpt-4o-search-preview-2025-03-11
gpt-4o-mini-search-preview-2025-03-11
chatgpt-4o-latest
codex-mini-latest
gpt-4o-mini
gpt-4o-mini-2024-07-18
gpt-4-turbo
gpt-4-turbo-2024-04-09
gpt-4-0125-preview
gpt-4-turbo-preview
gpt-4-1106-preview
gpt-4-vision-preview
gpt-4
gpt-4-0314
gpt-4-0613
gpt-4-32k
gpt-4-32k-0314
gpt-4-32k-0613
gpt-3.5-turbo
gpt-3.5-turbo-16k
gpt-3.5-turbo-0301
gpt-3.5-turbo-0613
gpt-3.5-turbo-1106
gpt-3.5-turbo-0125
gpt-3.5-turbo-16k-0613

OpenAI.ClickButtonType

Property	Valor
Type	cadeia
Valores	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

Uma ação de clique.

Nome	Tipo	Description	Obrigatório
botão	OpenAI.ClickButtonType		Yes
tipo	enumeração	Especifica o tipo de evento. Para uma ação de clique, essa propriedade é sempre `click`. Valores possíveis: `click`	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.CodeInterpreterContainerAuto

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

Nome	Tipo	Description	Obrigatório
identificadores_de_arquivos	matriz de strings	Uma lista opcional de arquivos carregados a serem disponibilizados para seu código.	No
limite de memória	OpenAI.ContainerMemoryLimit (anulável)		No
tipo	enumeração	Sempre `auto`. Valores possíveis: `auto`	Yes

OpenAI.CodeInterpreterOutputImage

A saída da imagem do interpretador de código.

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	O tipo da saída. Sempre `image`. Valores possíveis: `image`	Yes
url	cadeia	A URL da saída da imagem do interpretador de código.	Yes

OpenAI.CodeInterpreterOutputLogs

A saída de logs do interpretador de código.

Nome	Tipo	Description	Obrigatório	Default
logs	cadeia	A saída de logs do interpretador de código.	Yes
tipo	enumeração	O tipo da saída. Sempre `logs`. Valores possíveis: `logs`	Yes

OpenAI.CodeInterpreterTool

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

Nome	Tipo	Description	Obrigatório	Default
contêiner	string ou OpenAI.CodeInterpreterContainerAuto	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.CompactResource

Nome	Tipo	Description	Obrigatório
criado_em	inteiro	Unix timestamp (em segundos) quando a conversa compactada foi criada.	Yes
id	cadeia	O identificador exclusivo para a resposta compactada.	Yes
objeto	enumeração	O tipo de objeto. Sempre `response.compaction`. Valores possíveis: `response.compaction`	Yes
saída	matriz de OpenAI.OutputItem	A lista compactada de itens de saída. Esta é uma lista de todas as mensagens de usuário, seguida por um único item de compactação.	Yes
uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Yes
└─ tokens de entrada	OpenAI.integer	O número de tokens de entrada.	Yes
└─ detalhes_de_tokens_de_entrada	OpenAI.ResponseUsageInputTokensDetails	Um detalhamento detalhado dos tokens de entrada.	Yes
└─ tokens_de_saída	OpenAI.integer	O número de tokens de saída.	Yes
└─ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Um detalhamento detalhado dos tokens de saída.	Yes
└─ tokens_totais	OpenAI.integer	O número total de tokens usados.	Yes

OpenAI.CompactResponseMethodPublicBody

Nome	Tipo	Description	Obrigatório
entrada	cadeia de caracteres ou matriz de OpenAI.InputItem		No
instructions	cadeia de caracteres (anulável)		No
modelo	OpenAI.ModelIdsCompaction	ID do modelo usada para gerar a resposta, como `gpt-5` ou `o3`. O OpenAI oferece uma ampla gama de modelos com diferentes funcionalidades, características de desempenho e pontos de preço. Consulte o guia do modelo para procurar e comparar os modelos disponíveis.	Yes
previous_response_id	cadeia de caracteres (anulável)		No

OpenAI.FiltroComparativo

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

Nome	Tipo	Description	Obrigatório
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
value	string ou OpenAI.numeric ou booleano ou matriz de OpenAI.ComparisonFilterValueItems	O valor a ser comparado com a chave de atributo; dá suporte a tipos de cadeia de caracteres, número ou booliano.	Yes

OpenAI.ComparisonFilterValueItems

Tipo: string ou OpenAI.numeric

OpenAI.CompoundFilter

Combinar vários filtros usando and ou or.

Nome	Tipo	Description	Obrigatório	Default
Filtros	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.ComputerAction

Discriminador para OpenAI.ComputerAction

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

Digite um valor	Schema
`click`	OpenAI.ClickParam
`double_click`	OpenAI.DoubleClickAction
`drag`	OpenAI.Drag
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.Move
`screenshot`	OpenAI.Screenshot
`scroll`	OpenAI.Scroll
`type`	OpenAI.Type
`wait`	OpenAI.Wait

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ComputerActionType		Yes

OpenAI.ComputerActionType

Property	Valor
Type	cadeia
Valores	`click` `double_click` `drag` `keypress` `move` `screenshot` `scroll` `type` `wait`

OpenAI.ComputerCallSafetyCheckParam

Uma verificação de segurança pendente para a chamada de computador.

Nome	Tipo	Description	Obrigatório
codificar	cadeia de caracteres (anulável)		No
id	cadeia	A ID da verificação de segurança pendente.	Yes
mensagem	cadeia de caracteres (anulável)		No

OpenAI.ComputerEnvironment

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

OpenAI.ComputerScreenshotContent

Uma captura de tela de um computador.

Nome	Tipo	Description	Obrigatório
file_id	cadeia de caracteres (anulável)		Yes
image_url	cadeia		Yes
tipo	enumeração	Especifica o tipo de evento. Para uma captura de tela do computador, essa propriedade é sempre definida como `computer_screenshot`. Valores possíveis: `computer_screenshot`	Yes

OpenAI.ComputerScreenshotImage

Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.

Nome	Tipo	Description	Obrigatório
file_id	cadeia	O identificador de um arquivo carregado que contém a captura de tela.	No
image_url	cadeia	A URL da imagem de captura de tela.	No
tipo	enumeração	Especifica o tipo de evento. Para uma captura de tela do computador, essa propriedade é sempre definido como `computer_screenshot`. Valores possíveis: `computer_screenshot`	Yes

OpenAI.ComputerUsePreviewTool

Uma ferramenta que controla um computador virtual.

Nome	Tipo	Description	Obrigatório
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

OpenAI.ContainerFileCitationBody

Uma citação para um arquivo de contêiner usado para gerar uma resposta de modelo.

Nome	Tipo	Description	Obrigatório
container_id	cadeia	A ID do arquivo de contêiner.	Yes
end_index	OpenAI.integer		Yes
file_id	cadeia	A ID do arquivo.	Yes
filename	cadeia	O nome do arquivo de contêiner citado.	Yes
start_index	OpenAI.integer		Yes
tipo	enumeração	O tipo da citação de arquivo de contêiner. Sempre `container_file_citation`. Valores possíveis: `container_file_citation`	Yes

OpenAI.ContainerMemoryLimit

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

OpenAI.ConversationItem

Um único item dentro de uma conversa. O conjunto de tipos possíveis é o mesmo que o output tipo de um objeto Response.

Discriminador para OpenAI.ConversationItem

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

Digite um valor	Schema
`message`	OpenAI.ConversationItemMessage
`function_call`	OpenAI.ConversationItemFunctionToolCallResource
`function_call_output`	OpenAI.ConversationItemFunctionToolCallOutputResource
`file_search_call`	OpenAI.ConversationItemFileSearchToolCall
`web_search_call`	OpenAI.ConversationItemWebSearchToolCall
`image_generation_call`	OpenAI.ConversationItemImageGenToolCall
`computer_call`	OpenAI.ConversationItemComputerToolCall
`computer_call_output`	OpenAI.ConversationItemComputerToolCallOutputResource
`reasoning`	OpenAI.ConversationItemReasoningItem
`code_interpreter_call`	OpenAI.ConversationItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.ConversationItemLocalShellToolCall
`local_shell_call_output`	OpenAI.ConversationItemLocalShellToolCallOutput
`shell_call`	OpenAI.ConversationItemFunctionShellCall
`shell_call_output`	OpenAI.ConversationItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.ConversationItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ConversationItemApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ConversationItemMcpListTools
`mcp_approval_request`	OpenAI.ConversationItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.ConversationItemMcpApprovalResponseResource
`mcp_call`	OpenAI.ConversationItemMcpToolCall
`custom_tool_call`	OpenAI.ConversationItemCustomToolCall
`custom_tool_call_output`	OpenAI.ConversationItemCustomToolCallOutput

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ConversationItemType		Yes

OpenAI.ConversationItemApplyPatchToolCall

Uma chamada de ferramenta que aplica diferenças de arquivo criando, excluindo ou atualizando arquivos.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch gerada pelo modelo.	Yes
created_by	cadeia	A ID da entidade que criou essa chamada de ferramenta.	No
id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch. Populado quando esse item é retornado por meio da API.	Yes
operação	OpenAI.ApplyPatchFileOperation	Uma das operações de create_file, delete_file ou update_file aplicadas por meio de apply_patch.	Yes
└─ tipo	OpenAI.ApplyPatchFileOperationType		Yes
status	OpenAI.ApplyPatchCallStatus		Yes
tipo	enumeração	O tipo do item. Sempre `apply_patch_call`. Valores possíveis: `apply_patch_call`	Yes

OpenAI.ConversationItemApplyPatchToolCallOutput

A saída emitida por uma chamada de ferramenta aplicar patch.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch gerada pelo modelo.	Yes
created_by	cadeia	A ID da entidade que criou essa saída de chamada de ferramenta.	No
id	cadeia	A ID exclusiva da saída de chamada da ferramenta aplicar patch. Populado quando esse item é retornado por meio da API.	Yes
saída	cadeia de caracteres (anulável)		No
status	OpenAI.ApplyPatchCallOutputStatus		Yes
tipo	enumeração	O tipo do item. Sempre `apply_patch_call_output`. Valores possíveis: `apply_patch_call_output`	Yes

OpenAI.ConversationItemCodeInterpreterToolCall

Uma chamada de ferramenta para executar o código.

Nome	Tipo	Description	Obrigatório
codificar	cadeia de caracteres (anulável)		Yes
container_id	cadeia	A ID do contêiner usado para executar o código.	Yes
id	cadeia	A ID exclusiva da chamada da ferramenta de intérprete de código.	Yes
outputs	matriz de OpenAI.CodeInterpreterOutputLogs ou OpenAI.CodeInterpreterOutputImage		Yes
status	enumeração	O status da chamada da ferramenta de intérprete de código. Os valores válidos são `in_progress`, , `completed`, `incomplete`, `interpreting`e `failed`. Valores possíveis: `in_progress`, , `completed`, `incomplete`, `interpreting`, `failed`	Yes
tipo	enumeração	O tipo da chamada da ferramenta de intérprete de código. Sempre `code_interpreter_call`. Valores possíveis: `code_interpreter_call`	Yes

OpenAI.ConversationItemComputerToolCall

Uma chamada de ferramenta para uma ferramenta de uso de computador. Consulte o guia de uso do computador para obter mais informações.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.ComputerAction		Yes
call_id	cadeia	Um identificador usado ao responder à chamada de ferramenta com saída.	Yes
id	cadeia	O identificador único da chamada do computador.	Yes
pending_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam	As verificações de segurança pendentes para a chamada de computador.	Yes
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	O tipo da chamada de computador. Sempre `computer_call`. Valores possíveis: `computer_call`	Yes

OpenAI.ConversationItemComputerToolCallOutputResource

Nome	Tipo	Description	Obrigatório
acknowledged_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam	As verificações de segurança relatadas pela API que foram confirmadas pela desenvolvedor.	No
call_id	cadeia	A ID da chamada da ferramenta de computador que produziu a saída.	Yes
id	cadeia	A ID da saída da chamada da ferramenta de computador.	No
saída	OpenAI.ComputerScreenshotImage	Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.	Yes
status	enumeração	O status da entrada da mensagem. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens de entrada são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da saída de chamada da ferramenta de computador. Sempre `computer_call_output`. Valores possíveis: `computer_call_output`	Yes

OpenAI.ConversationItemCustomToolCall

Uma chamada para uma ferramenta personalizada criada pelo modelo.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	Um identificador usado para mapear essa chamada de ferramenta personalizada para uma saída de chamada de ferramenta.	Yes
id	cadeia	A ID exclusiva da chamada de ferramenta personalizada na plataforma OpenAI.	No
entrada	cadeia	A entrada para a chamada de ferramenta personalizada gerada pelo modelo.	Yes
nome	cadeia	O nome da ferramenta personalizada que está sendo chamada.	Yes
tipo	enumeração	O tipo da chamada de ferramenta personalizada. Sempre `custom_tool_call`. Valores possíveis: `custom_tool_call`	Yes

OpenAI.ConversationItemCustomToolCallOutput

A saída de uma chamada de ferramenta personalizada do código, sendo enviada de volta para o modelo.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID da chamada, usada para mapear essa saída de chamada de ferramenta personalizada para uma chamada de ferramenta personalizada.	Yes
id	cadeia	A ID exclusiva da saída de chamada de ferramenta personalizada na plataforma OpenAI.	No
saída	cadeia de caracteres ou matriz de OpenAI.FunctionAndCustomToolCallOutput	A saída da chamada de ferramenta personalizada gerada pelo seu código. Pode ser uma cadeia de caracteres ou uma lista de conteúdo de saída.	Yes
tipo	enumeração	O tipo da saída da chamada de ferramenta personalizada. Sempre `custom_tool_call_output`. Valores possíveis: `custom_tool_call_output`	Yes

OpenAI.ConversationItemFileSearchToolCall

Os resultados de uma chamada de ferramenta de pesquisa de arquivo. Consulte o guia de pesquisa de arquivos para obter mais informações.

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada da ferramenta de pesquisa de arquivos.	Yes
Consultas	matriz de strings	As consultas usadas para pesquisar arquivos.	Yes
results	matriz de OpenAI.FileSearchToolCallResults		No
status	enumeração	O status da chamada da ferramenta de pesquisa de arquivos. Uma opção entre `in_progress`, `searching`, `incomplete` ou `failed`, Valores possíveis: `in_progress`, , `searching`, `completed`, `incomplete`, `failed`	Yes
tipo	enumeração	O tipo da chamada da ferramenta de pesquisa de arquivo. Sempre `file_search_call`. Valores possíveis: `file_search_call`	Yes

OpenAI.ConversationItemFunctionShellCall

Uma chamada de ferramenta que executa um ou mais comandos de shell em um ambiente gerenciado.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.FunctionShellAction	Execute um comando de shell.	Yes
Comandos └─	matriz de strings		Yes
└─ max_output_length	OpenAI.integer (anulável)		Yes
└─ timeout_ms	OpenAI.integer (anulável)		Yes
call_id	cadeia	A ID exclusiva da chamada de ferramenta de shell gerada pelo modelo.	Yes
created_by	cadeia	A ID da entidade que criou essa chamada de ferramenta.	No
id	cadeia	A ID exclusiva da chamada da ferramenta shell. Populado quando esse item é retornado por meio da API.	Yes
status	OpenAI.LocalShellCallStatus		Yes
tipo	enumeração	O tipo do item. Sempre `shell_call`. Valores possíveis: `shell_call`	Yes

OpenAI.ConversationItemFunctionShellCallOutput

A saída de uma chamada de ferramenta de shell que foi emitida.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada de ferramenta de shell gerada pelo modelo.	Yes
created_by	cadeia	O identificador do ator que criou o item.	No
id	cadeia	A ID exclusiva da saída de chamada do shell. Populado quando esse item é retornado por meio da API.	Yes
max_output_length	OpenAI.integer (anulável)		Yes
saída	matriz de OpenAI.FunctionShellCallOutputContent	Uma matriz de conteúdo de saída de chamada de shell	Yes
tipo	enumeração	O tipo da saída da chamada de shell. Sempre `shell_call_output`. Valores possíveis: `shell_call_output`	Yes

OpenAI.ConversationItemFunctionToolCallOutputResource

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Yes
id	cadeia	A ID exclusiva da saída da chamada da ferramenta de função. Populado quando este item é retornado por meio da API.	No
saída	cadeia de caracteres ou matriz de OpenAI.FunctionAndCustomToolCallOutput	A saída da chamada de função gerada pelo código. Pode ser uma cadeia de caracteres ou uma lista de conteúdo de saída.	Yes
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da saída de chamada da ferramenta de função. Sempre `function_call_output`. Valores possíveis: `function_call_output`	Yes

OpenAI.ConversationItemFunctionToolCallResource

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos a serem passados para a função.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Yes
id	cadeia	A ID exclusiva da chamada da ferramenta de função.	No
nome	cadeia	O nome da função a ser executada.	Yes
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da chamada da ferramenta de função. Sempre `function_call`. Valores possíveis: `function_call`	Yes

OpenAI.ConversationItemImageGenToolCall

Uma solicitação de geração de imagem feita pelo modelo.

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada de geração de imagem.	Yes
Resultado	cadeia de caracteres (anulável)		Yes
status	enumeração	O status da chamada de geração de imagem. Valores possíveis: `in_progress`, , `completed`, `generatingfailed`	Yes
tipo	enumeração	O tipo da chamada de geração de imagem. Sempre `image_generation_call`. Valores possíveis: `image_generation_call`	Yes

OpenAI.ConversationItemList

Uma lista de itens de conversa.

Nome	Tipo	Description	Obrigatório
dados	matriz de OpenAI.ConversationItem	Uma lista de itens de conversa.	Yes
first_id	cadeia	A ID do primeiro item da lista.	Yes
has_more	boolean	Se há mais itens disponíveis.	Yes
last_id	cadeia	A ID do último item da lista.	Yes
objeto	enumeração	O tipo de objeto retornado deve ser `list`. Valores possíveis: `list`	Yes

OpenAI.ConversationItemLocalShellToolCall

Uma chamada de ferramenta para executar um comando no shell local.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.LocalShellExecAction	Execute um comando shell no servidor.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Yes
id	cadeia	A ID exclusiva da chamada de shell local.	Yes
status	enumeração	O status da chamada de shell local. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	O tipo da chamada de shell local. Sempre `local_shell_call`. Valores possíveis: `local_shell_call`	Yes

OpenAI.ConversationItemLocalShellToolCallOutput

A saída de uma chamada de ferramenta de shell local.

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Yes
saída	cadeia	Uma cadeia de caracteres JSON da saída da chamada da ferramenta de shell local.	Yes
status	enumeração	Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da saída da chamada da ferramenta de shell local. Sempre `local_shell_call_output`. Valores possíveis: `local_shell_call_output`	Yes

OpenAI.ConversationItemMcpApprovalRequest

Uma solicitação de aprovação humana de uma invocação de ferramenta.

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma string JSON de argumentos para a ferramenta.	Yes
id	cadeia	A ID exclusiva da solicitação de aprovação.	Yes
nome	cadeia	O nome da ferramenta a ser executada.	Yes
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que está fazendo a solicitação.	Yes
tipo	enumeração	O tipo do item. Sempre `mcp_approval_request`. Valores possíveis: `mcp_approval_request`	Yes

OpenAI.ConversationItemMcpApprovalResponseResource

Uma resposta a uma solicitação de aprovação do MCP.

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia	A ID da solicitação de aprovação que está sendo respondida.	Yes
aprovar	boolean	Se a solicitação foi aprovada.	Yes
id	cadeia	A ID exclusiva da resposta de aprovação	Yes
reason	cadeia de caracteres (anulável)		No
tipo	enumeração	O tipo do item. Sempre `mcp_approval_response`. Valores possíveis: `mcp_approval_response`	Yes

OpenAI.ConversationItemMcpListTools

Uma lista de ferramentas disponíveis em um servidor MCP.

Nome	Tipo	Description	Obrigatório
erro	cadeia de caracteres (anulável)		No
id	cadeia	A ID exclusiva da lista.	Yes
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP.	Yes
tools	matriz de OpenAI.MCPListToolsTool	As ferramentas disponíveis no servidor.	Yes
tipo	enumeração	O tipo do item. Sempre `mcp_list_tools`. Valores possíveis: `mcp_list_tools`	Yes

OpenAI.ConversationItemMcpToolCall

Uma invocação de uma ferramenta em um servidor MCP.

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia de caracteres (anulável)		No
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta.	Yes
erro	cadeia de caracteres (anulável)		No
id	cadeia	A ID exclusiva da chamada de ferramenta.	Yes
nome	cadeia	O nome da ferramenta que foi executada.	Yes
saída	cadeia de caracteres (anulável)		No
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que executa a ferramenta.	Yes
status	OpenAI.MCPToolCallStatus		No
tipo	enumeração	O tipo do item. Sempre `mcp_call`. Valores possíveis: `mcp_call`	Yes

OpenAI.ConversationItemMessage

Uma mensagem de ou para o modelo.

Nome	Tipo	Description	Obrigatório
conteúdo	matriz de OpenAI.MessageContent	O conteúdo da mensagem	Yes
id	cadeia	A ID exclusiva da mensagem.	Yes
função	OpenAI.MessageRole		Yes
status	OpenAI.MessageStatus		Yes
tipo	enumeração	O tipo da mensagem. Sempre defina como `message`. Valores possíveis: `message`	Yes

OpenAI.ConversationItemReasoningItem

Uma descrição da cadeia de pensamento usada por um modelo de raciocínio ao gerar uma resposta. Certifique-se de incluir esses itens na input API de Respostas para as próximas rodadas de uma conversa se você estiver gerenciando manualmente o contexto.

Nome	Tipo	Description	Obrigatório
conteúdo	matriz de OpenAI.ReasoningTextContent	Conteúdo de texto de raciocínio.	No
encrypted_content	cadeia de caracteres (anulável)		No
id	cadeia	O identificador exclusivo do conteúdo de raciocínio.	Yes
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
resumo	matriz de OpenAI.Summary	Conteúdo de resumo de raciocínio.	Yes
tipo	enumeração	O tipo do objeto. Sempre `reasoning`. Valores possíveis: `reasoning`	Yes

OpenAI.ConversationItemType

Property Valor

Type cadeia

Valores message
function_call
function_call_output
file_search_call
web_search_call
image_generation_call
computer_call
computer_call_output
reasoning
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
custom_tool_call
custom_tool_call_output

OpenAI.ConversationItemWebSearchToolCall

Os resultados de uma chamada de ferramenta de pesquisa na Web. Consulte o guia de pesquisa na Web para obter mais informações.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.WebSearchActionSearch ou OpenAI.WebSearchActionOpenPage ou OpenAI.WebSearchActionFind	Um objeto que descreve a ação específica executada nesta chamada de pesquisa na Web. Inclui detalhes sobre como o modelo usou a Web (pesquisa, open_page, localizar).	Yes
id	cadeia	A ID exclusiva da chamada da ferramenta de pesquisa na Web.	Yes
status	enumeração	O status da chamada da ferramenta de pesquisa na Web. Valores possíveis: `in_progress`, , `searching`, `completedfailed`	Yes
tipo	enumeração	O tipo da chamada da ferramenta de pesquisa na Web. Sempre `web_search_call`. Valores possíveis: `web_search_call`	Yes

OpenAI.ConversationParam

A conversa à qual essa resposta pertence. Os itens dessa conversa são anexados a input_items essa solicitação de resposta. Itens de entrada e itens de saída dessa resposta são adicionados automaticamente a essa conversa após a conclusão dessa resposta.

Tipo: cadeia de caracteres ou OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

A conversa à qual essa resposta pertence.

Nome	Tipo	Description	Obrigatório	Default
id	cadeia	A ID exclusiva da conversa.	Yes

OpenAI.ConversationReference

A conversa à qual essa resposta pertencia. Itens de entrada e itens de saída dessa resposta foram adicionados automaticamente a essa conversa.

Nome	Tipo	Description	Obrigatório	Default
id	cadeia	A ID exclusiva da conversa à qual essa resposta foi associada.	Yes

OpenAI.ConversationResource

Nome	Tipo	Description	Obrigatório
criado_em	inteiro	A hora em que a conversa foi criada, medida em segundos desde a época do Unix.	Yes
id	cadeia	A ID exclusiva da conversa.	Yes
metadados	OpenAI.Metadata	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
objeto	enumeração	O tipo de objeto, que é sempre `conversation`. Valores possíveis: `conversation`	Yes

OpenAI.CreateChatCompletionRequestResponseFormat

Um objeto que especifica o formato que o modelo deve gerar. A configuração para { "type": "json_schema", "json_schema": {...} } habilitar saídas estruturadas que garantem que o modelo corresponda ao esquema JSON fornecido. Saiba mais no guia Saídas Estruturadas. A configuração para { "type": "json_object" } habilita o modo JSON antigo, garantindo que a mensagem gerada pelo modelo seja JSON válido. O uso json_schema é preferencial para modelos que dão suporte a ele.

Discriminador para OpenAI.CreateChatCompletionRequestResponseFormat

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

Digite um valor	Schema
`text`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
`json_object`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.CreateChatCompletionRequestResponseFormatType		Yes

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

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.

Nome	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.CreateChatCompletionRequestResponseFormatResponseFormatText

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

Nome	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.CreateChatCompletionRequestResponseFormatType

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

OpenAI.CreateConversationBody

Nome	Tipo	Description	Obrigatório	Default
items	matriz de OpenAI.InputItem		No
metadados	OpenAI.Metadata (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.	No

OpenAI.CreateEvalCompletionsRunDataSource

Um objeto CompletionsRunDataSource que descreve uma configuração de amostragem de modelo.

Nome	Tipo	Description	Obrigatório
mensagens_de_entrada	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate ou OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	Usado durante a amostragem de um modelo. Determina a estrutura das mensagens passadas para o modelo. Pode ser uma referência a uma trajetória predefinida (ou seja, `item.input_trajectory`) ou a um modelo com referências variáveis ao `item` namespace.	No
modelo	cadeia	O nome do modelo a ser usado para gerar conclusões (por exemplo, "o3-mini").	No
sampling_params	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		No
fonte	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource ou OpenAI.EvalStoredCompletionsSource	Determina o que preenche o `item` namespace na fonte de dados dessa execução.	Yes
tipo	enumeração	O tipo de fonte de dados de execução. Sempre `completions`. Valores possíveis: `completions`	Yes

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

Nome	Tipo	Description	Obrigatório	Default
item_reference	cadeia		Yes
tipo	enumeração	Valores possíveis: `item_reference`	Yes

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Nome	Tipo	Description	Obrigatório	Default
modelo	matriz de OpenAI.EasyInputMessage ou OpenAI.EvalItem		Yes
tipo	enumeração	Valores possíveis: `template`	Yes

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Nome	Tipo	Description	Obrigatório	Default
max_completion_tokens	OpenAI.integer		No
esforço de raciocínio	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
formato_de_resposta	OpenAI.ResponseFormatText ou OpenAI.ResponseFormatJsonSchema ou OpenAI.ResponseFormatJsonObject		No
seed	OpenAI.integer		No	42
Temperatura	OpenAI.numeric		No	1
tools	matriz de OpenAI.ChatCompletionTool		No
top_p	OpenAI.numeric		No	1

OpenAI.CreateEvalCustomDataSourceConfig

Um objeto CustomDataSourceConfig que define o esquema da fonte de dados usada para as execuções de avaliação. Esse esquema é usado para definir a forma dos dados que serão:

Usado para definir seus critérios de teste e
Quais dados são necessários ao criar uma execução

Nome	Tipo	Description	Obrigatório
incluir_esquema_exemplo	boolean	Se a avaliação deve esperar que você preencha o namespace de exemplo (ou seja, gerando respostas a partir da sua fonte de dados)	No
esquema_de_item	objeto	O esquema json para cada linha na fonte de dados.	Yes
tipo	enumeração	O tipo de fonte de dados. Sempre `custom`. Valores possíveis: `custom`	Yes

OpenAI.CreateEvalJsonlRunDataSource

Um objeto JsonlRunDataSource com o qual especifica um arquivo JSONL que corresponde à avaliação

Nome	Tipo	Description	Obrigatório	Default
fonte	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource	Determina o que preenche o `item` namespace na fonte de dados.	Yes
tipo	enumeração	O tipo de fonte de dados. Sempre `jsonl`. Valores possíveis: `jsonl`	Yes

OpenAI.CreateEvalLogsDataSourceConfig

Uma configuração de fonte de dados que especifica a propriedade de metadados da consulta de logs. Geralmente, são metadados como usecase=chatbot ou prompt-version=v2etc.

Nome	Tipo	Description	Obrigatório	Default
metadados	objeto	Filtros de metadados para a fonte de dados de logs.	No
tipo	enumeração	O tipo de fonte de dados. Sempre `logs`. Valores possíveis: `logs`	Yes

OpenAI.CreateEvalResponsesRunDataSource

Um objeto ResponsesRunDataSource que descreve uma configuração de amostragem de modelo.

Nome	Tipo	Description	Obrigatório
mensagens_de_entrada	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate ou OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Usado durante a amostragem de um modelo. Determina a estrutura das mensagens passadas para o modelo. Pode ser uma referência a uma trajetória predefinida (ou seja, `item.input_trajectory`) ou a um modelo com referências variáveis ao `item` namespace.	No
modelo	cadeia	O nome do modelo a ser usado para gerar conclusões (por exemplo, "o3-mini").	No
sampling_params	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		No
fonte	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource ou OpenAI.EvalResponsesSource	Determina o que preenche o `item` namespace na fonte de dados dessa execução.	Yes
tipo	enumeração	O tipo de fonte de dados de execução. Sempre `responses`. Valores possíveis: `responses`	Yes

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

Nome	Tipo	Description	Obrigatório	Default
item_reference	cadeia		Yes
tipo	enumeração	Valores possíveis: `item_reference`	Yes

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Nome	Tipo	Description	Obrigatório	Default
modelo	matriz de objeto ou OpenAI.EvalItem		Yes
tipo	enumeração	Valores possíveis: `template`	Yes

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Nome	Tipo	Description	Obrigatório	Default
max_completion_tokens	OpenAI.integer		No
esforço de raciocínio	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
seed	OpenAI.integer		No	42
Temperatura	OpenAI.numeric		No	1
enviar SMS	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		No
tools	matriz de OpenAI.Tool		No
top_p	OpenAI.numeric		No	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

Nome	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

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

Preterido em favor de LogsDataSourceConfig.

Nome	Tipo	Description	Obrigatório	Default
metadados	objeto	Filtros de metadados para a fonte de dados de conclusões armazenadas.	No
tipo	enumeração	O tipo de fonte de dados. Sempre `stored_completions`. Valores possíveis: `stored_completions`	Yes

OpenAI.CreateFineTuningJobRequest

Modelos válidos:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

Nome	Tipo	Description	Obrigatório	Default
hiperparâmetros	OpenAI.CreateFineTuningJobRequestHyperparameters		No
└─ tamanho_do_lote (batch_size)	string ou OpenAI.integer		No	automático
└─ multiplicador_da_taxa_de_aprendizagem	string ou OpenAI.numeric		No
└─ n_epochs	string ou OpenAI.integer		No	automático
Integrações	matriz de OpenAI.CreateFineTuningJobRequestIntegrations	Uma lista de integrações para habilitar seu trabalho de ajuste fino.	No
metadados	OpenAI.Metadata (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.	No
método	OpenAI.FineTuneMethod	O método usado para ajuste fino.	No
modelo	cadeia de caracteres (veja os modelos válidos abaixo)	O nome do modelo a ser afinado. Você pode selecionar um dos c0.	Yes
seed	OpenAI.integer (anulável)		No
Sufixo	cadeia de caracteres (anulável)	Uma cadeia de caracteres de até 64 caracteres que será adicionada ao seu nome de modelo ajustado. Por exemplo, um `suffix` "custom-model-name" produziria um nome de modelo como `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`. Restrições: minLength: 1, maxLength: 64	No
arquivo_de_treinamento	cadeia	A ID de um arquivo carregado que contém dados de treinamento. Consulte o arquivo de upload para saber como carregar um arquivo. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Além disso, você deve carregar seu arquivo com a finalidade `fine-tune`. O conteúdo do arquivo deve ser diferente dependendo se o modelo usar o chat, o formato de conclusão ou se o método de ajuste fino usar o formato de preferência . Veja o guia de ajuste fino para mais detalhes.	Yes
arquivo_de_validação	cadeia de caracteres (anulável)	A ID de um arquivo carregado que contém dados de validação. Se você fornecer esse arquivo, os dados serão usados para gerar validação métricas periodicamente durante o ajuste fino. Essas métricas podem ser exibidas em o arquivo de resultados de ajuste fino. Os mesmos dados não devem estar presentes nos arquivos de treinamento e validação. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Você deve carregar seu arquivo com a finalidade `fine-tune`. Veja o guia de ajuste fino para mais detalhes.	No

OpenAI.CreateFineTuningJobRequestHyperparameters

Nome	Tipo	Obrigatório
tamanho_do_lote	string ou OpenAI.integer	No
multiplicador_da_taxa_de_aprendizado	string ou OpenAI.numeric	No
n_épocas	string ou OpenAI.integer	No

OpenAI.CreateFineTuningJobRequestIntegrations

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	Valores possíveis: `wandb`	Yes
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		Yes

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

Nome	Tipo	Obrigatório
entidade	cadeia de caracteres (anulável)	No
nome	cadeia de caracteres (anulável)	No
projeto	cadeia	Yes
tags	matriz de strings	No

OpenAI.CreateResponseStreamingResponse

OpenAI.CustomGrammarFormatParam

Uma gramática definida pelo usuário.

Nome	Tipo	Description	Obrigatório
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

OpenAI.CustomTextFormatParam

Texto sem restrições de forma livre.

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

OpenAI.CustomToolParam

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

Nome	Tipo	Description	Obrigatório
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
nome	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

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:

Digite um valor	Schema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

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

OpenAI.CustomToolParamFormatType

Property	Valor
Type	cadeia
Valores	`text` `grammar`

OpenAI.DeletedConversationResource

Nome	Tipo	Description	Obrigatório
excluído	boolean		Yes
id	cadeia		Yes
objeto	enumeração	Valores possíveis: `conversation.deleted`	Yes

OpenAI.DetailEnum

Property	Valor
Type	cadeia
Valores	`low` `high` `auto`

OpenAI.DoubleClickAction

Uma ação de clique duplo.

Nome	Tipo	Description	Obrigatório
tipo	enumeração	Especifica o tipo de evento. Para uma ação de clique duplo, essa propriedade é sempre definida como `double_click`. Valores possíveis: `double_click`	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.Drag

Uma ação de arrastar.

Nome	Tipo	Description	Obrigatório	Default
caminho	matriz de OpenAI.DragPoint	Uma matriz de coordenadas que representa o caminho da ação de arrastar. As coordenadas serão exibidas como uma matriz de objetos, por exemplo `<br> [<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br> ]<br>`	Yes
tipo	enumeração	Especifica o tipo de evento. Para uma ação de arrastar, essa propriedade é sempre definido como `drag`. Valores possíveis: `drag`	Yes

OpenAI.DragPoint

Um par de coordenadas x/y, por exemplo. { x: 100, y: 200 }.

Nome	Tipo	Description	Obrigatório	Default
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.EasyInputMessage

Uma mensagem de entrada para o modelo com uma função que indica a hierarquia de instruções a seguir. As instruções fornecidas com a função developer ou system têm precedência sobre as instruções fornecidas com a função user. Presume-se que as mensagens com a assistant função tenham sido geradas pelo modelo em interações anteriores.

Nome	Tipo	Description	Obrigatório
conteúdo	string ou OpenAI.InputMessageContentList	Entrada de texto, imagem ou áudio para o modelo, usada para gerar uma resposta. Também pode conter respostas anteriores do assistente.	Yes
função	enumeração	A função da entrada de mensagem. Um de `user`, `assistant`, `system` ou `developer`. Valores possíveis: `user`, , `assistant`, `systemdeveloper`	Yes
status	enumeração	O status do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo de entrada da mensagem. Sempre `message`. Valores possíveis: `message`	Yes

OpenAI.Error

Nome	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.EvalApiError

Um objeto que representa uma resposta de erro da API de Eval.

Nome	Tipo	Description	Obrigatório	Default
codificar	cadeia	O código de erro.	Yes
mensagem	cadeia	A mensagem de erro.	Yes

OpenAI.EvalGraderLabelModel

Nome	Tipo	Description	Obrigatório
entrada	matriz de OpenAI.EvalItem		Yes
labels	matriz de strings	Os rótulos a serem atribuídos a cada item na avaliação.	Yes
modelo	cadeia	O modelo a ser usado para a avaliação. Deve dar suporte a saídas estruturadas.	Yes
nome	cadeia	O nome do avaliador.	Yes
etiquetas_de_passagem	matriz de strings	Os rótulos que indicam um resultado aprovado. Deve ser um subconjunto de rótulos.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `label_model`. Valores possíveis: `label_model`	Yes

OpenAI.EvalGraderPython

Nome	Tipo	Description	Obrigatório
image_tag	cadeia	A marca de imagem a ser usada para o script python.	No
nome	cadeia	O nome do avaliador.	Yes
limite_de_passagem	OpenAI.numeric		No
fonte	cadeia	O código-fonte do script python.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `python`. Valores possíveis: `python`	Yes

OpenAI.EvalGraderScoreModel

Nome	Tipo	Description	Obrigatório	Default
entrada	matriz de OpenAI.EvalItem	As mensagens de entrada avaliadas pelo classificador. Dá suporte a blocos de conteúdo de áudio de entrada, texto de saída, texto de saída e texto de entrada e pode incluir cadeias de caracteres de modelo.	Yes
modelo	cadeia	O modelo a ser usado para a avaliação.	Yes
nome	cadeia	O nome do avaliador.	Yes
limite_de_passagem	OpenAI.numeric		No
alcance	matriz de OpenAI.numeric	O intervalo da pontuação. Usa `[0, 1]` como padrão.	No
sampling_params	OpenAI.EvalGraderScoreModelSamplingParams		No
└─ max_completions_tokens	OpenAI.integer (anulável)		No
└─ esforço_de_raciocínio	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
└─ semente	OpenAI.integer (anulável)		No
└─ temperatura	OpenAI.numeric (anulável )		No
└─ top_p	OpenAI.numeric (anulável )		No	1
tipo	enumeração	O tipo de objeto, que é sempre `score_model`. Valores possíveis: `score_model`	Yes

OpenAI.EvalGraderScoreModelSamplingParams

Nome	Tipo	Description	Obrigatório	Default
max_completions_tokens	OpenAI.integer (anulável)		No
esforço de raciocínio	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
seed	OpenAI.integer (anulável)		No
Temperatura	OpenAI.numeric (anulável )		No
top_p	OpenAI.numeric (anulável )		No	1

OpenAI.EvalGraderStringCheck

Nome	Tipo	Description	Obrigatório
entrada	cadeia	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Yes
nome	cadeia	O nome do avaliador.	Yes
operação	enumeração	A operação de verificação de cadeia de caracteres a ser executada. Um de `eq`, `ne`, `like`ou `ilike`. Valores possíveis: `eq`, , `ne`, `likeilike`	Yes
referência	cadeia	O texto de referência. Isso pode incluir cadeias de caracteres de modelo.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `string_check`. Valores possíveis: `string_check`	Yes

OpenAI.EvalGraderTextSimilarity

Nome	Tipo	Description	Obrigatório
métrica de avaliação	enumeração	A métrica de avaliação a ser usada. Um de `cosine`, `fuzzy_match`, , `bleu` `gleu`, `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, `rouge_4`, , `rouge_5` ou `rouge_l`. Valores possíveis: `cosine`, , `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, , `rouge_2`, `rouge_3`, , `rouge_4`, , `rouge_5rouge_l`	Yes
entrada	cadeia	O texto que está sendo avaliado.	Yes
nome	cadeia	O nome do avaliador.	Yes
limite_de_passagem	OpenAI.numeric		Yes
referência	cadeia	O texto de referência para avaliação.	Yes
tipo	enumeração	O tipo de avaliador. Valores possíveis: `text_similarity`	Yes

OpenAI.EvalItem

Nome	Tipo	Description	Obrigatório
conteúdo	OpenAI.EvalItemContent	Entradas para o modelo – podem conter cadeias de caracteres de modelo. Dá suporte a texto, texto de saída, imagens de entrada e áudio de entrada, seja como um único item ou uma matriz de itens.	Yes
função	enumeração	A função da entrada de mensagem. Um de `user`, `assistant`, `system` ou `developer`. Valores possíveis: `user`, , `assistant`, `systemdeveloper`	Yes
tipo	enumeração	O tipo de entrada da mensagem. Sempre `message`. Valores possíveis: `message`	No

OpenAI.EvalItemContent

Entradas para o modelo – podem conter cadeias de caracteres de modelo. Dá suporte a texto, texto de saída, imagens de entrada e áudio de entrada, seja como um único item ou uma matriz de itens.

Tipo: OpenAI.EvalItemContentItem ou OpenAI.EvalItemContentArray

Entradas para o modelo – podem conter cadeias de caracteres de modelo. Dá suporte a texto, texto de saída, imagens de entrada e áudio de entrada, seja como um único item ou uma matriz de itens.

OpenAI.EvalItemContentArray

Uma lista de entradas, cada uma delas pode ser um texto de entrada, texto de saída, imagem de entrada ou objeto de áudio de entrada.

Matriz de: OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

Um único item de conteúdo: texto de entrada, texto de saída, imagem de entrada ou áudio de entrada.

Tipo: OpenAI.EvalItemContentText ou OpenAI.EvalItemContentItemObject

Um único item de conteúdo: texto de entrada, texto de saída, imagem de entrada ou áudio de entrada.

OpenAI.EvalItemContentItemObject

Um único item de conteúdo: texto de entrada, texto de saída, imagem de entrada ou áudio de entrada.

Discriminador para OpenAI.EvalItemContentItemObject

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

Digite um valor	Schema
`output_text`	OpenAI.EvalItemContentOutputText
`input_image`	OpenAI.EvalItemInputImage
`input_audio`	OpenAI.InputAudio
`input_text`	OpenAI.EvalItemContentItemObjectInputTextContent

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.EvalItemContentItemObjectType		Yes

OpenAI.EvalItemContentItemObjectInputTextContent

Uma entrada de texto para o modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	A entrada de texto para o modelo.	Yes
tipo	enumeração	O tipo do item de entrada. Sempre `input_text`. Valores possíveis: `input_text`	Yes

OpenAI.EvalItemContentItemObjectType

Property	Valor
Type	cadeia
Valores	`input_text` `output_text` `input_image` `input_audio`

OpenAI.EvalItemContentOutputText

Uma saída de texto do modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	A saída de texto do modelo.	Yes
tipo	enumeração	O tipo do texto de saída. Sempre `output_text`. Valores possíveis: `output_text`	Yes

OpenAI.EvalItemContentText

Uma entrada de texto para o modelo.

Tipo: cadeia de caracteres

OpenAI.EvalItemInputImage

Um bloco de entrada de imagem usado em matrizes de conteúdo EvalItem.

Nome	Tipo	Description	Obrigatório
detail	cadeia	O nível de detalhes da imagem a ser enviada para o modelo. Uma opção entre `high`, `low` ou `auto`. Usa `auto` como padrão.	No
image_url	cadeia	A URL da entrada da imagem.	Yes
tipo	enumeração	O tipo de entrada da imagem. Sempre `input_image`. Valores possíveis: `input_image`	Yes

OpenAI.EvalJsonlFileContentSource

Nome	Tipo	Description	Obrigatório	Default
conteúdo	matriz de OpenAI.EvalJsonlFileContentSourceContent	O conteúdo do arquivo jsonl.	Yes
tipo	enumeração	Tipo de fonte jsonl. Sempre `file_content`. Valores possíveis: `file_content`	Yes

OpenAI.EvalJsonlFileContentSourceContent

Nome	Tipo	Description	Obrigatório	Default
item	objeto		Yes
amostra	objeto		No

OpenAI.EvalJsonlFileIdSource

Nome	Tipo	Description	Obrigatório	Default
id	cadeia	O identificador do arquivo.	Yes
tipo	enumeração	Tipo de fonte jsonl. Sempre `file_id`. Valores possíveis: `file_id`	Yes

OpenAI.EvalResponsesSource

Um objeto EvalResponsesSource que descreve uma configuração de fonte de dados de execução.

Nome	Tipo	Description	Obrigatório
created_after	OpenAI.integer (anulável)		No
criado_antes	OpenAI.integer (anulável)		No
instructions_search	cadeia de caracteres (anulável)		No
metadados	objeto (anulável)		No
modelo	cadeia de caracteres (anulável)		No
esforço de raciocínio	OpenAI.ReasoningEffort (anulável)	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
Temperatura	OpenAI.numeric (anulável )		No
tools	matriz de strings		No
top_p	OpenAI.numeric (anulável )		No
tipo	enumeração	O tipo de fonte de dados de execução. Sempre `responses`. Valores possíveis: `responses`	Yes
users	matriz de strings		No

OpenAI.EvalRunOutputItemSample

Nome	Tipo	Description	Obrigatório
erro	OpenAI.EvalApiError	Um objeto que representa uma resposta de erro da API de Eval.	Yes
motivo_de_conclusão	cadeia		Yes
entrada	matriz de EvalRunOutputItemSampleInput		Yes
max_completion_tokens	OpenAI.integer		Yes
modelo	cadeia		Yes
saída	matriz de EvalRunOutputItemSampleOutput		Yes
seed	OpenAI.integer		Yes
Temperatura	OpenAI.numeric		Yes
top_p	OpenAI.numeric		Yes
uso	OpenAI.EvalRunOutputItemSampleUsage		Yes

OpenAI.EvalRunOutputItemSampleUsage

Nome	Tipo	Obrigatório
cached_tokens	OpenAI.integer	Yes
completion_tokens	OpenAI.integer	Yes
prompt_tokens	OpenAI.integer	Yes
total_tokens	OpenAI.integer	Yes

OpenAI.EvalRunPerModelUsage

Nome	Tipo	Obrigatório
cached_tokens	OpenAI.integer	Yes
completion_tokens	OpenAI.integer	Yes
invocation_count	OpenAI.integer	Yes
model_name	cadeia	Yes
prompt_tokens	OpenAI.integer	Yes
total_tokens	OpenAI.integer	Yes

OpenAI.EvalRunPerTestingCriteriaResults

Nome	Tipo	Obrigatório
falha	OpenAI.integer	Yes
Passado	OpenAI.integer	Yes
critérios_de_teste	cadeia	Yes

OpenAI.EvalRunResultCounts

Nome	Tipo	Obrigatório
erro	OpenAI.integer	Yes
falha	OpenAI.integer	Yes
Passado	OpenAI.integer	Yes
Total	OpenAI.integer	Yes

OpenAI.EvalStoredCompletionsSource

Uma configuração StoredCompletionsRunDataSource que descreve um conjunto de filtros

Nome	Tipo	Description	Obrigatório
created_after	OpenAI.integer (anulável)		No
criado_antes	OpenAI.integer (anulável)		No
limit	OpenAI.integer (anulável)		No
metadados	OpenAI.Metadata (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.	No
modelo	cadeia de caracteres (anulável)		No
tipo	enumeração	O tipo de origem. Sempre `stored_completions`. Valores possíveis: `stored_completions`	Yes

OpenAI.FileCitationBody

Uma citação a um arquivo.

Nome	Tipo	Description	Obrigatório
file_id	cadeia	A ID do arquivo.	Yes
filename	cadeia	O nome do arquivo citado.	Yes
indexar	OpenAI.integer		Yes
tipo	enumeração	O tipo da citação de arquivo. Sempre `file_citation`. Valores possíveis: `file_citation`	Yes

OpenAI.FilePath

Um caminho para um arquivo.

Nome	Tipo	Description	Obrigatório
file_id	cadeia	A ID do arquivo.	Yes
indexar	OpenAI.integer		Yes
tipo	enumeração	O tipo do caminho do arquivo. Sempre `file_path`. Valores possíveis: `file_path`	Yes

OpenAI.FileSearchTool

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

Nome	Tipo	Description	Obrigatório
Filtros	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
vector_store_ids	matriz de strings	Os IDs dos repositórios de vetores a serem pesquisados.	Yes

OpenAI.FileSearchToolCallResults

Nome	Tipo	Description	Obrigatório
attributes	OpenAI.VectorStoreFileAttributes (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. Chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um máximo comprimento de 512 caracteres, boolianos ou números.	No
file_id	cadeia		No
filename	cadeia		No
pontuação	número		No
enviar SMS	cadeia		No

OpenAI.Filters

Tipo: OpenAI.ComparisonFilter ou OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

Os hiperparâmetros usados para o trabalho de ajuste fino do DPO.

Nome	Tipo	Description	Obrigatório
tamanho_do_lote	string ou OpenAI.integer	Número de exemplos em cada lote. Um tamanho de lote maior significa que os parâmetros do modelo são atualizados com menos frequência, mas com menor variância.	No
beta	string ou OpenAI.numeric	O valor beta do método DPO. Um valor beta mais alto aumentará o peso da penalidade entre a política e o modelo de referência.	No
multiplicador_da_taxa_de_aprendizado	string ou OpenAI.numeric	Fator de dimensionamento para a taxa de aprendizado. Uma taxa de aprendizagem menor pode ser útil para evitar o sobreajuste.	No
n_épocas	string ou OpenAI.integer	O número de épocas para o qual o modelo deve ser treinado. Uma era refere-se a um ciclo completo do conjunto de dados de treinamento.	No

OpenAI.FineTuneDPOMethod

Configuração do método de ajuste fino do DPO.

Nome	Tipo	Description	Obrigatório	Default
hiperparâmetros	OpenAI.FineTuneDPOHyperparameters	Os hiperparâmetros usados para o trabalho de ajuste fino do DPO.	No

OpenAI.FineTuneMethod

O método usado para ajuste fino.

Nome	Tipo	Description	Obrigatório
Dpo	OpenAI.FineTuneDPOMethod	Configuração do método de ajuste fino do DPO.	No
Reforço	OpenAI.FineTuneReinforcementMethod	Configuração para o método de ajuste fino de reforço.	No
Supervisionado	OpenAI.FineTuneSupervisedMethod	Configuração do método de ajuste fino supervisionado.	No
tipo	enumeração	O tipo de método. É, `superviseddpo`ou `reinforcement`. Valores possíveis: `supervised`, , `dporeinforcement`	Yes

OpenAI.FineTuneReinforcementHyperparameters

Os hiperparâmetros usados para o trabalho de ajuste fino de reforço.

Nome	Tipo	Description	Obrigatório
tamanho_do_lote	string ou OpenAI.integer	Número de exemplos em cada lote. Um tamanho de lote maior significa que os parâmetros do modelo são atualizados com menos frequência, mas com menor variância.	No
compute_multiplier	string ou OpenAI.numeric	Multiplicador na quantidade de computação usada para explorar o espaço de pesquisa durante o treinamento.	No
eval_interval	string ou OpenAI.integer	O número de etapas de treinamento entre as execuções de avaliação.	No
eval_samples	string ou OpenAI.integer	Número de exemplos de avaliação a serem gerados por etapa de treinamento.	No
multiplicador_da_taxa_de_aprendizado	string ou OpenAI.numeric	Fator de dimensionamento para a taxa de aprendizado. Uma taxa de aprendizagem menor pode ser útil para evitar o sobreajuste.	No
n_épocas	string ou OpenAI.integer	O número de épocas para o qual o modelo deve ser treinado. Uma era refere-se a um ciclo completo do conjunto de dados de treinamento.	No
esforço de raciocínio	enumeração	Nível de esforço de raciocínio. Valores possíveis: `default`, , `low`, `mediumhigh`	No

OpenAI.FineTuneReinforcementMethod

Configuração para o método de ajuste fino de reforço.

Nome	Tipo	Description	Obrigatório	Default
Série	OpenAI.GraderStringCheck ou OpenAI.GraderTextSimilarity ou OpenAI.GraderPython ou OpenAI.GraderScoreModel ou OpenAI.GraderMulti	O classificador usado para o trabalho de ajuste fino.	Yes
hiperparâmetros	OpenAI.FineTuneReinforcementHyperparameters	Os hiperparâmetros usados para o trabalho de ajuste fino de reforço.	No

OpenAI.FineTuneSupervisedHyperparameters

Os hiperparâmetros usados para o trabalho de ajuste fino.

Nome	Tipo	Description	Obrigatório
tamanho_do_lote	string ou OpenAI.integer	Número de exemplos em cada lote. Um tamanho de lote maior significa que os parâmetros do modelo são atualizados com menos frequência, mas com menor variância.	No
multiplicador_da_taxa_de_aprendizado	string ou OpenAI.numeric	Fator de dimensionamento para a taxa de aprendizado. Uma taxa de aprendizagem menor pode ser útil para evitar o sobreajuste.	No
n_épocas	string ou OpenAI.integer	O número de épocas para o qual o modelo deve ser treinado. Uma era refere-se a um ciclo completo do conjunto de dados de treinamento.	No

OpenAI.FineTuneSupervisedMethod

Configuração do método de ajuste fino supervisionado.

Nome	Tipo	Description	Obrigatório	Default
hiperparâmetros	OpenAI.FineTuneSupervisedHyperparameters	Os hiperparâmetros usados para o trabalho de ajuste fino.	No

OpenAI.FineTuningIntegration

Nome	Tipo	Description	Obrigatório
tipo	enumeração	O tipo da integração que está sendo habilitada para o trabalho de ajuste fino Valores possíveis: `wandb`	Yes
wandb	OpenAI.FineTuningIntegrationWandb		Yes
└─ entidade	cadeia de caracteres (anulável)		No
└─ nome	cadeia de caracteres (anulável)		No
└─ projeto	cadeia		Yes
└─ etiquetas	matriz de strings		No

OpenAI.FineTuningIntegrationWandb

Nome	Tipo	Obrigatório
entidade	cadeia de caracteres (anulável)	No
nome	cadeia de caracteres (anulável)	No
projeto	cadeia	Yes
tags	matriz de strings	No

OpenAI.FineTuningJob

O fine_tuning.job objeto representa um trabalho de ajuste fino que foi criado por meio da API.

Nome	Tipo	Description	Obrigatório	Default
criado_em	inteiro	O carimbo de data/hora Unix (em segundos) para quando o trabalho de ajuste fino foi criado.	Yes
erro	OpenAI.FineTuningJobError (anulável)		Yes
└─ código	cadeia		Yes
Mensagem └─	cadeia		Yes
└─ Param	cadeia de caracteres (anulável)		Yes
estimativa de conclusão	inteiro		No
fine_tuned_model	cadeia de caracteres (anulável)		Yes
finished_at	inteiro		Yes
hiperparâmetros	OpenAI.FineTuningJobHyperparameters		Yes
└─ tamanho_do_lote (batch_size)	string ou OpenAI.integer		No	automático
└─ multiplicador_da_taxa_de_aprendizagem	string ou OpenAI.numeric		No
└─ n_epochs	string ou OpenAI.integer		No	automático
id	cadeia	O identificador de objeto, que pode ser referenciado nos pontos de extremidade da API.	Yes
Integrações	matriz de OpenAI.FineTuningIntegration		No
metadados	OpenAI.Metadata (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.	No
método	OpenAI.FineTuneMethod	O método usado para ajuste fino.	No
modelo	cadeia	O modelo base que está sendo ajustado.	Yes
objeto	enumeração	O tipo de objeto, que é sempre "fine_tuning.job". Valores possíveis: `fine_tuning.job`	Yes
organization_id	cadeia	A organização que possui o trabalho de ajuste fino.	Yes
arquivos_de_resultado	matriz de strings	As IDs do arquivo de resultados compilados para o trabalho de ajuste fino. Você pode recuperar os resultados com a API de Arquivos.	Yes
seed	OpenAI.integer		Yes
status	enumeração	O status atual do trabalho de ajuste fino, que pode ser, , `validating_files`, , `queuedrunning`, ou `succeededfailed`.`cancelled` Valores possíveis: `validating_files`, , `queued`, `running`, `succeeded`, , `failedcancelled`	Yes
trained_tokens	OpenAI.integer (anulável)		Yes
arquivo_de_treinamento	cadeia	A ID do arquivo usada para treinamento. Você pode recuperar os dados de treinamento com a API de Arquivos.	Yes
arquivo_de_validação	cadeia de caracteres (anulável)		Yes

OpenAI.FineTuningJobCheckpoint

O fine_tuning.job.checkpoint objeto representa um ponto de verificação de modelo para um trabalho de ajuste fino que está pronto para uso.

Nome	Tipo	Description	Obrigatório
criado_em	inteiro	O carimbo de data/hora unix (em segundos) para quando o ponto de verificação foi criado.	Yes
fine_tuned_model_checkpoint	cadeia	O nome do modelo de ponto de verificação ajustado que é criado.	Yes
fine_tuning_job_id	cadeia	O nome do trabalho de ajuste fino do qual esse ponto de verificação foi criado.	Yes
id	cadeia	O identificador de ponto de verificação, que pode ser referenciado nos pontos de extremidade da API.	Yes
métricas	OpenAI.FineTuningJobCheckpointMetrics		Yes
└─ perda_total_de_validacao	OpenAI.numeric		No
└─ precisão_média_de_tokens_válidos_completos	OpenAI.numeric		No
└─ etapa	OpenAI.numeric		No
└─ perda_ao_treinar (train_loss)	OpenAI.numeric		No
└─ precisão_média_de_tokens_em_treinamento (train_mean_token_accuracy)	OpenAI.numeric		No
└─ perda_de_validação	OpenAI.numeric		No
└─ precisão_média_dos_tokens_válidos	OpenAI.numeric		No
objeto	enumeração	O tipo de objeto, que é sempre "fine_tuning.job.checkpoint". Valores possíveis: `fine_tuning.job.checkpoint`	Yes
número_do_passo	OpenAI.integer		Yes

OpenAI.FineTuningJobCheckpointMetrics

Nome	Tipo	Obrigatório
full_valid_loss	OpenAI.numeric	No
full_valid_mean_token_accuracy	OpenAI.numeric	No
etapa	OpenAI.numeric	No
train_loss	OpenAI.numeric	No
train_mean_token_accuracy	OpenAI.numeric	No
valid_loss	OpenAI.numeric	No
valid_mean_token_accuracy	OpenAI.numeric	No

OpenAI.FineTuningJobError

Nome	Tipo	Obrigatório
codificar	cadeia	Yes
mensagem	cadeia	Yes
param	cadeia de caracteres (anulável)	Yes

OpenAI.FineTuningJobEvent

Objeto de evento de trabalho de ajuste fino

Nome	Tipo	Description	Obrigatório
criado_em	inteiro	O carimbo de data/hora Unix (em segundos) para quando o trabalho de ajuste fino foi criado.	Yes
dados	OpenAI.FineTuningJobEventData		No
id	cadeia	O identificador do objeto.	Yes
nível	enumeração	O nível de log do evento. Valores possíveis: `info`, , `warnerror`	Yes
mensagem	cadeia	A mensagem do evento.	Yes
objeto	enumeração	O tipo de objeto, que é sempre "fine_tuning.job.event". Valores possíveis: `fine_tuning.job.event`	Yes
tipo	enumeração	O tipo do evento. Valores possíveis: `message`, `metrics`	No

OpenAI.FineTuningJobEventData

Tipo: objeto

OpenAI.FineTuningJobHyperparameters

Nome	Tipo	Obrigatório
tamanho_do_lote	string ou OpenAI.integer	No
multiplicador_da_taxa_de_aprendizado	string ou OpenAI.numeric	No
n_épocas	string ou OpenAI.integer	No

OpenAI.FunctionAndCustomToolCallOutput

Discriminador para OpenAI.FunctionAndCustomToolCallOutput

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

Digite um valor	Schema
`input_text`	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
`input_image`	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.FunctionAndCustomToolCallOutputType		Yes

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Uma entrada de arquivo para o modelo.

Nome	Tipo	Description	Obrigatório
file_data	cadeia	O conteúdo do arquivo a ser enviado para o modelo.	No
file_id	cadeia de caracteres (anulável)		No
file_url	cadeia	A URL do arquivo a ser enviado para o modelo.	No
filename	cadeia	O nome do arquivo a ser enviado para o modelo.	No
tipo	enumeração	O tipo do item de entrada. Sempre `input_file`. Valores possíveis: `input_file`	Yes

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Uma entrada de imagem para o modelo. Saiba mais sobre entradas de imagem.

Nome	Tipo	Description	Obrigatório
detail	OpenAI.ImageDetail		Yes
file_id	cadeia de caracteres (anulável)		No
image_url	cadeia		No
tipo	enumeração	O tipo do item de entrada. Sempre `input_image`. Valores possíveis: `input_image`	Yes

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Uma entrada de texto para o modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	A entrada de texto para o modelo.	Yes
tipo	enumeração	O tipo do item de entrada. Sempre `input_text`. Valores possíveis: `input_text`	Yes

OpenAI.FunctionAndCustomToolCallOutputType

Property	Valor
Type	cadeia
Valores	`input_text` `input_image` `input_file`

OpenAI.FunctionCallItemStatus

Property	Valor
Type	cadeia
Valores	`in_progress` `completed` `incomplete`

OpenAI.FunctionObject

Nome	Tipo	Description	Obrigatório
description	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. Deve ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com um comprimento máximo de 64.	Yes
parameters	OpenAI.FunctionParameters	Os parâmetros que as funções aceitam, descritos como um objeto de esquema JSON. Veja o guide para exemplos, e a referência JSON Schema para documentação sobre o formato. Omitir `parameters` define uma função com uma lista de parâmetros vazia.	No
rigoroso	booliano (anulável)		No

OpenAI.FunctionParameters

Os parâmetros que as funções aceitam, descritos como um objeto de esquema JSON. Veja o guide para exemplos, e a referência JSON Schema para documentação sobre o formato. Omitir parameters define uma função com uma lista de parâmetros vazia.

Tipo: objeto

OpenAI.FunctionShellAction

Execute um comando de shell.

Nome	Tipo	Obrigatório
commands	matriz de strings	Yes
max_output_length	OpenAI.integer (anulável)	Yes
tempo_de_espera_ms	OpenAI.integer (anulável)	Yes

OpenAI.FunctionShellActionParam

Comandos e limites que descrevem como executar a chamada de ferramenta do shell.

Nome	Tipo	Description	Obrigatório
commands	matriz de strings	Comandos de shell ordenados para que o ambiente de execução seja executado.	Yes
max_output_length	OpenAI.integer (anulável)		No
tempo_de_espera_ms	OpenAI.integer (anulável)		No

OpenAI.FunctionShellCallItemStatus

Valores de status relatados para chamadas de ferramenta de shell.

Property	Valor
Type	cadeia
Valores	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputContent

O conteúdo de uma saída de chamada de ferramenta de shell que foi emitida.

Nome	Tipo	Description	Obrigatório
created_by	cadeia	O identificador do ator que criou o item.	No
resultado	OpenAI.FunctionShellCallOutputOutcome	Representa um resultado de saída (com um código de saída) ou um resultado de tempo limite para uma parte de saída de chamada de shell.	Yes
└─ tipo	OpenAI.FunctionShellCallOutputOutcomeType		Yes
Stderr	cadeia	A saída de erro padrão que foi capturada.	Yes
stdout	cadeia	A saída padrão que foi capturada.	Yes

OpenAI.FunctionShellCallOutputContentParam

Stdout e stderr capturados para uma parte de uma saída de chamada de ferramenta de shell.

Nome	Tipo	Description	Obrigatório
resultado	OpenAI.FunctionShellCallOutputOutcomeParam	O resultado de saída ou tempo limite associado a essa chamada de shell.	Yes
└─ tipo	OpenAI.FunctionShellCallOutputOutcomeParamType		Yes
Stderr	cadeia	Saída stderr capturada para a chamada de shell. Restrições: maxLength: 10485760	Yes
stdout	cadeia	Saída stdout capturada para a chamada de shell. Restrições: maxLength: 10485760	Yes

OpenAI.FunctionShellCallOutputExitOutcome

Indica que os comandos do shell foram concluídos e retornaram um código de saída.

Nome	Tipo	Description	Obrigatório	Default
exit_code	OpenAI.integer		Yes
tipo	enumeração	O tipo de resultado. Sempre `exit`. Valores possíveis: `exit`	Yes

OpenAI.FunctionShellCallOutputExitOutcomeParam

Indica que os comandos do shell foram concluídos e retornaram um código de saída.

Nome	Tipo	Description	Obrigatório	Default
exit_code	OpenAI.integer		Yes
tipo	enumeração	O tipo de resultado. Sempre `exit`. Valores possíveis: `exit`	Yes

OpenAI.FunctionShellCallOutputOutcome

Representa um resultado de saída (com um código de saída) ou um resultado de tempo limite para uma parte de saída de chamada de shell.

Discriminador para OpenAI.FunctionShellCallOutputOutcome

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

Digite um valor	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcome
`exit`	OpenAI.FunctionShellCallOutputExitOutcome

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.FunctionShellCallOutputOutcomeType		Yes

OpenAI.FunctionShellCallOutputOutcomeParam

O resultado de saída ou tempo limite associado a essa chamada de shell.

Discriminador para OpenAI.FunctionShellCallOutputOutcomeParam

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

Digite um valor	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
`exit`	OpenAI.FunctionShellCallOutputExitOutcomeParam

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.FunctionShellCallOutputOutcomeParamType		Yes

OpenAI.FunctionShellCallOutputOutcomeParamType

Property	Valor
Type	cadeia
Valores	`timeout` `exit`

OpenAI.FunctionShellCallOutputOutcomeType

Property	Valor
Type	cadeia
Valores	`timeout` `exit`

OpenAI.FunctionShellCallOutputTimeoutOutcome

Indica que a chamada de shell excedeu o limite de tempo configurado.

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	O tipo de resultado. Sempre `timeout`. Valores possíveis: `timeout`	Yes

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Indica que a chamada de shell excedeu o limite de tempo configurado.

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	O tipo de resultado. Sempre `timeout`. Valores possíveis: `timeout`	Yes

OpenAI.FunctionShellToolParam

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

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

OpenAI.FunctionTool

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

Nome	Tipo	Description	Obrigatório
description	cadeia de caracteres (anulável)		No
nome	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

OpenAI.GraderLabelModel

Um objeto LabelModelGrader que usa um modelo para atribuir rótulos a cada item na avaliação.

Nome	Tipo	Description	Obrigatório
entrada	matriz de OpenAI.EvalItem		Yes
labels	matriz de strings	Os rótulos a serem atribuídos a cada item na avaliação.	Yes
modelo	cadeia	O modelo a ser usado para a avaliação. Deve dar suporte a saídas estruturadas.	Yes
nome	cadeia	O nome do avaliador.	Yes
etiquetas_de_passagem	matriz de strings	Os rótulos que indicam um resultado aprovado. Deve ser um subconjunto de rótulos.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `label_model`. Valores possíveis: `label_model`	Yes

OpenAI.GraderMulti

Um objeto MultiGrader combina a saída de vários alunos para produzir uma pontuação única.

Nome	Tipo	Description	Obrigatório
calculate_output	cadeia	Uma fórmula para calcular a saída com base nos resultados do classificador.	Yes
Série	OpenAI.GraderStringCheck ou OpenAI.GraderTextSimilarity ou OpenAI.GraderPython ou OpenAI.GraderScoreModel ou OpenAI.GraderLabelModel		Yes
nome	cadeia	O nome do avaliador.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `multi`. Valores possíveis: `multi`	Yes

OpenAI.GraderPython

Um objeto PythonGrader que executa um script python na entrada.

Nome	Tipo	Description	Obrigatório
image_tag	cadeia	A marca de imagem a ser usada para o script python.	No
nome	cadeia	O nome do avaliador.	Yes
fonte	cadeia	O código-fonte do script python.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `python`. Valores possíveis: `python`	Yes

OpenAI.GraderScoreModel

Um objeto ScoreModelGrader que usa um modelo para atribuir uma pontuação à entrada.

Nome	Tipo	Description	Obrigatório	Default
entrada	matriz de OpenAI.EvalItem	As mensagens de entrada avaliadas pelo classificador. Dá suporte a blocos de conteúdo de áudio de entrada, texto de saída, texto de saída e texto de entrada e pode incluir cadeias de caracteres de modelo.	Yes
modelo	cadeia	O modelo a ser usado para a avaliação.	Yes
nome	cadeia	O nome do avaliador.	Yes
alcance	matriz de OpenAI.numeric	O intervalo da pontuação. Usa `[0, 1]` como padrão.	No
sampling_params	OpenAI.EvalGraderScoreModelSamplingParams		No
└─ max_completions_tokens	OpenAI.integer (anulável)		No
└─ esforço_de_raciocínio	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
└─ semente	OpenAI.integer (anulável)		No
└─ temperatura	OpenAI.numeric (anulável )		No
└─ top_p	OpenAI.numeric (anulável )		No	1
tipo	enumeração	O tipo de objeto, que é sempre `score_model`. Valores possíveis: `score_model`	Yes

OpenAI.GraderStringCheck

Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada.

Nome	Tipo	Description	Obrigatório
entrada	cadeia	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Yes
nome	cadeia	O nome do avaliador.	Yes
operação	enumeração	A operação de verificação de cadeia de caracteres a ser executada. Um de `eq`, `ne`, `like`ou `ilike`. Valores possíveis: `eq`, , `ne`, `likeilike`	Yes
referência	cadeia	O texto de referência. Isso pode incluir cadeias de caracteres de modelo.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `string_check`. Valores possíveis: `string_check`	Yes

OpenAI.GraderTextSimilarity

Um objeto TextSimilarityGrader que classifica o texto com base em métricas de similaridade.

Nome	Tipo	Description	Obrigatório
métrica de avaliação	enumeração	A métrica de avaliação a ser usada. Um de `cosine`, `fuzzy_match`, , `bleu` `gleu`, `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, `rouge_4`, , `rouge_5` ou `rouge_l`. Valores possíveis: `cosine`, , `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, , `rouge_2`, `rouge_3`, , `rouge_4`, , `rouge_5rouge_l`	Yes
entrada	cadeia	O texto que está sendo avaliado.	Yes
nome	cadeia	O nome do avaliador.	Yes
referência	cadeia	O texto de referência para avaliação.	Yes
tipo	enumeração	O tipo de avaliador. Valores possíveis: `text_similarity`	Yes

OpenAI.GrammarSyntax1

Property	Valor
Type	cadeia
Valores	`lark` `regex`

OpenAI.HybridSearchOptions

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

OpenAI.ImageDetail

Property	Valor
Type	cadeia
Valores	`low` `high` `auto`

OpenAI.ImageGenTool

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

Modelos válidos:

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

Nome	Tipo	Description	Obrigatório	Default
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
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 só tem suporte para `gpt-image-1`. Sem suporte 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		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
compressão_de_saída	OpenAI.integer		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
imagens parciais	OpenAI.integer		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
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
tipo	enumeração	O tipo da ferramenta de geração de imagem. Sempre `image_generation`. Valores possíveis: `image_generation`	Yes

OpenAI.ImageGenToolInputImageMask

Nome	Tipo	Description	Obrigatório	Default
file_id	cadeia		No
image_url	cadeia		No

OpenAI.IncludeEnum

Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Os valores com suporte no momento são:

web_search_call.action.sources: inclua as fontes da chamada da ferramenta de pesquisa na Web.
code_interpreter_call.outputs: inclui as saídas da execução de código python em itens de chamada de ferramenta de interpretador de código.
computer_call_output.output.image_url: inclua urls de imagem da saída da chamada do computador.
file_search_call.results: inclua os resultados da pesquisa da chamada da ferramenta de pesquisa de arquivos.
message.input_image.image_url: inclua urls de imagem da mensagem de entrada.
message.output_text.logprobs: inclua logprobs com mensagens de assistente.
reasoning.encrypted_content: inclui uma versão criptografada de tokens de raciocínio em saídas de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em conversas de vários turnos ao utilizar a API de Respostas sem estado (como quando o parâmetro store é definido para false, ou quando uma organização está inscrita no programa de retenção de dados zero).

Property	Valor
Description	Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Os valores com suporte no momento são:

web_search_call.action.sources: inclua as fontes da chamada da ferramenta de pesquisa na Web.
code_interpreter_call.outputs: inclui as saídas da execução de código python em itens de chamada de ferramenta de interpretador de código.
computer_call_output.output.image_url: inclua urls de imagem da saída da chamada do computador.
file_search_call.results: inclua os resultados da pesquisa da chamada da ferramenta de pesquisa de arquivos.
message.input_image.image_url: inclua urls de imagem da mensagem de entrada.
message.output_text.logprobs: inclua logprobs com mensagens de assistente.
reasoning.encrypted_content: inclui uma versão criptografada de tokens de raciocínio em saídas de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em conversas de vários turnos ao utilizar a API de Respostas sem estado (como quando o parâmetro store é definido para false, ou quando uma organização está inscrita no programa de retenção de dados zero). | | Tipo | cadeia de caracteres | | Valores | file_search_call.results
web_search_call.results
web_search_call.action.sources
message.input_image.image_url
computer_call_output.output.image_url
code_interpreter_call.outputs
reasoning.encrypted_content
message.output_text.logprobs
memory_search_call.results |

OpenAI.InputAudio

Uma entrada de áudio para o modelo.

Nome	Tipo	Description	Obrigatório	Default
input_audio	OpenAI.InputAudioInputAudio		Yes
tipo	enumeração	O tipo do item de entrada. Sempre `input_audio`. Valores possíveis: `input_audio`	Yes

OpenAI.InputAudioInputAudio

Nome	Tipo	Description	Obrigatório	Default
dados	cadeia		Yes
format	enumeração	Valores possíveis: `mp3`, `wav`	Yes

OpenAI.InputContent

Discriminador para OpenAI.InputContent

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

Digite um valor	Schema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputContentInputImageContent
`input_file`	OpenAI.InputContentInputFileContent

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.InputContentType		Yes

OpenAI.InputContentInputFileContent

Uma entrada de arquivo para o modelo.

Nome	Tipo	Description	Obrigatório
file_data	cadeia	O conteúdo do arquivo a ser enviado para o modelo.	No
file_id	cadeia de caracteres (anulável)		No
file_url	cadeia	A URL do arquivo a ser enviado para o modelo.	No
filename	cadeia	O nome do arquivo a ser enviado para o modelo.	No
tipo	enumeração	O tipo do item de entrada. Sempre `input_file`. Valores possíveis: `input_file`	Yes

OpenAI.InputContentInputImageContent

Uma entrada de imagem para o modelo. Saiba mais sobre entradas de imagem.

Nome	Tipo	Description	Obrigatório
detail	OpenAI.ImageDetail		Yes
file_id	cadeia de caracteres (anulável)		No
image_url	cadeia		No
tipo	enumeração	O tipo do item de entrada. Sempre `input_image`. Valores possíveis: `input_image`	Yes

OpenAI.InputContentInputTextContent

Uma entrada de texto para o modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	A entrada de texto para o modelo.	Yes
tipo	enumeração	O tipo do item de entrada. Sempre `input_text`. Valores possíveis: `input_text`	Yes

OpenAI.InputContentType

Property	Valor
Type	cadeia
Valores	`input_text` `input_image` `input_file`

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 só tem suporte para gpt-image-1. Sem suporte para gpt-image-1-mini. Suportes high e low. Usa low como padrão.

Property	Valor
Type	cadeia
Valores	`high` `low`

OpenAI.InputFileContent

Uma entrada de arquivo para o modelo.

Nome	Tipo	Description	Obrigatório
file_data	cadeia	O conteúdo do arquivo a ser enviado para o modelo.	No
file_id	cadeia de caracteres (anulável)		No
file_url	cadeia	A URL do arquivo a ser enviado para o modelo.	No
filename	cadeia	O nome do arquivo a ser enviado para o modelo.	No
tipo	enumeração	O tipo do item de entrada. Sempre `input_file`. Valores possíveis: `input_file`	Yes

OpenAI.InputFileContentParam

Uma entrada de arquivo para o modelo.

Nome	Tipo	Description	Obrigatório
file_data	cadeia de caracteres (anulável)		No
file_id	cadeia de caracteres (anulável)		No
file_url	cadeia		No
filename	cadeia de caracteres (anulável)		No
tipo	enumeração	O tipo do item de entrada. Sempre `input_file`. Valores possíveis: `input_file`	Yes

OpenAI.InputImageContent

Uma entrada de imagem para o modelo. Saiba mais sobre entradas de imagem.

Nome	Tipo	Description	Obrigatório
detail	OpenAI.ImageDetail		Yes
file_id	cadeia de caracteres (anulável)		No
image_url	cadeia		No
tipo	enumeração	O tipo do item de entrada. Sempre `input_image`. Valores possíveis: `input_image`	Yes

OpenAI.InputImageContentParamAutoParam

Uma entrada de imagem para o modelo. Saiba mais sobre entradas de imagem

Nome	Tipo	Description	Obrigatório
detail	OpenAI.DetailEnum (anulável)		No
file_id	cadeia de caracteres (anulável)		No
image_url	cadeia		No
tipo	enumeração	O tipo do item de entrada. Sempre `input_image`. Valores possíveis: `input_image`	Yes

OpenAI.InputItem

Um item que representa parte do contexto para a resposta a ser gerada pelo modelo. Pode conter entradas de texto, imagens e áudio, bem como respostas anteriores do assistente e saídas de chamadas de ferramenta.

Discriminador para OpenAI.InputItem

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

Digite um valor	Schema
`message`	OpenAI.EasyInputMessage
`item_reference`	OpenAI.ItemReferenceParam
`output_message`	OpenAI.InputItemOutputMessage
`file_search_call`	OpenAI.InputItemFileSearchToolCall
`computer_call`	OpenAI.InputItemComputerToolCall
`computer_call_output`	OpenAI.InputItemComputerCallOutputItemParam
`web_search_call`	OpenAI.InputItemWebSearchToolCall
`function_call`	OpenAI.InputItemFunctionToolCall
`function_call_output`	OpenAI.InputItemFunctionCallOutputItemParam
`reasoning`	OpenAI.InputItemReasoningItem
`compaction`	OpenAI.InputItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.InputItemImageGenToolCall
`code_interpreter_call`	OpenAI.InputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.InputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.InputItemLocalShellToolCallOutput
`shell_call`	OpenAI.InputItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.InputItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.InputItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.InputItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.InputItemMcpListTools
`mcp_approval_request`	OpenAI.InputItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.InputItemMcpApprovalResponse
`mcp_call`	OpenAI.InputItemMcpToolCall
`custom_tool_call_output`	OpenAI.InputItemCustomToolCallOutput
`custom_tool_call`	OpenAI.InputItemCustomToolCall

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.InputItemType		Yes

OpenAI.InputItemApplyPatchToolCallItemParam

Uma chamada de ferramenta que representa uma solicitação para criar, excluir ou atualizar arquivos usando patches dif.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch gerada pelo modelo. Restrições: minLength: 1, maxLength: 64	Yes
id	cadeia de caracteres (anulável)		No
operação	OpenAI.ApplyPatchOperationParam	Uma das operações de create_file, delete_file ou update_file fornecidas à ferramenta apply_patch.	Yes
└─ tipo	OpenAI.ApplyPatchOperationParamType		Yes
status	OpenAI.ApplyPatchCallStatusParam	Valores de status relatados para chamadas de ferramenta de apply_patch.	Yes
tipo	enumeração	O tipo do item. Sempre `apply_patch_call`. Valores possíveis: `apply_patch_call`	Yes

OpenAI.InputItemApplyPatchToolCallOutputItemParam

A saída transmitida emitida por uma chamada de ferramenta aplicar patch.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch gerada pelo modelo. Restrições: minLength: 1, maxLength: 64	Yes
id	cadeia de caracteres (anulável)		No
saída	cadeia de caracteres (anulável)		No
status	OpenAI.ApplyPatchCallOutputStatusParam	Valores de resultado relatados para saídas de chamada de ferramenta de apply_patch.	Yes
tipo	enumeração	O tipo do item. Sempre `apply_patch_call_output`. Valores possíveis: `apply_patch_call_output`	Yes

OpenAI.InputItemCodeInterpreterToolCall

Uma chamada de ferramenta para executar o código.

Nome	Tipo	Description	Obrigatório
codificar	cadeia de caracteres (anulável)		Yes
container_id	cadeia	A ID do contêiner usado para executar o código.	Yes
id	cadeia	A ID exclusiva da chamada da ferramenta de intérprete de código.	Yes
outputs	matriz de OpenAI.CodeInterpreterOutputLogs ou OpenAI.CodeInterpreterOutputImage		Yes
status	enumeração	O status da chamada da ferramenta de intérprete de código. Os valores válidos são `in_progress`, , `completed`, `incomplete`, `interpreting`e `failed`. Valores possíveis: `in_progress`, , `completed`, `incomplete`, `interpreting`, `failed`	Yes
tipo	enumeração	O tipo da chamada da ferramenta de intérprete de código. Sempre `code_interpreter_call`. Valores possíveis: `code_interpreter_call`	Yes

OpenAI.InputItemCompactionSummaryItemParam

Um item de compactação gerado pela v1/responses/compact API.

Nome	Tipo	Description	Obrigatório
encrypted_content	cadeia	O conteúdo criptografado do resumo da compactação. Restrições: maxLength: 10485760	Yes
id	cadeia de caracteres (anulável)		No
tipo	enumeração	O tipo do item. Sempre `compaction`. Valores possíveis: `compaction`	Yes

OpenAI.InputItemComputerCallOutputItemParam

A saída de uma chamada de ferramenta de computador.

Nome	Tipo	Description	Obrigatório
acknowledged_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam		No
call_id	cadeia	A ID da chamada da ferramenta de computador que produziu a saída. Restrições: minLength: 1, maxLength: 64	Yes
id	cadeia de caracteres (anulável)		No
saída	OpenAI.ComputerScreenshotImage	Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.	Yes
status	OpenAI.FunctionCallItemStatus (anulável)		No
tipo	enumeração	O tipo da saída de chamada da ferramenta de computador. Sempre `computer_call_output`. Valores possíveis: `computer_call_output`	Yes

OpenAI.InputItemComputerToolCall

Uma chamada de ferramenta para uma ferramenta de uso de computador. Consulte o guia de uso do computador para obter mais informações.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.ComputerAction		Yes
call_id	cadeia	Um identificador usado ao responder à chamada de ferramenta com saída.	Yes
id	cadeia	O identificador único da chamada do computador.	Yes
pending_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam	As verificações de segurança pendentes para a chamada de computador.	Yes
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	O tipo da chamada de computador. Sempre `computer_call`. Valores possíveis: `computer_call`	Yes

OpenAI.InputItemCustomToolCall

Uma chamada para uma ferramenta personalizada criada pelo modelo.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	Um identificador usado para mapear essa chamada de ferramenta personalizada para uma saída de chamada de ferramenta.	Yes
id	cadeia	A ID exclusiva da chamada de ferramenta personalizada na plataforma OpenAI.	No
entrada	cadeia	A entrada para a chamada de ferramenta personalizada gerada pelo modelo.	Yes
nome	cadeia	O nome da ferramenta personalizada que está sendo chamada.	Yes
tipo	enumeração	O tipo da chamada de ferramenta personalizada. Sempre `custom_tool_call`. Valores possíveis: `custom_tool_call`	Yes

OpenAI.InputItemCustomToolCallOutput

A saída de uma chamada de ferramenta personalizada do código, sendo enviada de volta para o modelo.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID da chamada, usada para mapear essa saída de chamada de ferramenta personalizada para uma chamada de ferramenta personalizada.	Yes
id	cadeia	A ID exclusiva da saída de chamada de ferramenta personalizada na plataforma OpenAI.	No
saída	cadeia de caracteres ou matriz de OpenAI.FunctionAndCustomToolCallOutput	A saída da chamada de ferramenta personalizada gerada pelo seu código. Pode ser uma cadeia de caracteres ou uma lista de conteúdo de saída.	Yes
tipo	enumeração	O tipo da saída da chamada de ferramenta personalizada. Sempre `custom_tool_call_output`. Valores possíveis: `custom_tool_call_output`	Yes

OpenAI.InputItemFileSearchToolCall

Os resultados de uma chamada de ferramenta de pesquisa de arquivo. Consulte o guia de pesquisa de arquivos para obter mais informações.

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada da ferramenta de pesquisa de arquivos.	Yes
Consultas	matriz de strings	As consultas usadas para pesquisar arquivos.	Yes
results	matriz de OpenAI.FileSearchToolCallResults		No
status	enumeração	O status da chamada da ferramenta de pesquisa de arquivos. Uma opção entre `in_progress`, `searching`, `incomplete` ou `failed`, Valores possíveis: `in_progress`, , `searching`, `completed`, `incomplete`, `failed`	Yes
tipo	enumeração	O tipo da chamada da ferramenta de pesquisa de arquivo. Sempre `file_search_call`. Valores possíveis: `file_search_call`	Yes

OpenAI.InputItemFunctionCallOutputItemParam

A saída de uma chamada de ferramenta de função.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo. Restrições: minLength: 1, maxLength: 64	Yes
id	cadeia de caracteres (anulável)		No
saída	cadeia de caracteres ou matriz de OpenAI.InputTextContentParam ou OpenAI.InputImageContentParamAutoParam ou OpenAI.InputFileContentParam	Saída de texto, imagem ou arquivo da chamada da ferramenta de função.	Yes
status	OpenAI.FunctionCallItemStatus (anulável)		No
tipo	enumeração	O tipo da saída de chamada da ferramenta de função. Sempre `function_call_output`. Valores possíveis: `function_call_output`	Yes

OpenAI.InputItemFunctionShellCallItemParam

Uma ferramenta que representa uma solicitação para executar um ou mais comandos de shell.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.FunctionShellActionParam	Comandos e limites que descrevem como executar a chamada de ferramenta do shell.	Yes
Comandos └─	matriz de strings	Comandos de shell ordenados para que o ambiente de execução seja executado.	Yes
└─ max_output_length	OpenAI.integer (anulável)		No
└─ timeout_ms	OpenAI.integer (anulável)		No
call_id	cadeia	A ID exclusiva da chamada de ferramenta de shell gerada pelo modelo. Restrições: minLength: 1, maxLength: 64	Yes
id	cadeia de caracteres (anulável)		No
status	OpenAI.FunctionShellCallItemStatus (anulável)	Valores de status relatados para chamadas de ferramenta de shell.	No
tipo	enumeração	O tipo do item. Sempre `shell_call`. Valores possíveis: `shell_call`	Yes

OpenAI.InputItemFunctionShellCallOutputItemParam

Os itens de saída transmitidos emitidos por uma chamada de ferramenta de shell.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada de ferramenta de shell gerada pelo modelo. Restrições: minLength: 1, maxLength: 64	Yes
id	cadeia de caracteres (anulável)		No
max_output_length	OpenAI.integer (anulável)		No
saída	matriz de OpenAI.FunctionShellCallOutputContentParam	Partes capturadas de stdout e saída stderr, juntamente com seus resultados associados.	Yes
tipo	enumeração	O tipo do item. Sempre `shell_call_output`. Valores possíveis: `shell_call_output`	Yes

OpenAI.InputItemFunctionToolCall

Uma chamada de ferramenta para executar uma função. Consulte o guia de chamada de função para obter mais informações.

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos a serem passados para a função.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Yes
id	cadeia	A ID exclusiva da chamada da ferramenta de função.	No
nome	cadeia	O nome da função a ser executada.	Yes
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da chamada da ferramenta de função. Sempre `function_call`. Valores possíveis: `function_call`	Yes

OpenAI.InputItemImageGenToolCall

Uma solicitação de geração de imagem feita pelo modelo.

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada de geração de imagem.	Yes
Resultado	cadeia de caracteres (anulável)		Yes
status	enumeração	O status da chamada de geração de imagem. Valores possíveis: `in_progress`, , `completed`, `generatingfailed`	Yes
tipo	enumeração	O tipo da chamada de geração de imagem. Sempre `image_generation_call`. Valores possíveis: `image_generation_call`	Yes

OpenAI.InputItemLocalShellToolCall

Uma chamada de ferramenta para executar um comando no shell local.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.LocalShellExecAction	Execute um comando shell no servidor.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Yes
id	cadeia	A ID exclusiva da chamada de shell local.	Yes
status	enumeração	O status da chamada de shell local. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	O tipo da chamada de shell local. Sempre `local_shell_call`. Valores possíveis: `local_shell_call`	Yes

OpenAI.InputItemLocalShellToolCallOutput

A saída de uma chamada de ferramenta de shell local.

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Yes
saída	cadeia	Uma cadeia de caracteres JSON da saída da chamada da ferramenta de shell local.	Yes
status	enumeração	Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da saída da chamada da ferramenta de shell local. Sempre `local_shell_call_output`. Valores possíveis: `local_shell_call_output`	Yes

OpenAI.InputItemMcpApprovalRequest

Uma solicitação de aprovação humana de uma invocação de ferramenta.

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma string JSON de argumentos para a ferramenta.	Yes
id	cadeia	A ID exclusiva da solicitação de aprovação.	Yes
nome	cadeia	O nome da ferramenta a ser executada.	Yes
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que está fazendo a solicitação.	Yes
tipo	enumeração	O tipo do item. Sempre `mcp_approval_request`. Valores possíveis: `mcp_approval_request`	Yes

OpenAI.InputItemMcpApprovalResponse

Uma resposta a uma solicitação de aprovação do MCP.

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia	A ID da solicitação de aprovação que está sendo respondida.	Yes
aprovar	boolean	Se a solicitação foi aprovada.	Yes
id	cadeia de caracteres (anulável)		No
reason	cadeia de caracteres (anulável)		No
tipo	enumeração	O tipo do item. Sempre `mcp_approval_response`. Valores possíveis: `mcp_approval_response`	Yes

OpenAI.InputItemMcpListTools

Uma lista de ferramentas disponíveis em um servidor MCP.

Nome	Tipo	Description	Obrigatório
erro	cadeia de caracteres (anulável)		No
id	cadeia	A ID exclusiva da lista.	Yes
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP.	Yes
tools	matriz de OpenAI.MCPListToolsTool	As ferramentas disponíveis no servidor.	Yes
tipo	enumeração	O tipo do item. Sempre `mcp_list_tools`. Valores possíveis: `mcp_list_tools`	Yes

OpenAI.InputItemMcpToolCall

Uma invocação de uma ferramenta em um servidor MCP.

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia de caracteres (anulável)		No
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta.	Yes
erro	cadeia de caracteres (anulável)		No
id	cadeia	A ID exclusiva da chamada de ferramenta.	Yes
nome	cadeia	O nome da ferramenta que foi executada.	Yes
saída	cadeia de caracteres (anulável)		No
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que executa a ferramenta.	Yes
status	OpenAI.MCPToolCallStatus		No
tipo	enumeração	O tipo do item. Sempre `mcp_call`. Valores possíveis: `mcp_call`	Yes

OpenAI.InputItemOutputMessage

Uma mensagem de saída do modelo.

Nome	Tipo	Description	Obrigatório
conteúdo	matriz de OpenAI.OutputMessageContent	O conteúdo da mensagem de saída.	Yes
id	cadeia	A identificação única da mensagem de saída.	Yes
função	enumeração	A função da mensagem de saída. Sempre `assistant`. Valores possíveis: `assistant`	Yes
status	enumeração	O status da entrada da mensagem. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens de entrada são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	O tipo da mensagem de saída. Sempre `message`. Valores possíveis: `output_message`	Yes

OpenAI.InputItemReasoningItem

Nome	Tipo	Description	Obrigatório
conteúdo	matriz de OpenAI.ReasoningTextContent	Conteúdo de texto de raciocínio.	No
encrypted_content	cadeia de caracteres (anulável)		No
id	cadeia	O identificador exclusivo do conteúdo de raciocínio.	Yes
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
resumo	matriz de OpenAI.Summary	Conteúdo de resumo de raciocínio.	Yes
tipo	enumeração	O tipo do objeto. Sempre `reasoning`. Valores possíveis: `reasoning`	Yes

OpenAI.InputItemType

Property Valor

Type cadeia

Valores message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
custom_tool_call_output
custom_tool_call
item_reference

OpenAI.InputItemWebSearchToolCall

Os resultados de uma chamada de ferramenta de pesquisa na Web. Consulte o guia de pesquisa na Web para obter mais informações.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.WebSearchActionSearch ou OpenAI.WebSearchActionOpenPage ou OpenAI.WebSearchActionFind	Um objeto que descreve a ação específica executada nesta chamada de pesquisa na Web. Inclui detalhes sobre como o modelo usou a Web (pesquisa, open_page, localizar).	Yes
id	cadeia	A ID exclusiva da chamada da ferramenta de pesquisa na Web.	Yes
status	enumeração	O status da chamada da ferramenta de pesquisa na Web. Valores possíveis: `in_progress`, , `searching`, `completedfailed`	Yes
tipo	enumeração	O tipo da chamada da ferramenta de pesquisa na Web. Sempre `web_search_call`. Valores possíveis: `web_search_call`	Yes

OpenAI.InputMessage

Nome	Tipo	Description	Obrigatório
conteúdo	OpenAI.InputMessageContentList	Uma lista de um ou muitos itens de entrada para o modelo, contendo conteúdo diferente types.	Yes
função	enumeração	A função da entrada de mensagem. Uma opção entre `user`, `system` ou `developer`. Valores possíveis: `user`, , `systemdeveloper`	Yes
status	enumeração	O status do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo de entrada da mensagem. Sempre defina como `message`. Valores possíveis: `message`	Yes

OpenAI.InputMessageContentList

Uma lista de um ou muitos itens de entrada para o modelo, contendo tipos de conteúdo diferentes.

Matriz de: OpenAI.InputContent

OpenAI.InputMessageResource

Nome	Tipo	Description	Obrigatório
conteúdo	OpenAI.InputMessageContentList	Uma lista de um ou muitos itens de entrada para o modelo, contendo conteúdo diferente types.	Yes
id	cadeia	A ID exclusiva da entrada da mensagem.	Yes
função	enumeração	A função da entrada de mensagem. Uma opção entre `user`, `system` ou `developer`. Valores possíveis: `user`, , `systemdeveloper`	Yes
status	enumeração	O status do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo de entrada da mensagem. Sempre defina como `message`. Valores possíveis: `message`	Yes

OpenAI.InputParam

Entradas de texto, imagem ou arquivo para o modelo, usadas para gerar uma resposta. Saiba mais:

Tipo: cadeia de caracteres ou matriz de OpenAI.InputItem

Entradas de texto, imagem ou arquivo para o modelo, usadas para gerar uma resposta. Saiba mais:

OpenAI.InputTextContent

Uma entrada de texto para o modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	A entrada de texto para o modelo.	Yes
tipo	enumeração	O tipo do item de entrada. Sempre `input_text`. Valores possíveis: `input_text`	Yes

OpenAI.InputTextContentParam

Uma entrada de texto para o modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	A entrada de texto para o modelo. Restrições: maxLength: 10485760	Yes
tipo	enumeração	O tipo do item de entrada. Sempre `input_text`. Valores possíveis: `input_text`	Yes

OpenAI.Item

Item de conteúdo usado para gerar uma resposta.

Discriminador para OpenAI.Item

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

Digite um valor	Schema
`memory_search_call`	MemorySearchToolCallItemParam
`message`	OpenAI.InputMessage
`output_message`	OpenAI.ItemOutputMessage
`file_search_call`	OpenAI.ItemFileSearchToolCall
`computer_call`	OpenAI.ItemComputerToolCall
`computer_call_output`	OpenAI.ItemComputerCallOutputItemParam
`web_search_call`	OpenAI.ItemWebSearchToolCall
`function_call`	OpenAI.ItemFunctionToolCall
`function_call_output`	OpenAI.ItemFunctionCallOutputItemParam
`reasoning`	OpenAI.ItemReasoningItem
`compaction`	OpenAI.ItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.ItemImageGenToolCall
`code_interpreter_call`	OpenAI.ItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemLocalShellToolCallOutput
`shell_call`	OpenAI.ItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.ItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.ItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.ItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.ItemMcpListTools
`mcp_approval_request`	OpenAI.ItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemMcpApprovalResponse
`mcp_call`	OpenAI.ItemMcpToolCall
`custom_tool_call_output`	OpenAI.ItemCustomToolCallOutput
`custom_tool_call`	OpenAI.ItemCustomToolCall

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ItemType		Yes

OpenAI.ItemApplyPatchToolCallItemParam

Uma chamada de ferramenta que representa uma solicitação para criar, excluir ou atualizar arquivos usando patches dif.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch gerada pelo modelo. Restrições: minLength: 1, maxLength: 64	Yes
id	cadeia de caracteres (anulável)		No
operação	OpenAI.ApplyPatchOperationParam	Uma das operações de create_file, delete_file ou update_file fornecidas à ferramenta apply_patch.	Yes
└─ tipo	OpenAI.ApplyPatchOperationParamType		Yes
status	OpenAI.ApplyPatchCallStatusParam	Valores de status relatados para chamadas de ferramenta de apply_patch.	Yes
tipo	enumeração	O tipo do item. Sempre `apply_patch_call`. Valores possíveis: `apply_patch_call`	Yes

OpenAI.ItemApplyPatchToolCallOutputItemParam

A saída transmitida emitida por uma chamada de ferramenta aplicar patch.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch gerada pelo modelo. Restrições: minLength: 1, maxLength: 64	Yes
id	cadeia de caracteres (anulável)		No
saída	cadeia de caracteres (anulável)		No
status	OpenAI.ApplyPatchCallOutputStatusParam	Valores de resultado relatados para saídas de chamada de ferramenta de apply_patch.	Yes
tipo	enumeração	O tipo do item. Sempre `apply_patch_call_output`. Valores possíveis: `apply_patch_call_output`	Yes

OpenAI.ItemCodeInterpreterToolCall

Uma chamada de ferramenta para executar o código.

Nome	Tipo	Description	Obrigatório
codificar	cadeia de caracteres (anulável)		Yes
container_id	cadeia	A ID do contêiner usado para executar o código.	Yes
id	cadeia	A ID exclusiva da chamada da ferramenta de intérprete de código.	Yes
outputs	matriz de OpenAI.CodeInterpreterOutputLogs ou OpenAI.CodeInterpreterOutputImage		Yes
status	enumeração	O status da chamada da ferramenta de intérprete de código. Os valores válidos são `in_progress`, , `completed`, `incomplete`, `interpreting`e `failed`. Valores possíveis: `in_progress`, , `completed`, `incomplete`, `interpreting`, `failed`	Yes
tipo	enumeração	O tipo da chamada da ferramenta de intérprete de código. Sempre `code_interpreter_call`. Valores possíveis: `code_interpreter_call`	Yes

OpenAI.ItemCompactionSummaryItemParam

Um item de compactação gerado pela v1/responses/compact API.

Nome	Tipo	Description	Obrigatório
encrypted_content	cadeia	O conteúdo criptografado do resumo da compactação. Restrições: maxLength: 10485760	Yes
id	cadeia de caracteres (anulável)		No
tipo	enumeração	O tipo do item. Sempre `compaction`. Valores possíveis: `compaction`	Yes

OpenAI.ItemComputerCallOutputItemParam

A saída de uma chamada de ferramenta de computador.

Nome	Tipo	Description	Obrigatório
acknowledged_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam		No
call_id	cadeia	A ID da chamada da ferramenta de computador que produziu a saída. Restrições: minLength: 1, maxLength: 64	Yes
id	cadeia de caracteres (anulável)		No
saída	OpenAI.ComputerScreenshotImage	Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.	Yes
status	OpenAI.FunctionCallItemStatus (anulável)		No
tipo	enumeração	O tipo da saída de chamada da ferramenta de computador. Sempre `computer_call_output`. Valores possíveis: `computer_call_output`	Yes

OpenAI.ItemComputerToolCall

Uma chamada de ferramenta para uma ferramenta de uso de computador. Consulte o guia de uso do computador para obter mais informações.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.ComputerAction		Yes
call_id	cadeia	Um identificador usado ao responder à chamada de ferramenta com saída.	Yes
id	cadeia	O identificador único da chamada do computador.	Yes
pending_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam	As verificações de segurança pendentes para a chamada de computador.	Yes
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	O tipo da chamada de computador. Sempre `computer_call`. Valores possíveis: `computer_call`	Yes

OpenAI.ItemCustomToolCall

Uma chamada para uma ferramenta personalizada criada pelo modelo.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	Um identificador usado para mapear essa chamada de ferramenta personalizada para uma saída de chamada de ferramenta.	Yes
id	cadeia	A ID exclusiva da chamada de ferramenta personalizada na plataforma OpenAI.	No
entrada	cadeia	A entrada para a chamada de ferramenta personalizada gerada pelo modelo.	Yes
nome	cadeia	O nome da ferramenta personalizada que está sendo chamada.	Yes
tipo	enumeração	O tipo da chamada de ferramenta personalizada. Sempre `custom_tool_call`. Valores possíveis: `custom_tool_call`	Yes

OpenAI.ItemCustomToolCallOutput

A saída de uma chamada de ferramenta personalizada do código, sendo enviada de volta para o modelo.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID da chamada, usada para mapear essa saída de chamada de ferramenta personalizada para uma chamada de ferramenta personalizada.	Yes
id	cadeia	A ID exclusiva da saída de chamada de ferramenta personalizada na plataforma OpenAI.	No
saída	cadeia de caracteres ou matriz de OpenAI.FunctionAndCustomToolCallOutput	A saída da chamada de ferramenta personalizada gerada pelo seu código. Pode ser uma cadeia de caracteres ou uma lista de conteúdo de saída.	Yes
tipo	enumeração	O tipo da saída da chamada de ferramenta personalizada. Sempre `custom_tool_call_output`. Valores possíveis: `custom_tool_call_output`	Yes

OpenAI.ItemFileSearchToolCall

Os resultados de uma chamada de ferramenta de pesquisa de arquivo. Consulte o guia de pesquisa de arquivos para obter mais informações.

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada da ferramenta de pesquisa de arquivos.	Yes
Consultas	matriz de strings	As consultas usadas para pesquisar arquivos.	Yes
results	matriz de OpenAI.FileSearchToolCallResults		No
status	enumeração	O status da chamada da ferramenta de pesquisa de arquivos. Uma opção entre `in_progress`, `searching`, `incomplete` ou `failed`, Valores possíveis: `in_progress`, , `searching`, `completed`, `incomplete`, `failed`	Yes
tipo	enumeração	O tipo da chamada da ferramenta de pesquisa de arquivo. Sempre `file_search_call`. Valores possíveis: `file_search_call`	Yes

OpenAI.ItemFunctionCallOutputItemParam

A saída de uma chamada de ferramenta de função.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo. Restrições: minLength: 1, maxLength: 64	Yes
id	cadeia de caracteres (anulável)		No
saída	cadeia de caracteres ou matriz de OpenAI.InputTextContentParam ou OpenAI.InputImageContentParamAutoParam ou OpenAI.InputFileContentParam	Saída de texto, imagem ou arquivo da chamada da ferramenta de função.	Yes
status	OpenAI.FunctionCallItemStatus (anulável)		No
tipo	enumeração	O tipo da saída de chamada da ferramenta de função. Sempre `function_call_output`. Valores possíveis: `function_call_output`	Yes

OpenAI.ItemFunctionShellCallItemParam

Uma ferramenta que representa uma solicitação para executar um ou mais comandos de shell.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.FunctionShellActionParam	Comandos e limites que descrevem como executar a chamada de ferramenta do shell.	Yes
Comandos └─	matriz de strings	Comandos de shell ordenados para que o ambiente de execução seja executado.	Yes
└─ max_output_length	OpenAI.integer (anulável)		No
└─ timeout_ms	OpenAI.integer (anulável)		No
call_id	cadeia	A ID exclusiva da chamada de ferramenta de shell gerada pelo modelo. Restrições: minLength: 1, maxLength: 64	Yes
id	cadeia de caracteres (anulável)		No
status	OpenAI.FunctionShellCallItemStatus (anulável)	Valores de status relatados para chamadas de ferramenta de shell.	No
tipo	enumeração	O tipo do item. Sempre `shell_call`. Valores possíveis: `shell_call`	Yes

OpenAI.ItemFunctionShellCallOutputItemParam

Os itens de saída transmitidos emitidos por uma chamada de ferramenta de shell.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada de ferramenta de shell gerada pelo modelo. Restrições: minLength: 1, maxLength: 64	Yes
id	cadeia de caracteres (anulável)		No
max_output_length	OpenAI.integer (anulável)		No
saída	matriz de OpenAI.FunctionShellCallOutputContentParam	Partes capturadas de stdout e saída stderr, juntamente com seus resultados associados.	Yes
tipo	enumeração	O tipo do item. Sempre `shell_call_output`. Valores possíveis: `shell_call_output`	Yes

OpenAI.ItemFunctionToolCall

Uma chamada de ferramenta para executar uma função. Consulte o guia de chamada de função para obter mais informações.

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos a serem passados para a função.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Yes
id	cadeia	A ID exclusiva da chamada da ferramenta de função.	No
nome	cadeia	O nome da função a ser executada.	Yes
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da chamada da ferramenta de função. Sempre `function_call`. Valores possíveis: `function_call`	Yes

OpenAI.ItemImageGenToolCall

Uma solicitação de geração de imagem feita pelo modelo.

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada de geração de imagem.	Yes
Resultado	cadeia de caracteres (anulável)		Yes
status	enumeração	O status da chamada de geração de imagem. Valores possíveis: `in_progress`, , `completed`, `generatingfailed`	Yes
tipo	enumeração	O tipo da chamada de geração de imagem. Sempre `image_generation_call`. Valores possíveis: `image_generation_call`	Yes

OpenAI.ItemLocalShellToolCall

Uma chamada de ferramenta para executar um comando no shell local.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.LocalShellExecAction	Execute um comando shell no servidor.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Yes
id	cadeia	A ID exclusiva da chamada de shell local.	Yes
status	enumeração	O status da chamada de shell local. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	O tipo da chamada de shell local. Sempre `local_shell_call`. Valores possíveis: `local_shell_call`	Yes

OpenAI.ItemLocalShellToolCallOutput

A saída de uma chamada de ferramenta de shell local.

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Yes
saída	cadeia	Uma cadeia de caracteres JSON da saída da chamada da ferramenta de shell local.	Yes
status	enumeração	Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da saída da chamada da ferramenta de shell local. Sempre `local_shell_call_output`. Valores possíveis: `local_shell_call_output`	Yes

OpenAI.ItemMcpApprovalRequest

Uma solicitação de aprovação humana de uma invocação de ferramenta.

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma string JSON de argumentos para a ferramenta.	Yes
id	cadeia	A ID exclusiva da solicitação de aprovação.	Yes
nome	cadeia	O nome da ferramenta a ser executada.	Yes
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que está fazendo a solicitação.	Yes
tipo	enumeração	O tipo do item. Sempre `mcp_approval_request`. Valores possíveis: `mcp_approval_request`	Yes

OpenAI.ItemMcpApprovalResponse

Uma resposta a uma solicitação de aprovação do MCP.

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia	A ID da solicitação de aprovação que está sendo respondida.	Yes
aprovar	boolean	Se a solicitação foi aprovada.	Yes
id	cadeia de caracteres (anulável)		No
reason	cadeia de caracteres (anulável)		No
tipo	enumeração	O tipo do item. Sempre `mcp_approval_response`. Valores possíveis: `mcp_approval_response`	Yes

OpenAI.ItemMcpListTools

Uma lista de ferramentas disponíveis em um servidor MCP.

Nome	Tipo	Description	Obrigatório
erro	cadeia de caracteres (anulável)		No
id	cadeia	A ID exclusiva da lista.	Yes
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP.	Yes
tools	matriz de OpenAI.MCPListToolsTool	As ferramentas disponíveis no servidor.	Yes
tipo	enumeração	O tipo do item. Sempre `mcp_list_tools`. Valores possíveis: `mcp_list_tools`	Yes

OpenAI.ItemMcpToolCall

Uma invocação de uma ferramenta em um servidor MCP.

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia de caracteres (anulável)		No
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta.	Yes
erro	cadeia de caracteres (anulável)		No
id	cadeia	A ID exclusiva da chamada de ferramenta.	Yes
nome	cadeia	O nome da ferramenta que foi executada.	Yes
saída	cadeia de caracteres (anulável)		No
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que executa a ferramenta.	Yes
status	OpenAI.MCPToolCallStatus		No
tipo	enumeração	O tipo do item. Sempre `mcp_call`. Valores possíveis: `mcp_call`	Yes

OpenAI.ItemOutputMessage

Uma mensagem de saída do modelo.

Nome	Tipo	Description	Obrigatório
conteúdo	matriz de OpenAI.OutputMessageContent	O conteúdo da mensagem de saída.	Yes
id	cadeia	A identificação única da mensagem de saída.	Yes
função	enumeração	A função da mensagem de saída. Sempre `assistant`. Valores possíveis: `assistant`	Yes
status	enumeração	O status da entrada da mensagem. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens de entrada são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	O tipo da mensagem de saída. Sempre `message`. Valores possíveis: `output_message`	Yes

OpenAI.ItemReasoningItem

Nome	Tipo	Description	Obrigatório
conteúdo	matriz de OpenAI.ReasoningTextContent	Conteúdo de texto de raciocínio.	No
encrypted_content	cadeia de caracteres (anulável)		No
id	cadeia	O identificador exclusivo do conteúdo de raciocínio.	Yes
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
resumo	matriz de OpenAI.Summary	Conteúdo de resumo de raciocínio.	Yes
tipo	enumeração	O tipo do objeto. Sempre `reasoning`. Valores possíveis: `reasoning`	Yes

OpenAI.ItemReferenceParam

Um identificador interno para um item a ser referenciado.

Nome	Tipo	Description	Obrigatório	Default
id	cadeia	A ID do item a ser referenciado.	Yes
tipo	enumeração	O tipo de item a ser referenciado. Sempre `item_reference`. Valores possíveis: `item_reference`	Yes

OpenAI.ItemResource

Item de conteúdo usado para gerar uma resposta.

Discriminador para OpenAI.ItemResource

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

Digite um valor	Schema
`message`	OpenAI.InputMessageResource
`output_message`	OpenAI.ItemResourceOutputMessage
`file_search_call`	OpenAI.ItemResourceFileSearchToolCall
`computer_call`	OpenAI.ItemResourceComputerToolCall
`computer_call_output`	OpenAI.ItemResourceComputerToolCallOutputResource
`web_search_call`	OpenAI.ItemResourceWebSearchToolCall
`function_call`	OpenAI.ItemResourceFunctionToolCallResource
`function_call_output`	OpenAI.ItemResourceFunctionToolCallOutputResource
`image_generation_call`	OpenAI.ItemResourceImageGenToolCall
`code_interpreter_call`	OpenAI.ItemResourceCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemResourceLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemResourceLocalShellToolCallOutput
`shell_call`	OpenAI.ItemResourceFunctionShellCall
`shell_call_output`	OpenAI.ItemResourceFunctionShellCallOutput
`apply_patch_call`	OpenAI.ItemResourceApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ItemResourceApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ItemResourceMcpListTools
`mcp_approval_request`	OpenAI.ItemResourceMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemResourceMcpApprovalResponseResource
`mcp_call`	OpenAI.ItemResourceMcpToolCall

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ItemResourceType		Yes

OpenAI.ItemResourceApplyPatchToolCall

Uma chamada de ferramenta que aplica diferenças de arquivo criando, excluindo ou atualizando arquivos.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch gerada pelo modelo.	Yes
created_by	cadeia	A ID da entidade que criou essa chamada de ferramenta.	No
id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch. Populado quando esse item é retornado por meio da API.	Yes
operação	OpenAI.ApplyPatchFileOperation	Uma das operações de create_file, delete_file ou update_file aplicadas por meio de apply_patch.	Yes
└─ tipo	OpenAI.ApplyPatchFileOperationType		Yes
status	OpenAI.ApplyPatchCallStatus		Yes
tipo	enumeração	O tipo do item. Sempre `apply_patch_call`. Valores possíveis: `apply_patch_call`	Yes

OpenAI.ItemResourceApplyPatchToolCallOutput

A saída emitida por uma chamada de ferramenta aplicar patch.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch gerada pelo modelo.	Yes
created_by	cadeia	A ID da entidade que criou essa saída de chamada de ferramenta.	No
id	cadeia	A ID exclusiva da saída de chamada da ferramenta aplicar patch. Populado quando esse item é retornado por meio da API.	Yes
saída	cadeia de caracteres (anulável)		No
status	OpenAI.ApplyPatchCallOutputStatus		Yes
tipo	enumeração	O tipo do item. Sempre `apply_patch_call_output`. Valores possíveis: `apply_patch_call_output`	Yes

OpenAI.ItemResourceCodeInterpreterToolCall

Uma chamada de ferramenta para executar o código.

Nome	Tipo	Description	Obrigatório
codificar	cadeia de caracteres (anulável)		Yes
container_id	cadeia	A ID do contêiner usado para executar o código.	Yes
id	cadeia	A ID exclusiva da chamada da ferramenta de intérprete de código.	Yes
outputs	matriz de OpenAI.CodeInterpreterOutputLogs ou OpenAI.CodeInterpreterOutputImage		Yes
status	enumeração	O status da chamada da ferramenta de intérprete de código. Os valores válidos são `in_progress`, , `completed`, `incomplete`, `interpreting`e `failed`. Valores possíveis: `in_progress`, , `completed`, `incomplete`, `interpreting`, `failed`	Yes
tipo	enumeração	O tipo da chamada da ferramenta de intérprete de código. Sempre `code_interpreter_call`. Valores possíveis: `code_interpreter_call`	Yes

OpenAI.ItemResourceComputerToolCall

Uma chamada de ferramenta para uma ferramenta de uso de computador. Consulte o guia de uso do computador para obter mais informações.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.ComputerAction		Yes
call_id	cadeia	Um identificador usado ao responder à chamada de ferramenta com saída.	Yes
id	cadeia	O identificador único da chamada do computador.	Yes
pending_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam	As verificações de segurança pendentes para a chamada de computador.	Yes
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	O tipo da chamada de computador. Sempre `computer_call`. Valores possíveis: `computer_call`	Yes

OpenAI.ItemResourceComputerToolCallOutputResource

Nome	Tipo	Description	Obrigatório
acknowledged_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam	As verificações de segurança relatadas pela API que foram confirmadas pela desenvolvedor.	No
call_id	cadeia	A ID da chamada da ferramenta de computador que produziu a saída.	Yes
id	cadeia	A ID da saída da chamada da ferramenta de computador.	No
saída	OpenAI.ComputerScreenshotImage	Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.	Yes
status	enumeração	O status da entrada da mensagem. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens de entrada são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da saída de chamada da ferramenta de computador. Sempre `computer_call_output`. Valores possíveis: `computer_call_output`	Yes

OpenAI.ItemResourceFileSearchToolCall

Os resultados de uma chamada de ferramenta de pesquisa de arquivo. Consulte o guia de pesquisa de arquivos para obter mais informações.

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada da ferramenta de pesquisa de arquivos.	Yes
Consultas	matriz de strings	As consultas usadas para pesquisar arquivos.	Yes
results	matriz de OpenAI.FileSearchToolCallResults		No
status	enumeração	O status da chamada da ferramenta de pesquisa de arquivos. Uma opção entre `in_progress`, `searching`, `incomplete` ou `failed`, Valores possíveis: `in_progress`, , `searching`, `completed`, `incomplete`, `failed`	Yes
tipo	enumeração	O tipo da chamada da ferramenta de pesquisa de arquivo. Sempre `file_search_call`. Valores possíveis: `file_search_call`	Yes

OpenAI.ItemResourceFunctionShellCall

Uma chamada de ferramenta que executa um ou mais comandos de shell em um ambiente gerenciado.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.FunctionShellAction	Execute um comando de shell.	Yes
Comandos └─	matriz de strings		Yes
└─ max_output_length	OpenAI.integer (anulável)		Yes
└─ timeout_ms	OpenAI.integer (anulável)		Yes
call_id	cadeia	A ID exclusiva da chamada de ferramenta de shell gerada pelo modelo.	Yes
created_by	cadeia	A ID da entidade que criou essa chamada de ferramenta.	No
id	cadeia	A ID exclusiva da chamada da ferramenta shell. Populado quando esse item é retornado por meio da API.	Yes
status	OpenAI.LocalShellCallStatus		Yes
tipo	enumeração	O tipo do item. Sempre `shell_call`. Valores possíveis: `shell_call`	Yes

OpenAI.ItemResourceFunctionShellCallOutput

A saída de uma chamada de ferramenta de shell que foi emitida.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada de ferramenta de shell gerada pelo modelo.	Yes
created_by	cadeia	O identificador do ator que criou o item.	No
id	cadeia	A ID exclusiva da saída de chamada do shell. Populado quando esse item é retornado por meio da API.	Yes
max_output_length	OpenAI.integer (anulável)		Yes
saída	matriz de OpenAI.FunctionShellCallOutputContent	Uma matriz de conteúdo de saída de chamada de shell	Yes
tipo	enumeração	O tipo da saída da chamada de shell. Sempre `shell_call_output`. Valores possíveis: `shell_call_output`	Yes

OpenAI.ItemResourceFunctionToolCallOutputResource

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Yes
id	cadeia	A ID exclusiva da saída da chamada da ferramenta de função. Populado quando este item é retornado por meio da API.	No
saída	cadeia de caracteres ou matriz de OpenAI.FunctionAndCustomToolCallOutput	A saída da chamada de função gerada pelo código. Pode ser uma cadeia de caracteres ou uma lista de conteúdo de saída.	Yes
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da saída de chamada da ferramenta de função. Sempre `function_call_output`. Valores possíveis: `function_call_output`	Yes

OpenAI.ItemResourceFunctionToolCallResource

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos a serem passados para a função.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Yes
id	cadeia	A ID exclusiva da chamada da ferramenta de função.	No
nome	cadeia	O nome da função a ser executada.	Yes
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da chamada da ferramenta de função. Sempre `function_call`. Valores possíveis: `function_call`	Yes

OpenAI.ItemResourceImageGenToolCall

Uma solicitação de geração de imagem feita pelo modelo.

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada de geração de imagem.	Yes
Resultado	cadeia de caracteres (anulável)		Yes
status	enumeração	O status da chamada de geração de imagem. Valores possíveis: `in_progress`, , `completed`, `generatingfailed`	Yes
tipo	enumeração	O tipo da chamada de geração de imagem. Sempre `image_generation_call`. Valores possíveis: `image_generation_call`	Yes

OpenAI.ItemResourceLocalShellToolCall

Uma chamada de ferramenta para executar um comando no shell local.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.LocalShellExecAction	Execute um comando shell no servidor.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Yes
id	cadeia	A ID exclusiva da chamada de shell local.	Yes
status	enumeração	O status da chamada de shell local. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	O tipo da chamada de shell local. Sempre `local_shell_call`. Valores possíveis: `local_shell_call`	Yes

OpenAI.ItemResourceLocalShellToolCallOutput

A saída de uma chamada de ferramenta de shell local.

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Yes
saída	cadeia	Uma cadeia de caracteres JSON da saída da chamada da ferramenta de shell local.	Yes
status	enumeração	Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da saída da chamada da ferramenta de shell local. Sempre `local_shell_call_output`. Valores possíveis: `local_shell_call_output`	Yes

OpenAI.ItemResourceMcpApprovalRequest

Uma solicitação de aprovação humana de uma invocação de ferramenta.

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma string JSON de argumentos para a ferramenta.	Yes
id	cadeia	A ID exclusiva da solicitação de aprovação.	Yes
nome	cadeia	O nome da ferramenta a ser executada.	Yes
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que está fazendo a solicitação.	Yes
tipo	enumeração	O tipo do item. Sempre `mcp_approval_request`. Valores possíveis: `mcp_approval_request`	Yes

OpenAI.ItemResourceMcpApprovalResponseResource

Uma resposta a uma solicitação de aprovação do MCP.

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia	A ID da solicitação de aprovação que está sendo respondida.	Yes
aprovar	boolean	Se a solicitação foi aprovada.	Yes
id	cadeia	A ID exclusiva da resposta de aprovação	Yes
reason	cadeia de caracteres (anulável)		No
tipo	enumeração	O tipo do item. Sempre `mcp_approval_response`. Valores possíveis: `mcp_approval_response`	Yes

OpenAI.ItemResourceMcpListTools

Uma lista de ferramentas disponíveis em um servidor MCP.

Nome	Tipo	Description	Obrigatório
erro	cadeia de caracteres (anulável)		No
id	cadeia	A ID exclusiva da lista.	Yes
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP.	Yes
tools	matriz de OpenAI.MCPListToolsTool	As ferramentas disponíveis no servidor.	Yes
tipo	enumeração	O tipo do item. Sempre `mcp_list_tools`. Valores possíveis: `mcp_list_tools`	Yes

OpenAI.ItemResourceMcpToolCall

Uma invocação de uma ferramenta em um servidor MCP.

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia de caracteres (anulável)		No
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta.	Yes
erro	cadeia de caracteres (anulável)		No
id	cadeia	A ID exclusiva da chamada de ferramenta.	Yes
nome	cadeia	O nome da ferramenta que foi executada.	Yes
saída	cadeia de caracteres (anulável)		No
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que executa a ferramenta.	Yes
status	OpenAI.MCPToolCallStatus		No
tipo	enumeração	O tipo do item. Sempre `mcp_call`. Valores possíveis: `mcp_call`	Yes

OpenAI.ItemResourceOutputMessage

Uma mensagem de saída do modelo.

Nome	Tipo	Description	Obrigatório
conteúdo	matriz de OpenAI.OutputMessageContent	O conteúdo da mensagem de saída.	Yes
id	cadeia	A identificação única da mensagem de saída.	Yes
função	enumeração	A função da mensagem de saída. Sempre `assistant`. Valores possíveis: `assistant`	Yes
status	enumeração	O status da entrada da mensagem. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens de entrada são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	O tipo da mensagem de saída. Sempre `message`. Valores possíveis: `output_message`	Yes

OpenAI.ItemResourceType

Property Valor

Type cadeia

Valores message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
structured_outputs
oauth_consent_request
memory_search_call
workflow_action

OpenAI.ItemResourceWebSearchToolCall

Os resultados de uma chamada de ferramenta de pesquisa na Web. Consulte o guia de pesquisa na Web para obter mais informações.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.WebSearchActionSearch ou OpenAI.WebSearchActionOpenPage ou OpenAI.WebSearchActionFind	Um objeto que descreve a ação específica executada nesta chamada de pesquisa na Web. Inclui detalhes sobre como o modelo usou a Web (pesquisa, open_page, localizar).	Yes
id	cadeia	A ID exclusiva da chamada da ferramenta de pesquisa na Web.	Yes
status	enumeração	O status da chamada da ferramenta de pesquisa na Web. Valores possíveis: `in_progress`, , `searching`, `completedfailed`	Yes
tipo	enumeração	O tipo da chamada da ferramenta de pesquisa na Web. Sempre `web_search_call`. Valores possíveis: `web_search_call`	Yes

OpenAI.ItemType

Property Valor

Type cadeia

OpenAI.ItemWebSearchToolCall

Os resultados de uma chamada de ferramenta de pesquisa na Web. Consulte o guia de pesquisa na Web para obter mais informações.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.WebSearchActionSearch ou OpenAI.WebSearchActionOpenPage ou OpenAI.WebSearchActionFind	Um objeto que descreve a ação específica executada nesta chamada de pesquisa na Web. Inclui detalhes sobre como o modelo usou a Web (pesquisa, open_page, localizar).	Yes
id	cadeia	A ID exclusiva da chamada da ferramenta de pesquisa na Web.	Yes
status	enumeração	O status da chamada da ferramenta de pesquisa na Web. Valores possíveis: `in_progress`, , `searching`, `completedfailed`	Yes
tipo	enumeração	O tipo da chamada da ferramenta de pesquisa na Web. Sempre `web_search_call`. Valores possíveis: `web_search_call`	Yes

OpenAI.KeyPressAction

Uma coleção de pressionamentos de teclas que o modelo deseja realizar.

Nome	Tipo	Description	Obrigatório	Default
keys	matriz de strings	A combinação de teclas que o modelo está solicitando que sejam pressionadas. Essa é uma matriz de cadeias de caracteres, cada uma representando uma chave.	Yes
tipo	enumeração	Especifica o tipo de evento. Para uma ação keypress, essa propriedade é sempre definida como `keypress`. Valores possíveis: `keypress`	Yes

OpenAI.ListFineTuningJobCheckpointsResponse

Nome	Tipo	Description	Obrigatório
dados	matriz de OpenAI.FineTuningJobCheckpoint		Yes
first_id	cadeia de caracteres (anulável)		No
has_more	boolean		Yes
last_id	cadeia de caracteres (anulável)		No
objeto	enumeração	Valores possíveis: `list`	Yes

OpenAI.ListFineTuningJobEventsResponse

Nome	Tipo	Description	Obrigatório
dados	matriz de OpenAI.FineTuningJobEvent		Yes
has_more	boolean		Yes
objeto	enumeração	Valores possíveis: `list`	Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Nome	Tipo	Description	Obrigatório
dados	matriz de OpenAI.FineTuningJob		Yes
has_more	boolean		Yes
objeto	enumeração	Valores possíveis: `list`	Yes

OpenAI.LocalShellCallStatus

Property	Valor
Type	cadeia
Valores	`in_progress` `completed` `incomplete`

OpenAI.LocalShellExecAction

Execute um comando shell no servidor.

Nome	Tipo	Description	Obrigatório
comando	matriz de strings	O comando a ser executado.	Yes
env	objeto	Variáveis de ambiente a serem definidas para o comando.	Yes
tempo_de_espera_ms	OpenAI.integer (anulável)		No
tipo	enumeração	O tipo da ação do shell local. Sempre `exec`. Valores possíveis: `exec`	Yes
usuário	cadeia de caracteres (anulável)		No
working_directory	cadeia de caracteres (anulável)		No

OpenAI.LocalShellToolParam

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

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

OpenAI.LogProb

A probabilidade de log de um token.

Nome	Tipo	Obrigatório
bytes	matriz de OpenAI.integer	Yes
logprob	OpenAI.numeric	Yes
símbolo	cadeia	Yes
top_logprobs	matriz de OpenAI.TopLogProb	Yes

OpenAI.MCPListToolsTool

Uma ferramenta disponível em um servidor MCP.

Nome	Tipo	Description	Obrigatório
annotations	OpenAI.MCPListToolsToolAnnotations (anulável)		No
description	cadeia de caracteres (anulável)		No
input_schema	OpenAI.MCPListToolsToolInputSchema		Yes
nome	cadeia	O nome da ferramenta.	Yes

OpenAI.MCPListToolsToolAnnotations

Tipo: objeto

OpenAI.MCPListToolsToolInputSchema

Tipo: objeto

OpenAI.MCPTool

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

Nome	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 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 da conexão no project 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	objeto (consulte modelos válidos abaixo)		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	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.MCPToolCallStatus

Property	Valor
Type	cadeia
Valores	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

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

Nome	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

Nome	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.MessageContent

Uma parte de conteúdo que compõe um item de entrada ou saída.

Discriminador para OpenAI.MessageContent

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

Digite um valor	Schema
`text`	OpenAI.TextContent
`summary_text`	OpenAI.SummaryTextContent
`computer_screenshot`	OpenAI.ComputerScreenshotContent
`input_text`	OpenAI.MessageContentInputTextContent
`output_text`	OpenAI.MessageContentOutputTextContent
`reasoning_text`	OpenAI.MessageContentReasoningTextContent
`refusal`	OpenAI.MessageContentRefusalContent
`input_image`	OpenAI.MessageContentInputImageContent
`input_file`	OpenAI.MessageContentInputFileContent

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.MessageContentType		Yes

OpenAI.MessageContentInputFileContent

Uma entrada de arquivo para o modelo.

Nome	Tipo	Description	Obrigatório
file_data	cadeia	O conteúdo do arquivo a ser enviado para o modelo.	No
file_id	cadeia de caracteres (anulável)		No
file_url	cadeia	A URL do arquivo a ser enviado para o modelo.	No
filename	cadeia	O nome do arquivo a ser enviado para o modelo.	No
tipo	enumeração	O tipo do item de entrada. Sempre `input_file`. Valores possíveis: `input_file`	Yes

OpenAI.MessageContentInputImageContent

Uma entrada de imagem para o modelo. Saiba mais sobre entradas de imagem.

Nome	Tipo	Description	Obrigatório
detail	OpenAI.ImageDetail		Yes
file_id	cadeia de caracteres (anulável)		No
image_url	cadeia		No
tipo	enumeração	O tipo do item de entrada. Sempre `input_image`. Valores possíveis: `input_image`	Yes

OpenAI.MessageContentInputTextContent

Uma entrada de texto para o modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	A entrada de texto para o modelo.	Yes
tipo	enumeração	O tipo do item de entrada. Sempre `input_text`. Valores possíveis: `input_text`	Yes

OpenAI.MessageContentOutputTextContent

Uma saída de texto do modelo.

Nome	Tipo	Description	Obrigatório
annotations	matriz de OpenAI.Annotation	As anotações da saída de texto.	Yes
logprobs	matriz de OpenAI.LogProb		No
enviar SMS	cadeia	A saída de texto do modelo.	Yes
tipo	enumeração	O tipo do texto de saída. Sempre `output_text`. Valores possíveis: `output_text`	Yes

OpenAI.MessageContentReasoningTextContent

Texto de raciocínio do modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	O texto de raciocínio do modelo.	Yes
tipo	enumeração	O tipo do texto de raciocínio. Sempre `reasoning_text`. Valores possíveis: `reasoning_text`	Yes

OpenAI.MessageContentRefusalContent

Uma recusa do modelo.

Nome	Tipo	Description	Obrigatório	Default
Recusa	cadeia	A explicação da recusa do modelo.	Yes
tipo	enumeração	O tipo da recusa. Sempre `refusal`. Valores possíveis: `refusal`	Yes

OpenAI.MessageContentType

Property	Valor
Type	cadeia
Valores	`input_text` `output_text` `text` `summary_text` `reasoning_text` `refusal` `input_image` `computer_screenshot` `input_file`

OpenAI.MessageRole

Property	Valor
Type	cadeia
Valores	`unknown` `user` `assistant` `system` `critic` `discriminator` `developer` `tool`

OpenAI.MessageStatus

Property	Valor
Type	cadeia
Valores	`in_progress` `completed` `incomplete`

OpenAI.Metadata

Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.

Tipo: objeto

OpenAI.ModelIdsCompaction

ID do modelo usada para gerar a resposta, como gpt-5 ou o3. O OpenAI oferece uma ampla gama de modelos com diferentes funcionalidades, características de desempenho e pontos de preço. Consulte o guia do modelo para procurar e comparar os modelos disponíveis.

Tipo: OpenAI.ModelIdsResponses ou cadeia de caracteres

OpenAI.ModelIdsResponses

Property	Valor
Type	cadeia
Valores	`o1-pro` `o1-pro-2025-03-19` `o3-pro` `o3-pro-2025-06-10` `o3-deep-research` `o3-deep-research-2025-06-26` `o4-mini-deep-research` `o4-mini-deep-research-2025-06-26` `computer-use-preview` `computer-use-preview-2025-03-11` `gpt-5-codex` `gpt-5-pro` `gpt-5-pro-2025-10-06` `gpt-5.1-codex-max`

OpenAI.ModelIdsShared

Tipo: cadeia de caracteres ou OpenAI.ChatModel

OpenAI.Move

Uma ação de movimentação do mouse.

Nome	Tipo	Description	Obrigatório
tipo	enumeração	Especifica o tipo de evento. Para uma ação de movimentação, essa propriedade é sempre definido como `move`. Valores possíveis: `move`	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.OutputContent

Discriminador para OpenAI.OutputContent

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

Digite um valor	Schema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent
`reasoning_text`	OpenAI.OutputContentReasoningTextContent

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.OutputContentType		Yes

OpenAI.OutputContentOutputTextContent

Uma saída de texto do modelo.

Nome	Tipo	Description	Obrigatório
annotations	matriz de OpenAI.Annotation	As anotações da saída de texto.	Yes
logprobs	matriz de OpenAI.LogProb		No
enviar SMS	cadeia	A saída de texto do modelo.	Yes
tipo	enumeração	O tipo do texto de saída. Sempre `output_text`. Valores possíveis: `output_text`	Yes

OpenAI.OutputContentReasoningTextContent

Texto de raciocínio do modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	O texto de raciocínio do modelo.	Yes
tipo	enumeração	O tipo do texto de raciocínio. Sempre `reasoning_text`. Valores possíveis: `reasoning_text`	Yes

OpenAI.OutputContentRefusalContent

Uma recusa do modelo.

Nome	Tipo	Description	Obrigatório	Default
Recusa	cadeia	A explicação da recusa do modelo.	Yes
tipo	enumeração	O tipo da recusa. Sempre `refusal`. Valores possíveis: `refusal`	Yes

OpenAI.OutputContentType

Property	Valor
Type	cadeia
Valores	`output_text` `refusal` `reasoning_text`

OpenAI.OutputItem

Discriminador para OpenAI.OutputItem

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

Digite um valor	Schema
`structured_outputs`	StructuredOutputsOutputItem
`workflow_action`	WorkflowActionOutputItem
`oauth_consent_request`	OAuthConsentRequestOutputItem
`memory_search_call`	MemorySearchToolCallItemResource
`output_message`	OpenAI.OutputItemOutputMessage
`file_search_call`	OpenAI.OutputItemFileSearchToolCall
`function_call`	OpenAI.OutputItemFunctionToolCall
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`reasoning`	OpenAI.OutputItemReasoningItem
`compaction`	OpenAI.OutputItemCompactionBody
`image_generation_call`	OpenAI.OutputItemImageGenToolCall
`code_interpreter_call`	OpenAI.OutputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.OutputItemLocalShellToolCall
`shell_call`	OpenAI.OutputItemFunctionShellCall
`shell_call_output`	OpenAI.OutputItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.OutputItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.OutputItemApplyPatchToolCallOutput
`mcp_call`	OpenAI.OutputItemMcpToolCall
`mcp_list_tools`	OpenAI.OutputItemMcpListTools
`mcp_approval_request`	OpenAI.OutputItemMcpApprovalRequest
`custom_tool_call`	OpenAI.OutputItemCustomToolCall

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
response_id	cadeia	A resposta na qual o item é criado.	No
tipo	OpenAI.OutputItemType		Yes

OpenAI.OutputItemApplyPatchToolCall

Uma chamada de ferramenta que aplica diferenças de arquivo criando, excluindo ou atualizando arquivos.

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
call_id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch gerada pelo modelo.	Yes
created_by	cadeia	A ID da entidade que criou essa chamada de ferramenta.	No
id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch. Populado quando esse item é retornado por meio da API.	Yes
operação	OpenAI.ApplyPatchFileOperation	Uma das operações de create_file, delete_file ou update_file aplicadas por meio de apply_patch.	Yes
└─ tipo	OpenAI.ApplyPatchFileOperationType		Yes
response_id	cadeia	A resposta na qual o item é criado.	No
status	OpenAI.ApplyPatchCallStatus		Yes
tipo	enumeração	O tipo do item. Sempre `apply_patch_call`. Valores possíveis: `apply_patch_call`	Yes

OpenAI.OutputItemApplyPatchToolCallOutput

A saída emitida por uma chamada de ferramenta aplicar patch.

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
call_id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch gerada pelo modelo.	Yes
created_by	cadeia	A ID da entidade que criou essa saída de chamada de ferramenta.	No
id	cadeia	A ID exclusiva da saída de chamada da ferramenta aplicar patch. Populado quando esse item é retornado por meio da API.	Yes
saída	cadeia de caracteres (anulável)		No
response_id	cadeia	A resposta na qual o item é criado.	No
status	OpenAI.ApplyPatchCallOutputStatus		Yes
tipo	enumeração	O tipo do item. Sempre `apply_patch_call_output`. Valores possíveis: `apply_patch_call_output`	Yes

OpenAI.OutputItemCodeInterpreterToolCall

Uma chamada de ferramenta para executar o código.

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
codificar	cadeia de caracteres (anulável)		Yes
container_id	cadeia	A ID do contêiner usado para executar o código.	Yes
id	cadeia	A ID exclusiva da chamada da ferramenta de intérprete de código.	Yes
outputs	matriz de OpenAI.CodeInterpreterOutputLogs ou OpenAI.CodeInterpreterOutputImage		Yes
response_id	cadeia	A resposta na qual o item é criado.	No
status	enumeração	O status da chamada da ferramenta de intérprete de código. Os valores válidos são `in_progress`, , `completed`, `incomplete`, `interpreting`e `failed`. Valores possíveis: `in_progress`, , `completed`, `incomplete`, `interpreting`, `failed`	Yes
tipo	enumeração	O tipo da chamada da ferramenta de intérprete de código. Sempre `code_interpreter_call`. Valores possíveis: `code_interpreter_call`	Yes

OpenAI.OutputItemCompactionBody

Um item de compactação gerado pela v1/responses/compact API.

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
created_by	cadeia	O identificador do ator que criou o item.	No
encrypted_content	cadeia	O conteúdo criptografado que foi produzido pela compactação.	Yes
id	cadeia	A ID exclusiva do item de compactação.	Yes
response_id	cadeia	A resposta na qual o item é criado.	No
tipo	enumeração	O tipo do item. Sempre `compaction`. Valores possíveis: `compaction`	Yes

OpenAI.OutputItemComputerToolCall

Uma chamada de ferramenta para uma ferramenta de uso de computador. Consulte o guia de uso do computador para obter mais informações.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.ComputerAction		Yes
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
call_id	cadeia	Um identificador usado ao responder à chamada de ferramenta com saída.	Yes
id	cadeia	O identificador único da chamada do computador.	Yes
pending_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam	As verificações de segurança pendentes para a chamada de computador.	Yes
response_id	cadeia	A resposta na qual o item é criado.	No
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	O tipo da chamada de computador. Sempre `computer_call`. Valores possíveis: `computer_call`	Yes

OpenAI.OutputItemCustomToolCall

Uma chamada para uma ferramenta personalizada criada pelo modelo.

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
call_id	cadeia	Um identificador usado para mapear essa chamada de ferramenta personalizada para uma saída de chamada de ferramenta.	Yes
id	cadeia	A ID exclusiva da chamada de ferramenta personalizada na plataforma OpenAI.	No
entrada	cadeia	A entrada para a chamada de ferramenta personalizada gerada pelo modelo.	Yes
nome	cadeia	O nome da ferramenta personalizada que está sendo chamada.	Yes
response_id	cadeia	A resposta na qual o item é criado.	No
tipo	enumeração	O tipo da chamada de ferramenta personalizada. Sempre `custom_tool_call`. Valores possíveis: `custom_tool_call`	Yes

OpenAI.OutputItemFileSearchToolCall

Os resultados de uma chamada de ferramenta de pesquisa de arquivo. Consulte o guia de pesquisa de arquivos para obter mais informações.

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
id	cadeia	A ID exclusiva da chamada da ferramenta de pesquisa de arquivos.	Yes
Consultas	matriz de strings	As consultas usadas para pesquisar arquivos.	Yes
response_id	cadeia	A resposta na qual o item é criado.	No
results	matriz de OpenAI.FileSearchToolCallResults		No
status	enumeração	O status da chamada da ferramenta de pesquisa de arquivos. Uma opção entre `in_progress`, `searching`, `incomplete` ou `failed`, Valores possíveis: `in_progress`, , `searching`, `completed`, `incomplete`, `failed`	Yes
tipo	enumeração	O tipo da chamada da ferramenta de pesquisa de arquivo. Sempre `file_search_call`. Valores possíveis: `file_search_call`	Yes

OpenAI.OutputItemFunctionShellCall

Uma chamada de ferramenta que executa um ou mais comandos de shell em um ambiente gerenciado.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.FunctionShellAction	Execute um comando de shell.	Yes
Comandos └─	matriz de strings		Yes
└─ max_output_length	OpenAI.integer (anulável)		Yes
└─ timeout_ms	OpenAI.integer (anulável)		Yes
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
call_id	cadeia	A ID exclusiva da chamada de ferramenta de shell gerada pelo modelo.	Yes
created_by	cadeia	A ID da entidade que criou essa chamada de ferramenta.	No
id	cadeia	A ID exclusiva da chamada da ferramenta shell. Populado quando esse item é retornado por meio da API.	Yes
response_id	cadeia	A resposta na qual o item é criado.	No
status	OpenAI.LocalShellCallStatus		Yes
tipo	enumeração	O tipo do item. Sempre `shell_call`. Valores possíveis: `shell_call`	Yes

OpenAI.OutputItemFunctionShellCallOutput

A saída de uma chamada de ferramenta de shell que foi emitida.

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
call_id	cadeia	A ID exclusiva da chamada de ferramenta de shell gerada pelo modelo.	Yes
created_by	cadeia	O identificador do ator que criou o item.	No
id	cadeia	A ID exclusiva da saída de chamada do shell. Populado quando esse item é retornado por meio da API.	Yes
max_output_length	OpenAI.integer (anulável)		Yes
saída	matriz de OpenAI.FunctionShellCallOutputContent	Uma matriz de conteúdo de saída de chamada de shell	Yes
response_id	cadeia	A resposta na qual o item é criado.	No
tipo	enumeração	O tipo da saída da chamada de shell. Sempre `shell_call_output`. Valores possíveis: `shell_call_output`	Yes

OpenAI.OutputItemFunctionToolCall

Uma chamada de ferramenta para executar uma função. Consulte o guia de chamada de função para obter mais informações.

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos a serem passados para a função.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Yes
id	cadeia	A ID exclusiva da chamada da ferramenta de função.	No
nome	cadeia	O nome da função a ser executada.	Yes
response_id	cadeia	A resposta na qual o item é criado.	No
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da chamada da ferramenta de função. Sempre `function_call`. Valores possíveis: `function_call`	Yes

OpenAI.OutputItemImageGenToolCall

Uma solicitação de geração de imagem feita pelo modelo.

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
id	cadeia	A ID exclusiva da chamada de geração de imagem.	Yes
response_id	cadeia	A resposta na qual o item é criado.	No
Resultado	cadeia de caracteres (anulável)		Yes
status	enumeração	O status da chamada de geração de imagem. Valores possíveis: `in_progress`, , `completed`, `generatingfailed`	Yes
tipo	enumeração	O tipo da chamada de geração de imagem. Sempre `image_generation_call`. Valores possíveis: `image_generation_call`	Yes

OpenAI.OutputItemLocalShellToolCall

Uma chamada de ferramenta para executar um comando no shell local.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.LocalShellExecAction	Execute um comando shell no servidor.	Yes
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
call_id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Yes
id	cadeia	A ID exclusiva da chamada de shell local.	Yes
response_id	cadeia	A resposta na qual o item é criado.	No
status	enumeração	O status da chamada de shell local. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	O tipo da chamada de shell local. Sempre `local_shell_call`. Valores possíveis: `local_shell_call`	Yes

OpenAI.OutputItemMcpApprovalRequest

Uma solicitação de aprovação humana de uma invocação de ferramenta.

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
arguments	cadeia	Uma string JSON de argumentos para a ferramenta.	Yes
id	cadeia	A ID exclusiva da solicitação de aprovação.	Yes
nome	cadeia	O nome da ferramenta a ser executada.	Yes
response_id	cadeia	A resposta na qual o item é criado.	No
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que está fazendo a solicitação.	Yes
tipo	enumeração	O tipo do item. Sempre `mcp_approval_request`. Valores possíveis: `mcp_approval_request`	Yes

OpenAI.OutputItemMcpListTools

Uma lista de ferramentas disponíveis em um servidor MCP.

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
erro	cadeia de caracteres (anulável)		No
id	cadeia	A ID exclusiva da lista.	Yes
response_id	cadeia	A resposta na qual o item é criado.	No
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP.	Yes
tools	matriz de OpenAI.MCPListToolsTool	As ferramentas disponíveis no servidor.	Yes
tipo	enumeração	O tipo do item. Sempre `mcp_list_tools`. Valores possíveis: `mcp_list_tools`	Yes

OpenAI.OutputItemMcpToolCall

Uma invocação de uma ferramenta em um servidor MCP.

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
approval_request_id	cadeia de caracteres (anulável)		No
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta.	Yes
erro	cadeia de caracteres (anulável)		No
id	cadeia	A ID exclusiva da chamada de ferramenta.	Yes
nome	cadeia	O nome da ferramenta que foi executada.	Yes
saída	cadeia de caracteres (anulável)		No
response_id	cadeia	A resposta na qual o item é criado.	No
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que executa a ferramenta.	Yes
status	OpenAI.MCPToolCallStatus		No
tipo	enumeração	O tipo do item. Sempre `mcp_call`. Valores possíveis: `mcp_call`	Yes

OpenAI.OutputItemOutputMessage

Uma mensagem de saída do modelo.

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
conteúdo	matriz de OpenAI.OutputMessageContent	O conteúdo da mensagem de saída.	Yes
id	cadeia	A identificação única da mensagem de saída.	Yes
response_id	cadeia	A resposta na qual o item é criado.	No
função	enumeração	A função da mensagem de saída. Sempre `assistant`. Valores possíveis: `assistant`	Yes
status	enumeração	O status da entrada da mensagem. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens de entrada são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	O tipo da mensagem de saída. Sempre `message`. Valores possíveis: `output_message`	Yes

OpenAI.OutputItemReasoningItem

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
conteúdo	matriz de OpenAI.ReasoningTextContent	Conteúdo de texto de raciocínio.	No
encrypted_content	cadeia de caracteres (anulável)		No
id	cadeia	O identificador exclusivo do conteúdo de raciocínio.	Yes
response_id	cadeia	A resposta na qual o item é criado.	No
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
resumo	matriz de OpenAI.Summary	Conteúdo de resumo de raciocínio.	Yes
tipo	enumeração	O tipo do objeto. Sempre `reasoning`. Valores possíveis: `reasoning`	Yes

OpenAI.OutputItemType

Property Valor

Type cadeia

Valores output_message
file_search_call
function_call
web_search_call
computer_call
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_call
mcp_list_tools
mcp_approval_request
custom_tool_call
structured_outputs
oauth_consent_request
memory_search_call
workflow_action

OpenAI.OutputItemWebSearchToolCall

Os resultados de uma chamada de ferramenta de pesquisa na Web. Consulte o guia de pesquisa na Web para obter mais informações.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.WebSearchActionSearch ou OpenAI.WebSearchActionOpenPage ou OpenAI.WebSearchActionFind	Um objeto que descreve a ação específica executada nesta chamada de pesquisa na Web. Inclui detalhes sobre como o modelo usou a Web (pesquisa, open_page, localizar).	Yes
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
id	cadeia	A ID exclusiva da chamada da ferramenta de pesquisa na Web.	Yes
response_id	cadeia	A resposta na qual o item é criado.	No
status	enumeração	O status da chamada da ferramenta de pesquisa na Web. Valores possíveis: `in_progress`, , `searching`, `completedfailed`	Yes
tipo	enumeração	O tipo da chamada da ferramenta de pesquisa na Web. Sempre `web_search_call`. Valores possíveis: `web_search_call`	Yes

OpenAI.OutputMessageContent

Discriminador para OpenAI.OutputMessageContent

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

Digite um valor	Schema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.OutputMessageContentType		Yes

OpenAI.OutputMessageContentOutputTextContent

Uma saída de texto do modelo.

Nome	Tipo	Description	Obrigatório
annotations	matriz de OpenAI.Annotation	As anotações da saída de texto.	Yes
logprobs	matriz de OpenAI.LogProb		No
enviar SMS	cadeia	A saída de texto do modelo.	Yes
tipo	enumeração	O tipo do texto de saída. Sempre `output_text`. Valores possíveis: `output_text`	Yes

OpenAI.OutputMessageContentRefusalContent

Uma recusa do modelo.

Nome	Tipo	Description	Obrigatório	Default
Recusa	cadeia	A explicação da recusa do modelo.	Yes
tipo	enumeração	O tipo da recusa. Sempre `refusal`. Valores possíveis: `refusal`	Yes

OpenAI.OutputMessageContentType

Property	Valor
Type	cadeia
Valores	`output_text` `refusal`

OpenAI.Prompt

Referência a um modelo de prompt e suas variáveis. Saiba mais.

Nome	Tipo	Description	Obrigatório
id	cadeia	O identificador exclusivo do modelo de prompt a ser usado.	Yes
variables	OpenAI.ResponsePromptVariables (anulável)	Mapa opcional de valores a serem substituídos por variáveis no seu solicitação. Os valores de substituição podem ser cadeias de caracteres ou outros Tipos de entrada de resposta, como imagens ou arquivos.	No
versão	cadeia de caracteres (anulável)		No

OpenAI.RankerVersionType

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

OpenAI.RankingOptions

Nome	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

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

Nome	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	enumeração	Valores possíveis: `auto`, , `concisedetailed`	No
resumo	enumeração	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. A redução do 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
Type	cadeia
Nulável	Yes
Valores	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

Texto de raciocínio do modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	O texto de raciocínio do modelo.	Yes
tipo	enumeração	O tipo do texto de raciocínio. Sempre `reasoning_text`. Valores possíveis: `reasoning_text`	Yes

OpenAI.Response

Nome	Tipo	Description	Obrigatório	Default
agent_reference	AgentReference (anulável)		Yes
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
em segundo plano	booliano (anulável)		No
concluído_em	inteiro		No
conversa	OpenAI.ConversationReference (anulável)	A conversa à qual essa resposta pertencia. Itens de entrada e itens de saída dessa resposta foram adicionados automaticamente a essa conversa.	No
└─ id	cadeia	A ID exclusiva da conversa à qual essa resposta foi associada.	Yes
criado_em	inteiro	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Yes
erro	OpenAI.ResponseError (anulável)	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Yes
└─ código	OpenAI.ResponseErrorCode	O código de erro da resposta.	Yes
Mensagem └─	cadeia	Uma descrição legível pelo humano do erro.	Yes
id	cadeia	Identificador exclusivo para esta resposta.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails (anulável)		Yes
└─ motivo	enumeração	Valores possíveis: `max_output_tokens`, `content_filter`	No
instructions	cadeia de caracteres ou matriz de OpenAI.InputItem		Yes
max_output_tokens	OpenAI.integer (anulável)		No
max_tool_calls	OpenAI.integer (anulável)		No
metadados	OpenAI.Metadata (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.	No
modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	No
objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Yes
saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Yes
output_text	cadeia de caracteres (anulável)		No
parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Yes	Verdade
previous_response_id	cadeia de caracteres (anulável)		No
solicitação	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis. Saiba mais.	No
prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo. Saiba mais.	No
prompt_cache_retention	enumeração	Valores possíveis: `in-memory`, `24h`	No
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	enumeração	Valores possíveis: `auto`, , `concisedetailed`	No
└─ resumo	enumeração	Valores possíveis: `auto`, , `concisedetailed`	No
safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. As IDs devem ser uma cadeia de caracteres que identifique exclusivamente cada usuário. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Saiba mais.	No
nível de serviço	OpenAI.ServiceTier	Especifica o tipo de processamento usado para atender à solicitação. - Se definido como 'automático', a solicitação será processada com a camada de serviço configurada nas configurações de Project. A menos que esteja configurado de outra forma, o Project usará "padrão". - Se definido como 'padrão', a solicitação será processada com o preço padrão e o desempenho do modelo selecionado. - Se definido como 'flex' ou 'priority', a solicitação será processada com a camada de serviço correspondente. - Quando não definido, o comportamento padrão é 'auto'. Quando o `service_tier` parâmetro for definido, o corpo da resposta incluirá o `service_tier` valor com base no modo de processamento realmente usado para atender à solicitação. Esse valor de resposta pode ser diferente do valor definido no parâmetro.	No
status	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
Temperatura	OpenAI.numeric (anulável )		No	1
enviar SMS	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas estruturadas	No
tool_choice	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivo. Saiba mais sobre ferramentas internas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas do MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre chamada de função. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
top_logprobs	OpenAI.integer (anulável)		No
top_p	OpenAI.numeric (anulável )		No	1
truncation	enumeração	Valores possíveis: `auto`, `disabled`	No
uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos. Saiba mais.	No

OpenAI.ResponseAudioDeltaEvent

Emitido quando há uma resposta de áudio parcial.

Nome	Tipo	Description	Obrigatório
delta	cadeia	Uma parte dos bytes de áudio de resposta codificados em Base64.	Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.audio.delta`. Valores possíveis: `response.audio.delta`	Yes

OpenAI.ResponseAudioDoneEvent

Emitido quando a resposta de áudio é concluída.

Nome	Tipo	Description	Obrigatório	Default
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.audio.done`. Valores possíveis: `response.audio.done`	Yes

OpenAI.ResponseAudioTranscriptDeltaEvent

Emitido quando há uma transcrição parcial do áudio.

Nome	Tipo	Description	Obrigatório
delta	cadeia	A transcrição parcial da resposta de áudio.	Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.audio.transcript.delta`. Valores possíveis: `response.audio.transcript.delta`	Yes

OpenAI.ResponseAudioTranscriptDoneEvent

Emitido quando a transcrição de áudio completa é concluída.

Nome	Tipo	Description	Obrigatório	Default
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.audio.transcript.done`. Valores possíveis: `response.audio.transcript.done`	Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Emitido quando um snippet de código parcial é transmitido pelo interpretador de código.

Nome	Tipo	Description	Obrigatório
delta	cadeia	O snippet de código parcial que está sendo transmitido pelo interpretador de código.	Yes
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretador de código.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.code_interpreter_call_code.delta`. Valores possíveis: `response.code_interpreter_call_code.delta`	Yes

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Emitido quando o snippet de código é finalizado pelo interpretador de código.

Nome	Tipo	Description	Obrigatório
codificar	cadeia	A saída final do snippet de código pelo intérprete de código.	Yes
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretador de código.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.code_interpreter_call_code.done`. Valores possíveis: `response.code_interpreter_call_code.done`	Yes

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Emitido quando a chamada do interpretador de código é concluída.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretador de código.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.code_interpreter_call.completed`. Valores possíveis: `response.code_interpreter_call.completed`	Yes

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Emitido quando uma chamada de interpretador de código está em andamento.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretador de código.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.code_interpreter_call.in_progress`. Valores possíveis: `response.code_interpreter_call.in_progress`	Yes

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Emitido quando o interpretador de código está interpretando ativamente o snippet de código.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretador de código.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.code_interpreter_call.interpreting`. Valores possíveis: `response.code_interpreter_call.interpreting`	Yes

OpenAI.ResponseCompletedEvent

Emitido quando a resposta do modelo é concluída.

Nome	Tipo	Description	Obrigatório	Default
Resposta	OpenAI.Response		Yes
└─ agent_reference	AgentReference (anulável)	O agente usado para essa resposta	Yes
└─ plano de fundo	booliano (anulável)		No
└─ completed_at	inteiro (anulável)		No
└─ conversa	OpenAI.ConversationReference (anulável)	A conversa à qual essa resposta pertencia. Itens de entrada e itens de saída dessa resposta foram adicionados automaticamente a essa conversa.	No
└─ created_at	inteiro	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Yes
└─ erro	OpenAI.ResponseError (anulável)	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Yes
└─ id	cadeia	Identificador exclusivo para esta resposta.	Yes
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails (anulável)		Yes
└─ instruções	cadeia de caracteres ou matriz de OpenAI.InputItem (anulável)		Yes
└─ max_output_tokens (número máximo de tokens de saída)	OpenAI.integer (anulável)		No
└─ max_tool_calls	OpenAI.integer (anulável)		No
└─ metadados	OpenAI.Metadata (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.	No
└─ modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	No
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Yes
└─ saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Yes
└─ texto_de_saida	cadeia de caracteres (anulável)		No
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Yes	Verdade
└─ ID_de_resposta_anterior	cadeia de caracteres (anulável)		No
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis. Saiba mais.	No
└─ prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo. Saiba mais.	No
└─ prompt_cache_retention	enumeração	Valores possíveis: `in-memory`, `24h`	No
└─ raciocínio	OpenAI.Reasoning (anulável)	somente modelos gpt-5 e série o Opções de configuração para modelos de raciocínio.	No
└─ safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. As IDs devem ser uma cadeia de caracteres que identifique exclusivamente cada usuário. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Saiba mais.	No
└─ service_tier	OpenAI.ServiceTier	Especifica o tipo de processamento usado para atender à solicitação. - Se definido como 'automático', a solicitação será processada com a camada de serviço configurada nas configurações de Project. A menos que esteja configurado de outra forma, o Project usará "padrão". - Se definido como 'padrão', a solicitação será processada com o preço padrão e o desempenho do modelo selecionado. - Se definido como 'flex' ou 'priority', a solicitação será processada com a camada de serviço correspondente. - Quando não definido, o comportamento padrão é 'auto'. Quando o `service_tier` parâmetro for definido, o corpo da resposta incluirá o `service_tier` valor com base no modo de processamento realmente usado para atender à solicitação. Esse valor de resposta pode ser diferente do valor definido no parâmetro.	No
└─ estado	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatura	OpenAI.numeric (anulável )		No	1
└─ texto	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas estruturadas	No
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
└─ ferramentas	OpenAI.ToolsArray	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivo. Saiba mais sobre ferramentas internas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas do MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre chamada de função. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
└─ top_logprobs	OpenAI.integer (anulável)		No
└─ top_p	OpenAI.numeric (anulável )		No	1
└─ truncamento	enumeração	Valores possíveis: `auto`, `disabled`	No
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos. Saiba mais.	No
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.completed`. Valores possíveis: `response.completed`	Yes

OpenAI.ResponseContentPartAddedEvent

Emitido quando uma nova parte de conteúdo é adicionada.

Nome	Tipo	Description	Obrigatório
content_index	OpenAI.integer		Yes
item_id	cadeia	A ID do item de saída ao qual a parte de conteúdo foi adicionada.	Yes
output_index	OpenAI.integer		Yes
part	OpenAI.OutputContent		Yes
└─ tipo	OpenAI.OutputContentType		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.content_part.added`. Valores possíveis: `response.content_part.added`	Yes

OpenAI.ResponseContentPartDoneEvent

Emitido quando uma parte do conteúdo é concluída.

Nome	Tipo	Description	Obrigatório
content_index	OpenAI.integer		Yes
item_id	cadeia	A ID do item de saída ao qual a parte de conteúdo foi adicionada.	Yes
output_index	OpenAI.integer		Yes
part	OpenAI.OutputContent		Yes
└─ tipo	OpenAI.OutputContentType		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.content_part.done`. Valores possíveis: `response.content_part.done`	Yes

OpenAI.ResponseCreatedEvent

Um evento emitido quando uma resposta é criada.

Nome	Tipo	Description	Obrigatório	Default
Resposta	OpenAI.Response		Yes
└─ agent_reference	AgentReference (anulável)	O agente usado para essa resposta	Yes
└─ plano de fundo	booliano (anulável)		No
└─ completed_at	inteiro (anulável)		No
└─ conversa	OpenAI.ConversationReference (anulável)	A conversa à qual essa resposta pertencia. Itens de entrada e itens de saída dessa resposta foram adicionados automaticamente a essa conversa.	No
└─ created_at	inteiro	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Yes
└─ erro	OpenAI.ResponseError (anulável)	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Yes
└─ id	cadeia	Identificador exclusivo para esta resposta.	Yes
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails (anulável)		Yes
└─ instruções	cadeia de caracteres ou matriz de OpenAI.InputItem (anulável)		Yes
└─ max_output_tokens (número máximo de tokens de saída)	OpenAI.integer (anulável)		No
└─ max_tool_calls	OpenAI.integer (anulável)		No
└─ metadados	OpenAI.Metadata (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.	No
└─ modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	No
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Yes
└─ saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Yes
└─ texto_de_saida	cadeia de caracteres (anulável)		No
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Yes	Verdade
└─ ID_de_resposta_anterior	cadeia de caracteres (anulável)		No
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis. Saiba mais.	No
└─ prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo. Saiba mais.	No
└─ prompt_cache_retention	enumeração	Valores possíveis: `in-memory`, `24h`	No
└─ raciocínio	OpenAI.Reasoning (anulável)	somente modelos gpt-5 e série o Opções de configuração para modelos de raciocínio.	No
└─ safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. As IDs devem ser uma cadeia de caracteres que identifique exclusivamente cada usuário. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Saiba mais.	No
└─ service_tier	OpenAI.ServiceTier	Especifica o tipo de processamento usado para atender à solicitação. - Se definido como 'automático', a solicitação será processada com a camada de serviço configurada nas configurações de Project. A menos que esteja configurado de outra forma, o Project usará "padrão". - Se definido como 'padrão', a solicitação será processada com o preço padrão e o desempenho do modelo selecionado. - Se definido como 'flex' ou 'priority', a solicitação será processada com a camada de serviço correspondente. - Quando não definido, o comportamento padrão é 'auto'. Quando o `service_tier` parâmetro for definido, o corpo da resposta incluirá o `service_tier` valor com base no modo de processamento realmente usado para atender à solicitação. Esse valor de resposta pode ser diferente do valor definido no parâmetro.	No
└─ estado	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatura	OpenAI.numeric (anulável )		No	1
└─ texto	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas estruturadas	No
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
└─ ferramentas	OpenAI.ToolsArray	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivo. Saiba mais sobre ferramentas internas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas do MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre chamada de função. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
└─ top_logprobs	OpenAI.integer (anulável)		No
└─ top_p	OpenAI.numeric (anulável )		No	1
└─ truncamento	enumeração	Valores possíveis: `auto`, `disabled`	No
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos. Saiba mais.	No
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.created`. Valores possíveis: `response.created`	Yes

OpenAI.ResponseCustomToolCallInputDeltaEvent

Evento que representa um delta (atualização parcial) para a entrada de uma chamada de ferramenta personalizada.

Nome	Tipo	Description	Obrigatório
delta	cadeia	Os dados de entrada incrementais (delta) para a chamada de ferramenta personalizada.	Yes
item_id	cadeia	Identificador exclusivo para o item de API associado a esse evento.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O identificador de tipo de evento. Valores possíveis: `response.custom_tool_call_input.delta`	Yes

OpenAI.ResponseCustomToolCallInputDoneEvent

Evento que indica que a entrada para uma chamada de ferramenta personalizada está concluída.

Nome	Tipo	Description	Obrigatório
entrada	cadeia	Os dados de entrada completos para a chamada de ferramenta personalizada.	Yes
item_id	cadeia	Identificador exclusivo para o item de API associado a esse evento.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O identificador de tipo de evento. Valores possíveis: `response.custom_tool_call_input.done`	Yes

OpenAI.ResponseError

Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.

Nome	Tipo	Description	Obrigatório	Default
codificar	OpenAI.ResponseErrorCode	O código de erro da resposta.	Yes
mensagem	cadeia	Uma descrição legível pelo humano do erro.	Yes

OpenAI.ResponseErrorCode

O código de erro da resposta.

Property	Valor
Type	cadeia
Valores	`server_error` `rate_limit_exceeded` `invalid_prompt` `vector_store_timeout` `invalid_image` `invalid_image_format` `invalid_base64_image` `invalid_image_url` `image_too_large` `image_too_small` `image_parse_error` `image_content_policy_violation` `invalid_image_mode` `image_file_too_large` `unsupported_image_media_type` `empty_image_file` `failed_to_download_image` `image_file_not_found`

OpenAI.ResponseErrorEvent

Emitido quando ocorre um erro.

Nome	Tipo	Description	Obrigatório
codificar	cadeia de caracteres (anulável)		Yes
mensagem	cadeia	A mensagem de erro.	Yes
param	cadeia de caracteres (anulável)		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `error`. Valores possíveis: `error`	Yes

OpenAI.ResponseFailedEvent

Um evento emitido quando uma resposta falha.

Nome	Tipo	Description	Obrigatório	Default
Resposta	OpenAI.Response		Yes
└─ agent_reference	AgentReference (anulável)	O agente usado para essa resposta	Yes
└─ plano de fundo	booliano (anulável)		No
└─ completed_at	inteiro (anulável)		No
└─ conversa	OpenAI.ConversationReference (anulável)	A conversa à qual essa resposta pertencia. Itens de entrada e itens de saída dessa resposta foram adicionados automaticamente a essa conversa.	No
└─ created_at	inteiro	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Yes
└─ erro	OpenAI.ResponseError (anulável)	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Yes
└─ id	cadeia	Identificador exclusivo para esta resposta.	Yes
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails (anulável)		Yes
└─ instruções	cadeia de caracteres ou matriz de OpenAI.InputItem (anulável)		Yes
└─ max_output_tokens (número máximo de tokens de saída)	OpenAI.integer (anulável)		No
└─ max_tool_calls	OpenAI.integer (anulável)		No
└─ metadados	OpenAI.Metadata (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.	No
└─ modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	No
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Yes
└─ saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Yes
└─ texto_de_saida	cadeia de caracteres (anulável)		No
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Yes	Verdade
└─ ID_de_resposta_anterior	cadeia de caracteres (anulável)		No
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis. Saiba mais.	No
└─ prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo. Saiba mais.	No
└─ prompt_cache_retention	enumeração	Valores possíveis: `in-memory`, `24h`	No
└─ raciocínio	OpenAI.Reasoning (anulável)	somente modelos gpt-5 e série o Opções de configuração para modelos de raciocínio.	No
└─ safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. As IDs devem ser uma cadeia de caracteres que identifique exclusivamente cada usuário. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Saiba mais.	No
└─ service_tier	OpenAI.ServiceTier	Especifica o tipo de processamento usado para atender à solicitação. - Se definido como 'automático', a solicitação será processada com a camada de serviço configurada nas configurações de Project. A menos que esteja configurado de outra forma, o Project usará "padrão". - Se definido como 'padrão', a solicitação será processada com o preço padrão e o desempenho do modelo selecionado. - Se definido como 'flex' ou 'priority', a solicitação será processada com a camada de serviço correspondente. - Quando não definido, o comportamento padrão é 'auto'. Quando o `service_tier` parâmetro for definido, o corpo da resposta incluirá o `service_tier` valor com base no modo de processamento realmente usado para atender à solicitação. Esse valor de resposta pode ser diferente do valor definido no parâmetro.	No
└─ estado	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatura	OpenAI.numeric (anulável )		No	1
└─ texto	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas estruturadas	No
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
└─ ferramentas	OpenAI.ToolsArray	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivo. Saiba mais sobre ferramentas internas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas do MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre chamada de função. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
└─ top_logprobs	OpenAI.integer (anulável)		No
└─ top_p	OpenAI.numeric (anulável )		No	1
└─ truncamento	enumeração	Valores possíveis: `auto`, `disabled`	No
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos. Saiba mais.	No
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.failed`. Valores possíveis: `response.failed`	Yes

OpenAI.ResponseFileSearchCallCompletedEvent

Emitido quando uma chamada de pesquisa de arquivo é concluída (resultados encontrados).

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item de saída que a chamada de pesquisa de arquivo é iniciada.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.file_search_call.completed`. Valores possíveis: `response.file_search_call.completed`	Yes

OpenAI.ResponseFileSearchCallInProgressEvent

Emitido quando uma chamada de pesquisa de arquivo é iniciada.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item de saída que a chamada de pesquisa de arquivo é iniciada.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.file_search_call.in_progress`. Valores possíveis: `response.file_search_call.in_progress`	Yes

OpenAI.ResponseFileSearchCallSearchingEvent

Emitido quando uma pesquisa de arquivo está em andamento.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item de saída que a chamada de pesquisa de arquivo é iniciada.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.file_search_call.searching`. Valores possíveis: `response.file_search_call.searching`	Yes

OpenAI.ResponseFormatJsonObject

Nome	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.ResponseFormatJsonSchema

Formato de resposta de esquema JSON. Usado para gerar respostas JSON estruturadas. Saiba mais sobre saídas estruturadas.

Nome	Tipo	Description	Obrigatório
json_schema	OpenAI.ResponseFormatJsonSchemaJsonSchema		Yes
└─ descrição	cadeia		No
└─ nome	cadeia		Yes
└─ esquema	OpenAI.ResponseFormatJsonSchemaSchema	O esquema para o formato de resposta, descrito como um objeto de esquema JSON. Saiba como criar esquemas JSON aqui.	No
└─ 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.ResponseFormatJsonSchemaJsonSchema

Nome	Tipo	Description	Obrigatório
description	cadeia		No
nome	cadeia		Yes
esquema	OpenAI.ResponseFormatJsonSchemaSchema	O esquema para o formato de resposta, descrito como um objeto de esquema JSON. Saiba como criar esquemas JSON aqui.	No
rigoroso	booliano (anulável)		No

OpenAI.ResponseFormatJsonSchemaSchema

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

Tipo: objeto

OpenAI.ResponseFormatText

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

Nome	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.ResponseFunctionCallArgumentsDeltaEvent

Emitido quando há um delta de argumentos parciais de chamada de função.

Nome	Tipo	Description	Obrigatório
delta	cadeia	O delta de argumentos de chamada de função que é adicionado.	Yes
item_id	cadeia	A ID do item de saída ao qual o delta de argumentos de chamada de função é adicionado.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.function_call_arguments.delta`. Valores possíveis: `response.function_call_arguments.delta`	Yes

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Emitido quando os argumentos de chamada de função são finalizados.

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Os argumentos de chamada de função.	Yes
item_id	cadeia	O ID do item.	Yes
nome	cadeia	O nome da função que foi chamada.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	Valores possíveis: `response.function_call_arguments.done`	Yes

OpenAI.ResponseImageGenCallCompletedEvent

Emitido quando uma chamada de ferramenta de geração de imagem é concluída e a imagem final está disponível.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	O identificador exclusivo do item de geração de imagem que está sendo processado.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre 'response.image_generation_call.completed'. Valores possíveis: `response.image_generation_call.completed`	Yes

OpenAI.ResponseImageGenCallGeneratingEvent

Emitido quando uma chamada de ferramenta de geração de imagem está gerando ativamente uma imagem (estado intermediário).

Nome	Tipo	Description	Obrigatório
item_id	cadeia	O identificador exclusivo do item de geração de imagem que está sendo processado.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre "response.image_generation_call.generating". Valores possíveis: `response.image_generation_call.generating`	Yes

OpenAI.ResponseImageGenCallInProgressEvent

Emitido quando uma chamada de ferramenta de geração de imagem está em andamento.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	O identificador exclusivo do item de geração de imagem que está sendo processado.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Use 'response.image_generation_call.in_progress' sempre. Valores possíveis: `response.image_generation_call.in_progress`	Yes

OpenAI.ResponseImageGenCallPartialImageEvent

Emitido quando uma imagem parcial está disponível durante o streaming de geração de imagem.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	O identificador exclusivo do item de geração de imagem que está sendo processado.	Yes
output_index	OpenAI.integer		Yes
partial_image_b64	cadeia	Dados de imagem parciais codificados em Base64, adequados para renderização como uma imagem.	Yes
partial_image_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre 'response.image_generation_call.partial_image'. Valores possíveis: `response.image_generation_call.partial_image`	Yes

OpenAI.ResponseInProgressEvent

Emitido quando a resposta está em andamento.

Nome	Tipo	Description	Obrigatório	Default
Resposta	OpenAI.Response		Yes
└─ agent_reference	AgentReference (anulável)	O agente usado para essa resposta	Yes
└─ plano de fundo	booliano (anulável)		No
└─ completed_at	inteiro (anulável)		No
└─ conversa	OpenAI.ConversationReference (anulável)	A conversa à qual essa resposta pertencia. Itens de entrada e itens de saída dessa resposta foram adicionados automaticamente a essa conversa.	No
└─ created_at	inteiro	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Yes
└─ erro	OpenAI.ResponseError (anulável)	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Yes
└─ id	cadeia	Identificador exclusivo para esta resposta.	Yes
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails (anulável)		Yes
└─ instruções	cadeia de caracteres ou matriz de OpenAI.InputItem (anulável)		Yes
└─ max_output_tokens (número máximo de tokens de saída)	OpenAI.integer (anulável)		No
└─ max_tool_calls	OpenAI.integer (anulável)		No
└─ metadados	OpenAI.Metadata (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.	No
└─ modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	No
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Yes
└─ saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Yes
└─ texto_de_saida	cadeia de caracteres (anulável)		No
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Yes	Verdade
└─ ID_de_resposta_anterior	cadeia de caracteres (anulável)		No
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis. Saiba mais.	No
└─ prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo. Saiba mais.	No
└─ prompt_cache_retention	enumeração	Valores possíveis: `in-memory`, `24h`	No
└─ raciocínio	OpenAI.Reasoning (anulável)	somente modelos gpt-5 e série o Opções de configuração para modelos de raciocínio.	No
└─ safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. As IDs devem ser uma cadeia de caracteres que identifique exclusivamente cada usuário. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Saiba mais.	No
└─ service_tier	OpenAI.ServiceTier	Especifica o tipo de processamento usado para atender à solicitação. - Se definido como 'automático', a solicitação será processada com a camada de serviço configurada nas configurações de Project. A menos que esteja configurado de outra forma, o Project usará "padrão". - Se definido como 'padrão', a solicitação será processada com o preço padrão e o desempenho do modelo selecionado. - Se definido como 'flex' ou 'priority', a solicitação será processada com a camada de serviço correspondente. - Quando não definido, o comportamento padrão é 'auto'. Quando o `service_tier` parâmetro for definido, o corpo da resposta incluirá o `service_tier` valor com base no modo de processamento realmente usado para atender à solicitação. Esse valor de resposta pode ser diferente do valor definido no parâmetro.	No
└─ estado	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatura	OpenAI.numeric (anulável )		No	1
└─ texto	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas estruturadas	No
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
└─ ferramentas	OpenAI.ToolsArray	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivo. Saiba mais sobre ferramentas internas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas do MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre chamada de função. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
└─ top_logprobs	OpenAI.integer (anulável)		No
└─ top_p	OpenAI.numeric (anulável )		No	1
└─ truncamento	enumeração	Valores possíveis: `auto`, `disabled`	No
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos. Saiba mais.	No
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.in_progress`. Valores possíveis: `response.in_progress`	Yes

OpenAI.ResponseIncompleteDetails

Nome	Tipo	Description	Obrigatório	Default
reason	enumeração	Valores possíveis: `max_output_tokens`, `content_filter`	No

OpenAI.ResponseIncompleteEvent

Um evento emitido quando uma resposta é concluída como incompleta.

Nome	Tipo	Description	Obrigatório	Default
Resposta	OpenAI.Response		Yes
└─ agent_reference	AgentReference (anulável)	O agente usado para essa resposta	Yes
└─ plano de fundo	booliano (anulável)		No
└─ completed_at	inteiro (anulável)		No
└─ conversa	OpenAI.ConversationReference (anulável)	A conversa à qual essa resposta pertencia. Itens de entrada e itens de saída dessa resposta foram adicionados automaticamente a essa conversa.	No
└─ created_at	inteiro	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Yes
└─ erro	OpenAI.ResponseError (anulável)	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Yes
└─ id	cadeia	Identificador exclusivo para esta resposta.	Yes
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails (anulável)		Yes
└─ instruções	cadeia de caracteres ou matriz de OpenAI.InputItem (anulável)		Yes
└─ max_output_tokens (número máximo de tokens de saída)	OpenAI.integer (anulável)		No
└─ max_tool_calls	OpenAI.integer (anulável)		No
└─ metadados	OpenAI.Metadata (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.	No
└─ modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	No
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Yes
└─ saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Yes
└─ texto_de_saida	cadeia de caracteres (anulável)		No
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Yes	Verdade
└─ ID_de_resposta_anterior	cadeia de caracteres (anulável)		No
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis. Saiba mais.	No
└─ prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo. Saiba mais.	No
└─ prompt_cache_retention	enumeração	Valores possíveis: `in-memory`, `24h`	No
└─ raciocínio	OpenAI.Reasoning (anulável)	somente modelos gpt-5 e série o Opções de configuração para modelos de raciocínio.	No
└─ safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. As IDs devem ser uma cadeia de caracteres que identifique exclusivamente cada usuário. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Saiba mais.	No
└─ service_tier	OpenAI.ServiceTier	Especifica o tipo de processamento usado para atender à solicitação. - Se definido como 'automático', a solicitação será processada com a camada de serviço configurada nas configurações de Project. A menos que esteja configurado de outra forma, o Project usará "padrão". - Se definido como 'padrão', a solicitação será processada com o preço padrão e o desempenho do modelo selecionado. - Se definido como 'flex' ou 'priority', a solicitação será processada com a camada de serviço correspondente. - Quando não definido, o comportamento padrão é 'auto'. Quando o `service_tier` parâmetro for definido, o corpo da resposta incluirá o `service_tier` valor com base no modo de processamento realmente usado para atender à solicitação. Esse valor de resposta pode ser diferente do valor definido no parâmetro.	No
└─ estado	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatura	OpenAI.numeric (anulável )		No	1
└─ texto	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas estruturadas	No
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
└─ ferramentas	OpenAI.ToolsArray	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivo. Saiba mais sobre ferramentas internas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas do MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre chamada de função. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
└─ top_logprobs	OpenAI.integer (anulável)		No
└─ top_p	OpenAI.numeric (anulável )		No	1
└─ truncamento	enumeração	Valores possíveis: `auto`, `disabled`	No
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos. Saiba mais.	No
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.incomplete`. Valores possíveis: `response.incomplete`	Yes

OpenAI.ResponseLogProb

Um logprob é a probabilidade logarítmica que o modelo atribui à produção de um token específico em uma determinada posição na sequência. Valores de logprob menos negativos (superiores) indicam maior confiança do modelo nessa opção de token.

Nome	Tipo	Description	Obrigatório
logprob	OpenAI.numeric		Yes
símbolo	cadeia	Um possível token de texto.	Yes
top_logprobs	matriz de OpenAI.ResponseLogProbTopLogprobs	A probabilidade de log dos 20 tokens mais prováveis.	No

OpenAI.ResponseLogProbTopLogprobs

Nome	Tipo	Description	Obrigatório	Default
logprob	OpenAI.numeric		No
símbolo	cadeia		No

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Emitido quando há um delta (atualização parcial) para os argumentos de uma chamada de ferramenta MCP.

Nome	Tipo	Description	Obrigatório
delta	cadeia	Uma cadeia de caracteres JSON que contém a atualização parcial para os argumentos da chamada da ferramenta MCP.	Yes
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre "response.mcp_call_arguments.delta". Valores possíveis: `response.mcp_call_arguments.delta`	Yes

OpenAI.ResponseMCPCallArgumentsDoneEvent

Emitido quando os argumentos de uma chamada de ferramenta MCP são finalizados.

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma cadeia de caracteres JSON que contém os argumentos finalizados para a chamada da ferramenta MCP.	Yes
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call_arguments.concluído'. Valores possíveis: `response.mcp_call_arguments.done`	Yes

OpenAI.ResponseMCPCallCompletedEvent

Emitido quando uma chamada de ferramenta MCP é concluída com êxito.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item de chamada da ferramenta MCP que foi concluído.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call.concluído'. Valores possíveis: `response.mcp_call.completed`	Yes

OpenAI.ResponseMCPCallFailedEvent

Emitido quando uma chamada de ferramenta MCP falha.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item de chamada da ferramenta MCP que falhou.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call.falhou'. Valores possíveis: `response.mcp_call.failed`	Yes

OpenAI.ResponseMCPCallInProgressEvent

Emitido quando uma chamada de ferramenta MCP está em andamento.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. O estado sempre é 'response.mcp_call.in_progress'. Valores possíveis: `response.mcp_call.in_progress`	Yes

OpenAI.ResponseMCPListToolsCompletedEvent

Emitido quando a lista de ferramentas MCP disponíveis foi recuperada com êxito.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item de chamada da ferramenta MCP que produziu essa saída.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_list_tools.completed'. Valores possíveis: `response.mcp_list_tools.completed`	Yes

OpenAI.ResponseMCPListToolsFailedEvent

Emitido quando a tentativa de listar as ferramentas MCP disponíveis falhou.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item de chamada da ferramenta MCP que falhou.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_list_tools.falhou'. Valores possíveis: `response.mcp_list_tools.failed`	Yes

OpenAI.ResponseMCPListToolsInProgressEvent

Emitido quando o sistema está no processo de recuperação da lista de ferramentas MCP disponíveis.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item de chamada da ferramenta MCP que está sendo processado.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_list_tools.in_progress'. Valores possíveis: `response.mcp_list_tools.in_progress`	Yes

OpenAI.ResponseOutputItemAddedEvent

Emitido quando um novo item de saída é adicionado.

Nome	Tipo	Description	Obrigatório
item	OpenAI.OutputItem		Yes
└─ agent_reference	AgentReference	O agente que criou o item.	No
└─ response_id	cadeia	A resposta na qual o item é criado.	No
└─ tipo	OpenAI.OutputItemType		Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.output_item.added`. Valores possíveis: `response.output_item.added`	Yes

OpenAI.ResponseOutputItemDoneEvent

Emitido quando um item de saída é marcado como concluído.

Nome	Tipo	Description	Obrigatório
item	OpenAI.OutputItem		Yes
└─ agent_reference	AgentReference	O agente que criou o item.	No
└─ response_id	cadeia	A resposta na qual o item é criado.	No
└─ tipo	OpenAI.OutputItemType		Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.output_item.done`. Valores possíveis: `response.output_item.done`	Yes

OpenAI.ResponseOutputTextAnnotationAddedEvent

Emitido quando uma anotação é adicionada ao conteúdo de texto de saída.

Nome	Tipo	Description	Obrigatório
anotação	OpenAI.Annotation	Uma anotação que se aplica a um intervalo de texto de saída.	Yes
└─ tipo	OpenAI.AnnotationType		Yes
annotation_index	OpenAI.integer		Yes
content_index	OpenAI.integer		Yes
item_id	cadeia	O identificador exclusivo do item ao qual a anotação está sendo adicionada.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre 'response.output_text.annotation.added'. Valores possíveis: `response.output_text.annotation.added`	Yes

OpenAI.ResponsePromptVariables

Mapa opcional de valores a serem substituídos por variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros tipos de entrada de resposta, como imagens ou arquivos.

Tipo: objeto

OpenAI.ResponseQueuedEvent

Emitido quando uma resposta é enfileirada e aguardando para ser processada.

Nome	Tipo	Description	Obrigatório	Default
Resposta	OpenAI.Response		Yes
└─ agent_reference	AgentReference (anulável)	O agente usado para essa resposta	Yes
└─ plano de fundo	booliano (anulável)		No
└─ completed_at	inteiro (anulável)		No
└─ conversa	OpenAI.ConversationReference (anulável)	A conversa à qual essa resposta pertencia. Itens de entrada e itens de saída dessa resposta foram adicionados automaticamente a essa conversa.	No
└─ created_at	inteiro	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Yes
└─ erro	OpenAI.ResponseError (anulável)	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Yes
└─ id	cadeia	Identificador exclusivo para esta resposta.	Yes
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails (anulável)		Yes
└─ instruções	cadeia de caracteres ou matriz de OpenAI.InputItem (anulável)		Yes
└─ max_output_tokens (número máximo de tokens de saída)	OpenAI.integer (anulável)		No
└─ max_tool_calls	OpenAI.integer (anulável)		No
└─ metadados	OpenAI.Metadata (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.	No
└─ modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	No
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Yes
└─ saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Yes
└─ texto_de_saida	cadeia de caracteres (anulável)		No
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Yes	Verdade
└─ ID_de_resposta_anterior	cadeia de caracteres (anulável)		No
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis. Saiba mais.	No
└─ prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo. Saiba mais.	No
└─ prompt_cache_retention	enumeração	Valores possíveis: `in-memory`, `24h`	No
└─ raciocínio	OpenAI.Reasoning (anulável)	somente modelos gpt-5 e série o Opções de configuração para modelos de raciocínio.	No
└─ safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. As IDs devem ser uma cadeia de caracteres que identifique exclusivamente cada usuário. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Saiba mais.	No
└─ service_tier	OpenAI.ServiceTier	Especifica o tipo de processamento usado para atender à solicitação. - Se definido como 'automático', a solicitação será processada com a camada de serviço configurada nas configurações de Project. A menos que esteja configurado de outra forma, o Project usará "padrão". - Se definido como 'padrão', a solicitação será processada com o preço padrão e o desempenho do modelo selecionado. - Se definido como 'flex' ou 'priority', a solicitação será processada com a camada de serviço correspondente. - Quando não definido, o comportamento padrão é 'auto'. Quando o `service_tier` parâmetro for definido, o corpo da resposta incluirá o `service_tier` valor com base no modo de processamento realmente usado para atender à solicitação. Esse valor de resposta pode ser diferente do valor definido no parâmetro.	No
└─ estado	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatura	OpenAI.numeric (anulável )		No	1
└─ texto	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas estruturadas	No
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
└─ ferramentas	OpenAI.ToolsArray	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivo. Saiba mais sobre ferramentas internas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas do MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre chamada de função. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
└─ top_logprobs	OpenAI.integer (anulável)		No
└─ top_p	OpenAI.numeric (anulável )		No	1
└─ truncamento	enumeração	Valores possíveis: `auto`, `disabled`	No
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos. Saiba mais.	No
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre 'response.enfileirado'. Valores possíveis: `response.queued`	Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

Emitido quando uma nova parte de resumo de raciocínio é adicionada.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item à qual essa parte de resumo está associada.	Yes
output_index	OpenAI.integer		Yes
part	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Yes
└─ texto	cadeia		Yes
└─ tipo	enumeração	Valores possíveis: `summary_text`	Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_part.added`. Valores possíveis: `response.reasoning_summary_part.added`	Yes

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia		Yes
tipo	enumeração	Valores possíveis: `summary_text`	Yes

OpenAI.ResponseReasoningSummaryPartDoneEvent

Emitido quando uma parte do resumo do raciocínio é concluída.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item à qual essa parte de resumo está associada.	Yes
output_index	OpenAI.integer		Yes
part	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Yes
└─ texto	cadeia		Yes
└─ tipo	enumeração	Valores possíveis: `summary_text`	Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_part.done`. Valores possíveis: `response.reasoning_summary_part.done`	Yes

OpenAI.ResponseReasoningSummaryPartDoneEventPart

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia		Yes
tipo	enumeração	Valores possíveis: `summary_text`	Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Emitido quando um delta é adicionado a um texto de resumo lógico.

Nome	Tipo	Description	Obrigatório
delta	cadeia	O delta de texto que foi adicionado ao resumo.	Yes
item_id	cadeia	A ID do item ao qual este delta de texto de resumo está associado.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_text.delta`. Valores possíveis: `response.reasoning_summary_text.delta`	Yes

OpenAI.ResponseReasoningSummaryTextDoneEvent

Emitido quando um texto de resumo de raciocínio é concluído.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item ao qual este texto de resumo está associado.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
enviar SMS	cadeia	O texto completo do resumo do raciocínio concluído.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_text.done`. Valores possíveis: `response.reasoning_summary_text.done`	Yes

OpenAI.ResponseReasoningTextDeltaEvent

Emitido quando um delta é adicionado a um texto de raciocínio.

Nome	Tipo	Description	Obrigatório
content_index	OpenAI.integer		Yes
delta	cadeia	O delta de texto que foi adicionado ao conteúdo de raciocínio.	Yes
item_id	cadeia	A ID do item ao qual esse delta de texto de raciocínio está associado.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_text.delta`. Valores possíveis: `response.reasoning_text.delta`	Yes

OpenAI.ResponseReasoningTextDoneEvent

Emitido quando um texto de raciocínio é concluído.

Nome	Tipo	Description	Obrigatório
content_index	OpenAI.integer		Yes
item_id	cadeia	A ID do item ao qual esse texto de raciocínio está associado.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
enviar SMS	cadeia	O texto completo do conteúdo de raciocínio concluído.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_text.done`. Valores possíveis: `response.reasoning_text.done`	Yes

OpenAI.ResponseRefusalDeltaEvent

Emitido quando há um texto de recusa parcial.

Nome	Tipo	Description	Obrigatório
content_index	OpenAI.integer		Yes
delta	cadeia	O texto de recusa que é adicionado.	Yes
item_id	cadeia	A ID do item de saída ao qual o texto de recusa é adicionado.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.refusal.delta`. Valores possíveis: `response.refusal.delta`	Yes

OpenAI.ResponseRefusalDoneEvent

Emitido quando o texto de recusa é finalizado.

Nome	Tipo	Description	Obrigatório
content_index	OpenAI.integer		Yes
item_id	cadeia	A ID do item de saída em que o texto de recusa é finalizado.	Yes
output_index	OpenAI.integer		Yes
Recusa	cadeia	O texto finalizado de recusa.	Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.refusal.done`. Valores possíveis: `response.refusal.done`	Yes

OpenAI.ResponseStreamOptions

Opções para respostas de streaming. Defina isso somente quando você definir stream: true.

Nome	Tipo	Description	Obrigatório	Default
include_obfuscation	boolean	Quando true, a ofuscação de fluxo será habilitada. Adiciones de ofuscação de fluxo caracteres aleatórios para um `obfuscation` campo em eventos delta de streaming para normalize os tamanhos de carga como uma mitigação para determinados ataques de canal lateral. Esses campos de ofuscação são incluídos por padrão, mas adicionam uma pequena quantidade de sobrecarga para o fluxo de dados. Você pode definir `include_obfuscation` como false para otimizar para largura de banda se você confiar nos links de rede entre seu aplicativo e a API OpenAI.	No

OpenAI.ResponseTextDeltaEvent

Emitido quando há um delta de texto adicional.

Nome	Tipo	Description	Obrigatório
content_index	OpenAI.integer		Yes
delta	cadeia	O delta de texto que foi adicionado.	Yes
item_id	cadeia	A ID do item de saída ao qual o delta de texto foi adicionado.	Yes
logprobs	matriz de OpenAI.ResponseLogProb	As probabilidades de log dos tokens no delta.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.output_text.delta`. Valores possíveis: `response.output_text.delta`	Yes

OpenAI.ResponseTextDoneEvent

Emitido quando o conteúdo do texto é finalizado.

Nome	Tipo	Description	Obrigatório
content_index	OpenAI.integer		Yes
item_id	cadeia	A ID do item de saída em que o conteúdo do texto é finalizado.	Yes
logprobs	matriz de OpenAI.ResponseLogProb	As probabilidades de log dos tokens no delta.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
enviar SMS	cadeia	O conteúdo do texto finalizado.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.output_text.done`. Valores possíveis: `response.output_text.done`	Yes

OpenAI.ResponseTextParam

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

Nome	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
detalhamento	OpenAI.Verbosity	Restringe a verbosidade da resposta do modelo. Valores mais baixos resultarão em respostas mais concisas, enquanto valores mais altos resultarão em respostas mais detalhadas. Os valores com suporte no momento são `low`, `medium`e `high`.	No

OpenAI.ResponseUsage

Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, uma divisão de tokens de saída e o total de tokens usados.

Nome	Tipo	Obrigatório
input_tokens	OpenAI.integer	Yes
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Yes
└─ tokens em cache	OpenAI.integer	Yes
output_tokens	OpenAI.integer	Yes
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Yes
└─ tokens_de_raciocínio	OpenAI.integer	Yes
total_tokens	OpenAI.integer	Yes

OpenAI.ResponseUsageInputTokensDetails

Nome	Tipo	Description	Obrigatório	Default
cached_tokens	OpenAI.integer		Yes

OpenAI.ResponseUsageOutputTokensDetails

Nome	Tipo	Description	Obrigatório	Default
reasoning_tokens	OpenAI.integer		Yes

OpenAI.ResponseWebSearchCallCompletedEvent

Emitido quando uma chamada de pesquisa na Web é concluída.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	ID exclusiva para o item de saída associado à chamada de pesquisa na Web.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.web_search_call.completed`. Valores possíveis: `response.web_search_call.completed`	Yes

OpenAI.ResponseWebSearchCallInProgressEvent

Emitido quando uma chamada de pesquisa na Web é iniciada.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	ID exclusiva para o item de saída associado à chamada de pesquisa na Web.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.web_search_call.in_progress`. Valores possíveis: `response.web_search_call.in_progress`	Yes

OpenAI.ResponseWebSearchCallSearchingEvent

Emitido quando uma chamada de pesquisa na Web está sendo executada.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	ID exclusiva para o item de saída associado à chamada de pesquisa na Web.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tipo	enumeração	O tipo de evento. Sempre `response.web_search_call.searching`. Valores possíveis: `response.web_search_call.searching`	Yes

OpenAI.Screenshot

Uma ação de captura de tela.

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	Especifica o tipo de evento. Para uma ação de captura de tela, essa propriedade é sempre definido como `screenshot`. Valores possíveis: `screenshot`	Yes

OpenAI.Scroll

Uma ação de rolagem.

Nome	Tipo	Description	Obrigatório
scroll_x	OpenAI.integer		Yes
scroll_y	OpenAI.integer		Yes
tipo	enumeração	Especifica o tipo de evento. Para uma ação de rolagem, essa propriedade é sempre definido como `scroll`. Valores possíveis: `scroll`	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.SearchContextSize

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

OpenAI.ServiceTier

Especifica o tipo de processamento usado para atender à solicitação.

Se definido como "automático", a solicitação será processada com a camada de serviço configurada nas configurações de Project. A menos que esteja configurado de outra forma, o Project usará "padrão".
Se definido como "padrão", a solicitação será processada com o preço padrão e o desempenho do modelo selecionado.
Se definido como 'flex' ou 'priority', a solicitação será processada com a camada de serviço correspondente.
Quando não definido, o comportamento padrão é 'auto'. Quando o service_tier parâmetro for definido, o corpo da resposta incluirá o service_tier valor com base no modo de processamento realmente usado para atender à solicitação. Esse valor de resposta pode ser diferente do valor definido no parâmetro.

Property	Valor
Type	cadeia
Nulável	Yes
Valores	`auto` `default` `flex` `scale` `priority`

OpenAI.SpecificApplyPatchParam

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

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

OpenAI.SpecificFunctionShellParam

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

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

OpenAI.Summary

Um texto de resumo do modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	Um resumo da saída de raciocínio do modelo até agora.	Yes
tipo	enumeração	O tipo do objeto. Sempre `summary_text`. Valores possíveis: `summary_text`	Yes

OpenAI.SummaryTextContent

Um texto de resumo do modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	Um resumo da saída de raciocínio do modelo até agora.	Yes
tipo	enumeração	O tipo do objeto. Sempre `summary_text`. Valores possíveis: `summary_text`	Yes

OpenAI.TextContent

Um conteúdo de texto.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia		Yes
tipo	enumeração	Valores possíveis: `text`	Yes

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:* Configuração para { "type": "json_object" } habilitar o modo JSON mais antigo, o 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:

Digite um valor	Schema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

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

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Nome	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

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

Nome	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
Type	cadeia
Valores	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

Formato de resposta de esquema JSON. Usado para gerar respostas JSON estruturadas. Saiba mais sobre saídas estruturadas.

Nome	Tipo	Description	Obrigatório
description	cadeia	Uma descrição do formato de resposta, usado pelo modelo para determinar como responder no formato.	No
nome	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:

Digite um valor	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

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

OpenAI.ToolChoiceAllowed

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

Nome	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.

Nome	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.

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

OpenAI.ToolChoiceCustom

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

Nome	Tipo	Description	Obrigatório	Default
nome	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.

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

OpenAI.ToolChoiceFunction

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

Nome	Tipo	Description	Obrigatório	Default
nome	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.

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

OpenAI.ToolChoiceMCP

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

Nome	Tipo	Description	Obrigatório
nome	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.ToolChoiceOptions

Controla qual ferramenta (se houver) é chamada pelo modelo. none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem. auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas. required significa que o modelo deve chamar uma ou mais ferramentas.

Property	Valor
Type	cadeia
Valores	`none` `auto` `required`

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:

Digite um valor	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

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

OpenAI.ToolChoiceParamType

Property	Valor
Type	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.

Nome	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.

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

OpenAI.ToolType

Property Valor

Type 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.ToolsArray

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. Damos suporte às seguintes categorias de ferramentas:

Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem os recursos do modelo, como pesquisa na Web ou pesquisa de arquivos. Saiba mais sobre ferramentas internas.
Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre as Ferramentas do MCP.
Chamadas de função (ferramentas personalizadas): Funções definidas por você, permitindo que o modelo chame seu próprio código com argumentos e saídas fortemente tipadas. Saiba mais sobre a chamada de função. Você também pode usar ferramentas personalizadas para chamar seu próprio código.

Matriz de: OpenAI.Tool

OpenAI.TopLogProb

A probabilidade de log superior de um token.

Nome	Tipo	Obrigatório
bytes	matriz de OpenAI.integer	Yes
logprob	OpenAI.numeric	Yes
símbolo	cadeia	Yes

OpenAI.Type

Uma ação para digitar texto.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	O texto a ser digitado.	Yes
tipo	enumeração	Especifica o tipo de evento. Para uma ação de tipo, essa propriedade é sempre definido como `type`. Valores possíveis: `type`	Yes

OpenAI.UpdateConversationBody

Nome	Tipo	Description	Obrigatório	Default
metadados	OpenAI.Metadata (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

OpenAI.UrlCitationBody

Uma citação para um recurso da Web usado para gerar uma resposta de modelo.

Nome	Tipo	Description	Obrigatório
end_index	OpenAI.integer		Yes
start_index	OpenAI.integer		Yes
title	cadeia	O título do recurso da Web.	Yes
tipo	enumeração	O tipo da citação de URL. Sempre `url_citation`. Valores possíveis: `url_citation`	Yes
url	cadeia	URL do recurso da Web.	Yes

OpenAI.VectorStoreFileAttributes

Tipo: objeto

OpenAI.Verbosity

Restringe a verbosidade da resposta do modelo. Valores mais baixos resultarão em respostas mais concisas, enquanto valores mais altos resultarão em respostas mais detalhadas. Os valores com suporte no momento são low, mediume high.

Property	Valor
Type	cadeia
Nulável	Yes
Valores	`low` `medium` `high`

OpenAI.Wait

Uma ação de espera.

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	Especifica o tipo de evento. Para uma ação de espera, essa propriedade é sempre definido como `wait`. Valores possíveis: `wait`	Yes

OpenAI.WebSearchActionFind

Tipo de ação "localizar": pesquisa um padrão em uma página carregada.

Nome	Tipo	Description	Obrigatório
padrão	cadeia	O padrão ou texto a ser pesquisado dentro da página.	Yes
tipo	enumeração	O tipo de ação. Valores possíveis: `find_in_page`	Yes
url	cadeia	A URL da página pesquisou o padrão.	Yes

OpenAI.WebSearchActionOpenPage

Tipo de ação "open_page" – abre uma URL específica dos resultados da pesquisa.

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	O tipo de ação. Valores possíveis: `open_page`	Yes
url	cadeia	A URL aberta pelo modelo.	Yes

OpenAI.WebSearchActionSearch

Tipo de ação "pesquisa" – executa uma consulta de pesquisa na Web.

Nome	Tipo	Description	Obrigatório
Consultas	matriz de strings	As consultas de pesquisa.	No
consulta	cadeia de caracteres (preterida)	[PRETERIDO] A consulta de pesquisa.	Yes
Fontes	matriz de OpenAI.WebSearchActionSearchSources	As fontes usadas na pesquisa.	No
tipo	enumeração	O tipo de ação. Valores possíveis: `search`	Yes

OpenAI.WebSearchActionSearchSources

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	Valores possíveis: `url`	Yes
url	cadeia		Yes

OpenAI.WebSearchApproximateLocation

O local aproximado do usuário.

Nome	Tipo	Description	Obrigatório
Cidade	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`	No

OpenAI.WebSearchPreviewTool

Essa ferramenta busca na internet resultados relevantes para usar em uma resposta. Saiba mais sobre a ferramenta de pesquisa web.

Nome	Tipo	Description	Obrigatório
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
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

OpenAI.WebSearchTool

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

Nome	Tipo	Description	Obrigatório
custom_search_configuration	WebSearchConfiguration	Uma configuração de pesquisa na Web para bing pesquisa personalizada	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
Filtros	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
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
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`	No

OpenAI.WebSearchToolFilters

Nome	Tipo	Description	Obrigatório	Default
allowed_domains	matriz de strings		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

Nome	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:

Digite um valor	Schema
`anonymous`	OpenApiAnonymousAuthDetails
`project_connection`	OpenApiProjectConnectionAuthDetails
`managed_identity`	OpenApiManagedAuthDetails

Nome	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 (sem necessidade de autenticação)
Project Conexão (requer project_connection_id para o endpoint, conforme configurado no AI Foundry)
Managed_Identity (requer público-alvo 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)
Type	cadeia
Valores	`anonymous` `project_connection` `managed_identity`

OpenApiFunctionDefinition

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

Nome	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	Lista de definições de função usadas pela ferramenta OpenApi	No
nome	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

Nome	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

Nome	Tipo	Description	Obrigatório	Default
audience	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 OpenApi project

Nome	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

Nome	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.

Nome	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
Type	cadeia
Valores	`asc` `desc`

PagedConnection

Coleção de páginas de itens de conexão

Nome	Tipo	Description	Obrigatório	Default
nextLink	cadeia	Link para a próxima página de itens	No
value	matriz de Conexão	Os itens de conexão nesta página	Yes

PagedDatasetVersion

Coleção de páginas de itens DatasetVersion

Nome	Tipo	Description	Obrigatório	Default
nextLink	cadeia	Link para a próxima página de itens	No
value	matriz de DatasetVersion	Os itens datasetVersion nesta página	Yes

PagedDeployment

Coleção de páginas de itens de implantação

Nome	Tipo	Description	Obrigatório	Default
nextLink	cadeia	Link para a próxima página de itens	No
value	matriz de implantação	Os itens de implantação nesta página	Yes

PagedEvaluationRule

Coleção de páginas de itens EvaluationRule

Nome	Tipo	Description	Obrigatório	Default
nextLink	cadeia	Link para a próxima página de itens	No
value	matriz de EvaluationRule	Os itens EvaluationRule nesta página	Yes

PagedEvaluationTaxonomy

Coleção de páginas de itens EvaluationTaxonomy

Nome	Tipo	Description	Obrigatório	Default
nextLink	cadeia	Link para a próxima página de itens	No
value	matriz de EvaluationTaxonomy	Os itens EvaluationTaxonomy nesta página	Yes

PagedEvaluatorVersion

Coleção de páginas de itens EvaluatorVersion

Nome	Tipo	Description	Obrigatório	Default
nextLink	cadeia	Link para a próxima página de itens	No
value	matriz de EvaluatorVersion	Os itens de EvaluatorVersion nesta página	Yes

PagedIndex

Coleção de páginas de itens de índice

Nome	Tipo	Description	Obrigatório	Default
nextLink	cadeia	Link para a próxima página de itens	No
value	matriz de Índice	Os itens de índice nesta página	Yes

PagedInsight

Coleção de páginas de itens do Insight

Nome	Tipo	Description	Obrigatório	Default
nextLink	cadeia	Link para a próxima página de itens	No
value	matriz de Insight	Os itens do Insight nesta página	Yes

PagedRedTeam

Coleção de páginas de itens RedTeam

Nome	Tipo	Description	Obrigatório	Default
nextLink	cadeia	Link para a próxima página de itens	No
value	matriz de RedTeam	Os itens do RedTeam nesta página	Yes

PagedSchedule

Coleção de páginas de itens de agendamento

Nome	Tipo	Description	Obrigatório	Default
nextLink	cadeia	Link para a próxima página de itens	No
value	matriz de Agendamento	Os itens de Agendamento nesta página	Yes

PagedScheduleRun

Coleção de páginas de itens ScheduleRun

Nome	Tipo	Description	Obrigatório	Default
nextLink	cadeia	Link para a próxima página de itens	No
value	matriz de ScheduleRun	Os itens ScheduleRun nesta página	Yes

PendingUploadRequest

Representa uma solicitação de upload pendente.

Nome	Tipo	Description	Obrigatório
Connectionname	cadeia	Nome da conexão da Conta de Armazenamento do Azure a ser usado para gerar o token SAS temporário	No
pendingUploadId	cadeia	Se PendingUploadId não for fornecido, um GUID aleatório será usado.	No
pendingUploadType	enumeração	BlobReference é o único tipo com suporte. Valores possíveis: `BlobReference`	Yes

PendingUploadResponse

Representa a resposta para uma solicitação de upload pendente

Nome	Tipo	Description	Obrigatório
blobReference	BlobReference	Detalhes de referência de blob.	Yes
└─ blobUri	cadeia	Caminho do URI do blob para o cliente carregar dados. Exemplo: `https://blob.windows.core.net/Container/Path`	Yes
└─ credencial	SasCredential	Informações de credencial para acessar a conta de armazenamento.	Yes
└─ storageAccountArmId	cadeia	ID do ARM da conta de armazenamento a ser usada.	Yes
pendingUploadId	cadeia	ID para esta solicitação de upload.	Yes
pendingUploadType	enumeração	BlobReference é o único tipo com suporte Valores possíveis: `BlobReference`	Yes
versão	cadeia	Versão do ativo a ser criado se o usuário não tiver especificado a versão ao criar o upload inicialmente	No

PromptAgentDefinition

A definição do agente de prompt

Nome	Tipo	Description	Obrigatório	Default
instructions	cadeia de caracteres (anulável)	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo.	No
kind	enumeração	Valores possíveis: `prompt`	Yes
modelo	cadeia	A implantação do modelo a ser usada para esse agente.	Yes
rai_config	RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).	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	enumeração	Valores possíveis: `auto`, , `concisedetailed`	No
└─ resumo	enumeração	Valores possíveis: `auto`, , `concisedetailed`	No
structured_inputs	objeto	Conjunto de entradas estruturadas que podem participar da substituição de modelo de prompt ou associações de argumento de ferramenta.	No
Temperatura	número	Que 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` não ambos.	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	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` não ambos.	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.

Nome	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

PromptBasedEvaluatorDefinition

Avaliador baseado em prompt

Nome	Tipo	Description	Obrigatório
data_schema	objeto	O esquema JSON (rascunho 2020-12) para os dados de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	No
init_parameters	objeto	O esquema JSON (Rascunho 2020-12) para os parâmetros de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	No
métricas	objeto	Lista de métricas de saída produzidas por este avaliador	No
prompt_text	cadeia	O texto do prompt usado para avaliação	Yes
tipo	enumeração	Valores possíveis: `prompt`	Yes

ProtocolVersionRecord

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

Nome	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 para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).

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

RecurrenceSchedule

Modelo de cronograma de recorrência.

Discriminatório para RecurrenceSchedule

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

Digite um valor	Schema
`Hourly`	HourlyRecurrenceSchedule
`Daily`	DailyRecurrenceSchedule
`Weekly`	WeeklyRecurrenceSchedule
`Monthly`	MonthlyRecurrenceSchedule

Nome	Tipo	Description	Obrigatório	Default
tipo	RecurrenceType	Tipo de recorrência.	Yes

RecurrenceTrigger

Gatilho baseado em recorrência.

Nome	Tipo	Description	Obrigatório	Default
endTime	cadeia	Hora de término do agendamento de recorrência no formato ISO 8601.	No
intervalo	inteiro	Intervalo para o agendamento de recorrência.	Yes
schedule	RecurrenceSchedule	Modelo de cronograma de recorrência.	Yes
└─ tipo	RecurrenceType	Tipo de recorrência para o agendamento de recorrência.	Yes
startTime	cadeia	Hora de início do cronograma de recorrência no formato ISO 8601.	No
timeZone	cadeia	Fuso horário para o agendamento de recorrência.	No	UTC
tipo	enumeração	Tipo do gatilho. Valores possíveis: `Recurrence`	Yes

RecurrenceType

Tipo de recorrência.

Property	Valor
Description	Tipo de recorrência.
Type	cadeia
Valores	`Hourly` `Daily` `Weekly` `Monthly`

RedTeam

Detalhes da equipe vermelha.

Nome	Tipo	Description	Obrigatório	Default
applicationScenario	cadeia	Cenário de aplicativo para a operação de equipe vermelha, para gerar ataques específicos do cenário.	No
attackStrategies	matriz de AttackStrategy	Lista de estratégias de ataque ou listas aninhadas de estratégias de ataque.	No
displayName	cadeia	Nome da execução da equipe vermelha.	No
id	cadeia de caracteres (somente leitura)	Identificador da execução da equipe vermelha.	Yes
numTurns	inteiro	Número de rodadas de simulação.	No
properties	objeto	Propriedades da equipe vermelha. Ao contrário das marcas, as propriedades são somente suplementos. Depois de adicionada, uma propriedade não pode ser removida.	No
riskCategories	matriz de RiskCategory	Lista de categorias de risco para as quais gerar objetivos de ataque.	No
simulationOnly	boolean	Somente simulação ou simulação + avaliação. Falso padrão, se verdadeiro, a conversa de saída de verificação não resultará na avaliação.	No	Falso
status	cadeia de caracteres (somente leitura)	Status da equipe vermelha. Ele é definido por serviço e é somente leitura.	No
tags	objeto	Marcas da equipe vermelha. Ao contrário das propriedades, as marcas são totalmente mutáveis.	No
destino	TargetConfig	Classe abstrata para configuração de destino.	Yes
└─ tipo	cadeia	Tipo da configuração do modelo.	Yes

RedTeamEvalRunDataSource

Nome	Tipo	Description	Obrigatório
item_generation_params	ItemGenerationParams	Representa o conjunto de parâmetros usados para controlar as operações de geração de item.	Yes
└─ tipo	ItemGenerationParamsType	O tipo de parâmetros de geração de item a ser usado.	Yes
destino	Target (destino)	Classe base para destinos com suporte a discriminadores.	Yes
└─ tipo	cadeia	O tipo de destino.	Yes
tipo	enumeração	O tipo de fonte de dados. Sempre `azure_ai_red_team`. Valores possíveis: `azure_ai_red_team`	Yes

RedTeamItemGenerationParams

Nome	Tipo	Description	Obrigatório	Default
attack_strategies	matriz de AttackStrategy	A coleção de estratégias de ataque a serem usadas.	Yes
num_turns	inteiro	O número de turnos permitido no jogo.	Yes	20
tipo	enumeração	O tipo de parâmetros de geração de item. Valores possíveis: `red_team`	Yes

RedTeamSeedPromptsItemGenerationParams

Representa os parâmetros para a geração de itens de solicitações de equipe vermelha.

Nome	Tipo	Description	Obrigatório	Default
attack_strategies	matriz de AttackStrategy	A coleção de estratégias de ataque a serem usadas.	Yes
num_turns	inteiro	O número de turnos permitido no jogo.	Yes	20
fonte	OpenAI.EvalJsonlFileContentSource		Yes
└─ conteúdo	matriz de OpenAI.EvalJsonlFileContentSourceContent	O conteúdo do arquivo jsonl.	Yes
└─ tipo	enumeração	Tipo de fonte jsonl. Sempre `file_content`. Valores possíveis: `file_content`	Yes
tipo	enumeração	O tipo de parâmetros de geração de item, sempre `red_team_seed_prompts`. Valores possíveis: `red_team_seed_prompts`	Yes

RedTeamTaxonomyItemGenerationParams

Representa os parâmetros para a geração de item de taxonomia da equipe vermelha.

Nome	Tipo	Description	Obrigatório	Default
attack_strategies	matriz de AttackStrategy	A coleção de estratégias de ataque a serem usadas.	Yes
num_turns	inteiro	O número de turnos permitido no jogo.	Yes	20
fonte	OpenAI.EvalJsonlFileContentSource		Yes
└─ conteúdo	matriz de OpenAI.EvalJsonlFileContentSourceContent	O conteúdo do arquivo jsonl.	Yes
└─ tipo	enumeração	Tipo de fonte jsonl. Sempre `file_content`. Valores possíveis: `file_content`	Yes
tipo	enumeração	O tipo de parâmetros de geração de item, sempre `red_team_taxonomy`. Valores possíveis: `red_team_taxonomy`	Yes

ResponseRetrievalItemGenerationParams

Representa os parâmetros para a geração de item de recuperação de resposta.

Nome	Tipo	Description	Obrigatório
mapeamento de dados	objeto	Mapeamento de campos de origem para response_id campo, necessário para recuperar o histórico de chat.	Yes
max_num_turns	inteiro	O número máximo de turnos do histórico de chat a ser avaliado.	Yes
fonte	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource	A origem da qual o conteúdo JSONL é lido.	Yes
tipo	enumeração	O tipo de parâmetros de geração de item, sempre `response_retrieval`. Valores possíveis: `response_retrieval`	Yes

RiskCategory

Categoria de risco para o objetivo do ataque.

Property	Valor
Description	Categoria de risco para o objetivo do ataque.
Type	cadeia
Valores	`HateUnfairness` `Violence` `Sexual` `SelfHarm` `ProtectedMaterial` `CodeVulnerability` `UngroundedAttributes` `ProhibitedActions` `SensitiveDataLeakage` `TaskAdherence`

SASCredentials

Definição de credencial de SAS (Assinatura de Acesso Compartilhado)

Nome	Tipo	Description	Obrigatório	Default
SAS	cadeia de caracteres (somente leitura)	token SAS	No
tipo	enumeração	O tipo de credencial Valores possíveis: `SAS`	Yes

Sampletype

O tipo de amostra usada na análise.

Property	Valor
Description	O tipo de amostra usada na análise.
Type	cadeia
Valores	`EvaluationResultSample`

SasCredential

Definição de credencial SAS

Nome	Tipo	Description	Obrigatório	Default
sasUri	cadeia de caracteres (somente leitura)	URI de SAS	Yes
tipo	enumeração	Tipo de credencial Valores possíveis: `SAS`	Yes

Schedule

Modelo de agendamento.

Nome	Tipo	Description	Obrigatório
description	cadeia	Descrição da agenda.	No
displayName	cadeia	Nome da agenda.	No
enabled	boolean	Status habilitado do agendamento.	Yes
id	cadeia de caracteres (somente leitura)	Identificador do agendamento.	Yes
properties	objeto	Propriedades do agendamento. Ao contrário das marcas, as propriedades são somente suplementos. Depois de adicionada, uma propriedade não pode ser removida.	No
status de provisionamento	ScheduleProvisioningStatus (somente leitura)	Agende o status de provisionamento.	No
systemData	objeto (somente leitura)	Metadados do sistema para o recurso.	Yes
tags	objeto	Marcas de agendamento. Ao contrário das propriedades, as marcas são totalmente mutáveis.	No
tarefa	ScheduleTask	Modelo de tarefa de agendamento.	Yes
Configuração do └─	objeto	Configuração da tarefa.	No
└─ tipo	ScheduleTaskType	Tipo da tarefa.	Yes
disparador	Trigger	Modelo base para Trigger do agendamento.	Yes
└─ tipo	Tipo de gatilho	Tipo do gatilho.	Yes

ScheduleProvisioningStatus

Agende o status de provisionamento.

Property	Valor
Description	Agende o status de provisionamento.
Type	cadeia
Valores	`Creating` `Updating` `Deleting` `Succeeded` `Failed`

ScheduleRun

Agendar modelo de execução.

Nome	Tipo	Description	Obrigatório
erro	cadeia de caracteres (somente leitura)	Informações de erro para a execução da agenda.	No
id	cadeia de caracteres (somente leitura)	Identificador da execução do agendamento.	Yes
properties	objeto (somente leitura)	Propriedades da execução do agendamento.	Yes
Scheduleid	cadeia	Identificador do agendamento.	Yes
êxito	booliano (somente leitura)	Disparar o status de êxito da execução do agendamento.	Yes
triggerTime	cadeia	Tempo de gatilho da execução do agendamento.	No

Agendar Tarefa

Modelo de tarefa de agendamento.

Discriminador para ScheduleTask

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

Digite um valor	Schema
`Evaluation`	EvaluationScheduleTask
`Insight`	InsightScheduleTask

Nome	Tipo	Description	Obrigatório	Default
configuração	objeto	Configuração da tarefa.	No
tipo	ScheduleTaskType	Tipo da tarefa.	Yes

ScheduleTaskType

Tipo da tarefa.

Property	Valor
Description	Tipo da tarefa.
Type	cadeia
Valores	`Evaluation` `Insight`

SharepointGroundingToolParameters

Os parâmetros da ferramenta de aterramento do sharepoint.

Nome	Tipo	Description	Obrigatório	Default
project_connections	matriz de ToolProjectConnection	O project conexões anexadas a essa ferramenta. Pode haver um máximo de 1 conexão recurso anexado à ferramenta.	No

SharepointPreviewTool

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

Nome	Tipo	Description	Obrigatório
sharepoint_grounding_preview	SharepointGroundingToolParameters	Os parâmetros da ferramenta de aterramento do sharepoint.	Yes
└─ project_connections	matriz de ToolProjectConnection	O project conexões 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

Sku

Informações de SKU

Nome	Tipo	Description	Obrigatório
capacidade	inteiro	Capacidade de SKU	Yes
family	cadeia	Família Sku	Yes
nome	cadeia	Nome do SKU	Yes
size	cadeia	Tamanho do SKU	Yes
nível	cadeia	Camada de SKU	Yes

StructuredInputDefinition

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

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

StructuredOutputDefinition

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

Nome	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
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

StructuredOutputsOutputItem

Nome	Tipo	Description	Obrigatório
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
saída		A saída estruturada capturada durante a resposta.	Yes
response_id	cadeia	A resposta na qual o item é criado.	No
tipo	enumeração	Valores possíveis: `structured_outputs`	Yes

SyntheticDataGenerationPreviewEvalRunDataSource

Representa uma fonte de dados para execuções de avaliação que são avaliadas com base em dados sintéticos gerados para fins de teste.

Nome	Tipo	Description	Obrigatório
mensagens_de_entrada	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		No
└─ modelo	matriz de objeto ou OpenAI.EvalItem		Yes
└─ tipo	enumeração	Valores possíveis: `template`	Yes
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		Yes
└─ model_deployment_name	cadeia	O nome da implantação do modelo a ser usado para gerar dados sintéticos.	Yes
└─ output_dataset_id	cadeia de caracteres (somente leitura)	O identificador do conjunto de dados de saída em que os dados sintéticos gerados são armazenados. Os dados gerados são um arquivo jsonl com id de colunas, consulta e test_description.	No
└─ output_dataset_name	cadeia	O nome do conjunto de dados de saída em que os dados sintéticos gerados serão armazenados. Se não for fornecido, o serviço gerará o nome do conjunto de dados automaticamente.	No
└─ comando	cadeia	O prompt usado para gerar dados sintéticos. Essa é a opção se o destino for do tipo "azure_ai_agent" com instruções configuradas no agente.	No
└─ samples_count	inteiro	O número máximo de exemplos de dados a serem gerados.	Yes
└─ fontes	matriz de OpenAI.EvalJsonlFileIdSource	Os arquivos opcionais de fonte de conteúdo de dados de semente para geração de dados.	Yes
└─ tipo	enumeração	O tipo de parâmetros de geração de item. Valores possíveis: `synthetic_data_gen_preview`	Yes
destino	Target (destino)	Classe base para destinos com suporte a discriminadores.	Yes
└─ tipo	cadeia	O tipo de destino.	Yes
tipo	enumeração	O tipo de fonte de dados, always `azure_ai_synthetic_data_gen_preview`. Valores possíveis: `azure_ai_synthetic_data_gen_preview`	Yes

SyntheticDataGenerationPreviewItemGenerationParams

Nome	Tipo	Description	Obrigatório
model_deployment_name	cadeia	O nome da implantação do modelo a ser usado para gerar dados sintéticos.	Yes
output_dataset_id	cadeia de caracteres (somente leitura)	O identificador do conjunto de dados de saída em que os dados sintéticos gerados são armazenados. Os dados gerados são um arquivo jsonl com id de colunas, consulta e test_description.	No
output_dataset_name	cadeia	O nome do conjunto de dados de saída em que os dados sintéticos gerados serão armazenados. Se não for fornecido, o serviço gerará o nome do conjunto de dados automaticamente.	No
solicitação	cadeia	O prompt usado para gerar dados sintéticos. Essa é a opção se o destino for do tipo "azure_ai_agent" com instruções configuradas no agente.	No
samples_count	inteiro	O número máximo de exemplos de dados a serem gerados.	Yes
Fontes	matriz de OpenAI.EvalJsonlFileIdSource	Os arquivos opcionais de fonte de conteúdo de dados de semente para geração de dados.	Yes
tipo	enumeração	O tipo de parâmetros de geração de item. Valores possíveis: `synthetic_data_gen_preview`	Yes

Destino

Classe base para destinos com suporte a discriminadores.

Discriminador para Destino

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

Digite um valor	Schema
`azure_ai_model`	AzureAIModelTarget
`azure_ai_agent`	AzureAIAgentTarget

Nome	Tipo	Description	Obrigatório	Default
tipo	cadeia	O tipo de destino.	Yes

TargetCompletionEvalRunDataSource

Representa uma fonte de dados para a configuração de avaliação de conclusão baseada em destino.

Nome	Tipo	Description	Obrigatório
mensagens_de_entrada	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		No
└─ referência_item	cadeia		Yes
└─ tipo	enumeração	Valores possíveis: `item_reference`	Yes
fonte	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource	A configuração de origem para dados embutidos ou de arquivo.	Yes
destino	Target (destino)	Classe base para destinos com suporte a discriminadores.	Yes
└─ tipo	cadeia	O tipo de destino.	Yes
tipo	enumeração	O tipo de fonte de dados, always `azure_ai_target_completions`. Valores possíveis: `azure_ai_target_completions`	Yes

TargetConfig

Classe abstrata para configuração de destino.

Discriminador para TargetConfig

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

Digite um valor	Schema
`AzureOpenAIModel`	AzureOpenAIModelConfiguration

Nome	Tipo	Description	Obrigatório	Default
tipo	cadeia	Tipo da configuração do modelo.	Yes

TargetUpdate

Classe base para destinos com suporte a discriminadores.

Discriminatório para TargetUpdate

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

Digite um valor	Schema
`azure_ai_model`	AzureAIModelTargetUpdate
`azure_ai_agent`	AzureAIAgentTargetUpdate

Nome	Tipo	Description	Obrigatório	Default
tipo	cadeia	O tipo de destino.	Yes

TaxonomyCategory

Definição de categoria de taxonomia.

Nome	Tipo	Description	Obrigatório
description	cadeia	Descrição da categoria taxonomia.	No
id	cadeia	Identificador exclusivo da categoria taxonomia.	Yes
nome	cadeia	Nome da categoria taxonomia.	Yes
properties	objeto	Propriedades adicionais para a categoria de taxonomia.	No
riskCategory	RiskCategory	Categoria de risco para o objetivo do ataque.	Yes
Subcategorias	matriz de TaxonomySubCategory	Lista de subcategorias de taxonomia.	Yes

TaxonomySubCategory

Definição de subcategoria de taxonomia.

Nome	Tipo	Description	Obrigatório
description	cadeia	Descrição da subcategoria de taxonomia.	No
enabled	boolean	Lista de itens de taxonomia nessa subcategoria.	Yes
id	cadeia	Identificador exclusivo da subcategoria taxonomia.	Yes
nome	cadeia	Nome da subcategoria de taxonomia.	Yes
properties	objeto	Propriedades adicionais para a subcategoria de taxonomia.	No

ToolDescription

Descrição de uma ferramenta que pode ser usada por um agente.

Nome	Tipo	Description	Obrigatório	Default
description	cadeia	Uma breve descrição da finalidade da ferramenta.	No
nome	cadeia	O nome da ferramenta.	No

ToolProjectConnection

Um recurso de conexão project.

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

TracesPreviewEvalRunDataSource

Representa uma fonte de dados para execuções de avaliação que operam sobre rastreamentos do Agente armazenados no Application Insights.

Nome	Tipo	Description	Obrigatório	Default
agent_id	cadeia	A ID do agente usada para filtrar rastreamentos para avaliação.	No
agent_name	cadeia	O nome do agente usado para filtrar rastreamentos para avaliação.	No
hora_final	inteiro	Unix timestamp (em segundos) marcando o final da janela de consulta de rastreamento. O valor padrão é o horário atual.	No
ingestion_delay_seconds	inteiro	O atraso para solicitar a ingestão ao consultar rastreamentos.	No	300
lookback_hours	inteiro	Janela de pesquisa (em horas) aplicada ao recuperar rastreamentos do Application Insights. Para avaliações agendadas, isso é inferido do intervalo de recorrência.	No	168
max_traces	inteiro	Limite de amostragem aplicado aos rastreamentos recuperados para avaliação.	No	1000
trace_ids	matriz de strings	Coleção de identificadores de rastreamento do Agente que devem ser avaliados.	No
tipo	enumeração	O tipo de fonte de dados, always `azure_ai_traces_preview`. Valores possíveis: `azure_ai_traces_preview`	Yes

TreatmentEffectType

Tipo de efeito de tratamento.

Property	Valor
Description	Tipo de efeito de tratamento.
Type	cadeia
Valores	`TooFewSamples` `Inconclusive` `Changed` `Improved` `Degraded`

Trigger

Modelo base para Trigger do agendamento.

Discriminador para gatilho

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

Digite um valor	Schema
`Cron`	crontrigger
`Recurrence`	RecurrenceTrigger
`OneTime`	OneTimeTrigger

Nome	Tipo	Description	Obrigatório	Default
tipo	Tipo de gatilho	Tipo do gatilho.	Yes

TriggerType

Tipo do gatilho.

Property	Valor
Description	Tipo do gatilho.
Type	cadeia
Valores	`Cron` `Recurrence` `OneTime`

UpdateAgentFromManifestRequest

Nome	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

Nome	Tipo	Description	Obrigatório
definição	AgentDefinition		Yes
└─ tipo	AgentKind		Yes
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).	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

UpdateEvalParametersBody

Nome	Tipo	Description	Obrigatório
metadados	OpenAI.Metadata (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.	No
nome	cadeia		No
properties	objeto	Conjunto de 16 pares chave-valor imutáveis que podem ser anexados a um objeto para armazenar informações adicionais. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	No

UserProfileMemoryItem

Um item de memória que contém especificamente informações de perfil de usuário extraídas de conversas, como preferências, interesses e detalhes pessoais.

Nome	Tipo	Description	Obrigatório
conteúdo	cadeia	O conteúdo da memória.	Yes
kind	enumeração	O tipo do item de memória. Valores possíveis: `user_profile`	Yes
memory_id	cadeia	A ID exclusiva do item de memória.	Yes
escopo	cadeia	O namespace que agrupa e isola logicamente as memórias, como um ID do usuário.	Yes
updated_at	inteiro	A hora da última atualização do item de memória.	Yes

WebSearchConfiguration

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

Nome	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

WeeklyRecurrenceSchedule

Cronograma de recorrência semanal.

Nome	Tipo	Description	Obrigatório	Default
diasDeSemana	matriz de DayOfWeek	Dias da semana para o agendamento de recorrência.	Yes
tipo	enumeração	Tipo de recorrência semanal. Valores possíveis: `Weekly`	Yes

WorkflowActionOutputItem

Nome	Tipo	Description	Obrigatório
action_id	cadeia	Identificador exclusivo para a ação.	Yes
agent_reference	AgentReference		No
└─ nome	cadeia	O nome do agente. Restrições: maxLength: 256	Yes
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Yes
└─ versão	cadeia	O identificador de versão do agente.	No
kind	cadeia	O tipo de ação CSDL (por exemplo, 'SetVariable', 'InvokeAzureAgent').	Yes
parent_action_id	cadeia	ID da ação pai se esta for uma ação aninhada.	No
previous_action_id	cadeia	ID da ação anterior se essa ação seguir outra.	No
response_id	cadeia	A resposta na qual o item é criado.	No
status	enumeração	Status da ação (por exemplo, 'in_progress', 'concluída', 'falha', 'cancelada'). Valores possíveis: `completed`, , `failed`, `in_progresscancelled`	Yes
tipo	enumeração	Valores possíveis: `workflow_action`	Yes

WorkflowAgentDefinition

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

Nome	Tipo	Description	Obrigatório
kind	enumeração	Valores possíveis: `workflow`	Yes
rai_config	RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).	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

inteiro

Tipo: inteiro

Formato: int64

Última atualização em 2026-06-12