Referência REST do Microsoft Foundry Project

Versão API: 2025-11-15-preview

Agentes - criar agente

POST {endpoint}/agents?api-version=2025-11-15-preview

Cria o agente.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
Definição	objecto		Yes
└─ amável	AgentKind		Não
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo de IA Responsável (RAI) e recursos de segurança.	Não
descrição	cadeia (de caracteres)	Uma descrição do agente legível por humanos.	Não
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia (de caracteres)	O nome único que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve começar e terminar com caracteres alfanuméricos, - Pode conter hífenes no meio - Não deve exceder 63 caracteres.	Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	AgentObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - agentes de lista

GET {endpoint}/agents?api-version=2025-11-15-preview

Retorna a lista de todos os agentes.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
tipo	consulta	Não		Agentes filtrantes por tipo. Se não for fornecido, todos os agentes serão devolvidos.
limit	consulta	Não	número 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.
order	consulta	Não	cadeia (de caracteres) Valores possíveis: `asc`, `desc`	Ordem de classificação pela marcação `created_at` de data e hora dos objetos. `asc` por ordem crescente e`desc` por ordem decrescente.
after	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `after` é um ID de objeto que define o 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 subsequente pode incluir after=obj_foo para obter a próxima página da lista.
antes	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `before` é um ID de objeto que define o 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 subsequente pode incluir before=obj_foo para obter a página anterior da lista.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	objecto	Os dados de resposta para uma lista solicitada de itens.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - arranja agente

GET {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

Recupera o agente.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome do agente a ser recuperado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	AgentObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - agente de atualização

POST {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

Atualiza o agente 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	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome do agente a ser recuperado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
Definição	objecto		Yes
└─ amável	AgentKind		Não
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo de IA Responsável (RAI) e recursos de segurança.	Não
descrição	cadeia (de caracteres)	Uma descrição do agente legível por humanos.	Não
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	AgentObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - agente de exclusão

DELETE {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

Exclui um agente.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome do agente a ser excluído.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	DeleteAgentResponse

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - atualizar agente a partir do manifesto

POST {endpoint}/agents/{agent_name}/import?api-version=2025-11-15-preview

Atualiza o agente a partir de um manifesto adicionando uma nova versão caso haja alterações na definição do agente. Se nenhuma alteração, retorna a versão existente do agente.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome do agente a atualizar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	Uma descrição do agente legível por humanos.	Não
manifest_id	cadeia (de caracteres)	O ID do manifesto para importar a versão do agente.	Yes
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
parameter_values	objecto	As entradas para o manifesto resultarão num Agente totalmente materializado.	Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	AgentObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - listar agentes operações de contentores

GET {endpoint}/agents/{agent_name}/operations?api-version=2025-11-15-preview

Liste operações de contentores para um agente.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome do agente.
limit	consulta	Não	número 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.
order	consulta	Não	cadeia (de caracteres) Valores possíveis: `asc`, `desc`	Ordem de classificação pela marcação `created_at` de data e hora dos objetos. `asc` por ordem crescente e`desc` por ordem decrescente.
after	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `after` é um ID de objeto que define o 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 subsequente pode incluir after=obj_foo para obter a próxima página da lista.
antes	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `before` é um ID de objeto que define o 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 subsequente pode incluir before=obj_foo para obter a página anterior da lista.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	objecto	Os dados de resposta para uma lista solicitada de itens.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - get agent operação de contentor

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=2025-11-15-preview

Obtenha o estado de uma operação de contentor para um agente.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome do agente.
operation_id	caminho	Yes	cadeia (de caracteres)	O ID da operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	AgentContainerOperationObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse ou ApiErrorResponse

Agentes - criar a versão do agente

POST {endpoint}/agents/{agent_name}/versions?api-version=2025-11-15-preview

Crie uma nova versão do agente.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome único que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve começar e terminar com caracteres alfanuméricos, - Pode conter hífenes no meio - Não deve exceder 63 caracteres.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
Definição	objecto		Yes
└─ amável	AgentKind		Não
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo de IA Responsável (RAI) e recursos de segurança.	Não
descrição	cadeia (de caracteres)	Uma descrição do agente legível por humanos.	Não
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	AgentVersionObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - versões de agentes listados

GET {endpoint}/agents/{agent_name}/versions?api-version=2025-11-15-preview

Retorna a lista de versões de um agente.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome do agente para recolher as versões.
limit	consulta	Não	número 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.
order	consulta	Não	cadeia (de caracteres) Valores possíveis: `asc`, `desc`	Ordem de classificação pela marcação `created_at` de data e hora dos objetos. `asc` por ordem crescente e`desc` por ordem decrescente.
after	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `after` é um ID de objeto que define o 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 subsequente pode incluir after=obj_foo para obter a próxima página da lista.
antes	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `before` é um ID de objeto que define o 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 subsequente pode incluir before=obj_foo para obter a página anterior da lista.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	objecto	Os dados de resposta para uma lista solicitada de itens.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - obter a versão de agente

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome do agente a ser recuperado.
agent_version	caminho	Yes	cadeia (de caracteres)	A versão do agente a recuperar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	AgentVersionObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - eliminar a versão do agente

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome do agente a ser excluído.
agent_version	caminho	Yes	cadeia (de caracteres)	A versão do agente a eliminar

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	DeleteAgentVersionResponse

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - obter um contentor de agente

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=2025-11-15-preview

Arranja um contentor para uma versão específica de um agente.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome do agente.
agent_version	caminho	Yes	cadeia (de caracteres)	A versão do agente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	AgentContainerObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - listar as operações de contentor da versão do agente

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=2025-11-15-preview

Liste operações de contentor para uma versão específica de um agente.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome do agente.
agent_version	caminho	Yes	cadeia (de caracteres)	A versão do agente.
limit	consulta	Não	número 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.
order	consulta	Não	cadeia (de caracteres) Valores possíveis: `asc`, `desc`	Ordem de classificação pela marcação `created_at` de data e hora dos objetos. `asc` por ordem crescente e`desc` por ordem decrescente.
after	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `after` é um ID de objeto que define o 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 subsequente pode incluir after=obj_foo para obter a próxima página da lista.
antes	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `before` é um ID de objeto que define o 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 subsequente pode incluir before=obj_foo para obter a página anterior da lista.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	objecto	Os dados de resposta para uma lista solicitada de itens.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - contentor de apagar agentes

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome do agente.
agent_version	caminho	Yes	cadeia (de caracteres)	A versão do agente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de Estado: 202

Descrição: O pedido foi aceite para processamento, mas o processamento ainda não foi concluído.

Tipo de conteúdo	Type	Descrição
application/json	AgentContainerOperationObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - contentor de agente inicial

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome do agente.
agent_version	caminho	Yes	cadeia (de caracteres)	A versão do agente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

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

Respostas

Código de Estado: 202

Descrição: O pedido foi aceite para processamento, mas o processamento ainda não foi concluído.

Tipo de conteúdo	Type	Descrição
application/json	AgentContainerOperationObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - contentor de agente de paragem

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome do agente.
agent_version	caminho	Yes	cadeia (de caracteres)	A versão do agente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de Estado: 202

Descrição: O pedido foi aceite para processamento, mas o processamento ainda não foi concluído.

Tipo de conteúdo	Type	Descrição
application/json	AgentContainerOperationObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse ou ApiErrorResponse

Agentes - contentor de agentes de atualização

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome do agente.
agent_version	caminho	Yes	cadeia (de caracteres)	A versão do agente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório	Predefinido
max_replicas	número inteiro	O número máximo de réplicas.	Não
min_replicas	número inteiro	O número mínimo de réplicas.	Não

Respostas

Código de Estado: 202

Descrição: O pedido foi aceite para processamento, mas o processamento ainda não foi concluído.

Tipo de conteúdo	Type	Descrição
application/json	AgentContainerOperationObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - criar a versão do agente a partir do manifest

POST {endpoint}/agents/{agent_name}/versions:import?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
agent_name	caminho	Yes	cadeia (de caracteres)	O nome único que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve começar e terminar com caracteres alfanuméricos, - Pode conter hífenes no meio - Não deve exceder 63 caracteres.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	Uma descrição do agente legível por humanos.	Não
manifest_id	cadeia (de caracteres)	O ID do manifesto para importar a versão do agente.	Yes
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
parameter_values	objecto	As entradas para o manifesto resultarão num Agente totalmente materializado.	Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	AgentVersionObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Agentes - criar agente a partir do manifest

POST {endpoint}/agents:import?api-version=2025-11-15-preview

Cria um agente a partir de um manifesto.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	Uma descrição do agente legível por humanos.	Não
manifest_id	cadeia (de caracteres)	O ID do manifesto para importar a versão do agente.	Yes
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia (de caracteres)	O nome único que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve começar e terminar com caracteres alfanuméricos, - Pode conter hífenes no meio - Não deve exceder 63 caracteres.	Yes
parameter_values	objecto	As entradas para o manifesto resultarão num Agente totalmente materializado.	Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	AgentObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Ligações - lista

GET {endpoint}/connections?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
connectionType	consulta	Não		Listar conexões desse tipo específico
defaultConnection	consulta	Não	Booleano	Listar conexões que são conexões padrão
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	PagedConnection

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Ligações - obter

GET {endpoint}/connections/{name}?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome amigável da conexão, fornecido pelo usuário.
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Conexão

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Ligações - obter credenciais

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome amigável da conexão, fornecido pelo usuário.
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Conexão

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Conjuntos de dados - lista mais recente

GET {endpoint}/datasets?api-version=2025-11-15-preview

Listar a versão mais recente de cada DatasetVersion

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	PagedDatasetVersion

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Conjuntos de dados - versões de lista

GET {endpoint}/datasets/{name}/versions?api-version=2025-11-15-preview

Listar todas as versões do DatasetVersion fornecido

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	PagedDatasetVersion

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Conjuntos de dados - obter versão

GET {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso
versão	caminho	Yes	cadeia (de caracteres)	A ID de versão específica do DatasetVersion a ser recuperada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	DatasetVersion

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Conjuntos de dados - versão para eliminar

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

Exclua a versão específica do DatasetVersion. O serviço retorna 204 No Content se o DatasetVersion foi excluído com êxito ou se o DatasetVersion não existir.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso
versão	caminho	Yes	cadeia (de caracteres)	A versão do DatasetVersion a ser excluída.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 204

Descrição: Não há conteúdo para enviar para esta 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	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Conjuntos de dados - criar ou atualizar a versão

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

Criar um novo DatasetVersion ou atualizá-lo existente com o id de versão fornecido

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso
versão	caminho	Yes	cadeia (de caracteres)	A ID de versão específica do DatasetVersion para criar ou atualizar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Type-Content: application/merge-patch+json

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	O texto da descrição do ativo.	Não
etiquetas	objecto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não
tipo	objecto	Enum para determinar o tipo de dados.	Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	DatasetVersion

Código de status: 201

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

Tipo de conteúdo	Type	Descrição
application/json	DatasetVersion

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Conjuntos de dados - obtenha credenciais

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso
versão	caminho	Yes	cadeia (de caracteres)	A ID de versão específica do DatasetVersion para operar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	RespostaCredencial de Ativos

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Conjuntos de dados - início da versão de upload pendente

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso
versão	caminho	Yes	cadeia (de caracteres)	A ID de versão específica do DatasetVersion para operar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

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

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	PendingUploadResponse

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Listas de implantações

GET {endpoint}/deployments?api-version=2025-11-15-preview

Listar todos os modelos implantados no projeto

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
modelPublisher	consulta	Não	cadeia (de caracteres)	Editor de modelos para filtrar modelos por
modelName	consulta	Não	cadeia (de caracteres)	Nome do modelo (o nome específico do editor) para filtrar modelos por
deploymentType	consulta	Não		Tipo de implantação para filtrar lista por
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	PagedDeployment

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Implantações - get

GET {endpoint}/deployments/{name}?api-version=2025-11-15-preview

Obtenha um modelo implantado.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	Nome da implantação
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Implementação

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Regras de avaliação - lista

GET {endpoint}/evaluationrules?api-version=2025-11-15-preview

Listar todas as regras de avaliação.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
actionType	consulta	Não		Filtrar pelo tipo de regra de avaliação.
nome_agente	consulta	Não	cadeia (de caracteres)	Filtre pelo nome do agente.
ativado	consulta	Não	Booleano	Filtre pelo status habilitado.
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Regra de AvaliaçãoPaged

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Regras de avaliação - obter

GET {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

Obtenha uma regra de avaliação.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
id	caminho	Yes	cadeia (de caracteres)	Identificador exclusivo da regra de avaliação.
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Regra de Avaliação

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Regras de avaliação - eliminar

DELETE {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

Excluir uma regra de avaliação.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
id	caminho	Yes	cadeia (de caracteres)	Identificador exclusivo da regra de avaliação.
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 204

Descrição: Não há conteúdo para enviar para esta 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	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Regras de avaliação - criar ou atualizar

PUT {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

Crie ou atualize uma regra de avaliação.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
id	caminho	Yes	cadeia (de caracteres)	Identificador exclusivo da regra de avaliação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
ação	objecto	Modelo de ação de avaliação.	Yes
└─ tipo	RegragraAvaliaçãoTipo de Ação	Tipo de ação de avaliação.	Não
descrição	cadeia (de caracteres)	Descrição da regra de avaliação.	Não
nome de exibição	cadeia (de caracteres)	Nome de exibição para a regra de avaliação.	Não
ativado	Booleano	Indica se a regra de avaliação está habilitada. A predefinição é verdadeira.	Yes
eventType	objecto	Tipo de evento da regra de avaliação.	Yes
filtro	objecto	Modelo de filtro de avaliação.	Não
└─ agentName	cadeia (de caracteres)	Filtrar por nome de agente.	Não
id	cadeia (de caracteres)	Identificador exclusivo da regra de avaliação.	Yes
DadosDoSistema	objecto	Metadados do sistema para a regra de avaliação.	Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Regra de Avaliação

Código de status: 201

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

Tipo de conteúdo	Type	Descrição
application/json	Regra de Avaliação

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Taxonomias de avaliação - lista

GET {endpoint}/evaluationtaxonomies?api-version=2025-11-15-preview

Listar taxonomias de avaliação

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
inputName	consulta	Não	cadeia (de caracteres)	Filtre pelo nome de entrada da avaliação.
inputType	consulta	Não	cadeia (de caracteres)	Filtrar por tipo de entrada de taxonomia.
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	TaxonomiaAvaliaçãoPaged

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Taxonomias de avaliação - obter

GET {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

Obtenha uma avaliação executada pelo nome.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Taxonomia de Avaliação

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Taxonomias de avaliação - eliminar

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

Exclua uma taxonomia de avaliação pelo nome.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 204

Descrição: Não há conteúdo para enviar para esta 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	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Taxonomias de avaliação - criar

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

Crie uma taxonomia de avaliação.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome da taxonomia de avaliação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	O texto da descrição do ativo.	Não
propriedades	objecto	Propriedades adicionais para a taxonomia de avaliação.	Não
etiquetas	objecto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não
taxonomiaCategorias	matriz	Lista de categorias de taxonomia.	Não
taxonomiaEntrada	objecto	Configuração de entrada para a taxonomia de avaliação.	Yes
└─ tipo	AvaliaçãoTaxonomiaInputType	Tipo de entrada da taxonomia de avaliação.	Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Taxonomia de Avaliação

Código de status: 201

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

Tipo de conteúdo	Type	Descrição
application/json	Taxonomia de Avaliação

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Taxonomias de avaliação - atualização

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

Atualizar uma taxonomia de avaliação.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome da taxonomia de avaliação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	O texto da descrição do ativo.	Não
propriedades	objecto	Propriedades adicionais para a taxonomia de avaliação.	Não
etiquetas	objecto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não
taxonomiaCategorias	matriz	Lista de categorias de taxonomia.	Não
taxonomiaEntrada	objecto	Configuração de entrada para a taxonomia de avaliação.	Não
└─ tipo	AvaliaçãoTaxonomiaInputType	Tipo de entrada da taxonomia de avaliação.	Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Taxonomia de Avaliação

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Avaliadores - listar as versões mais recentes

GET {endpoint}/evaluators?api-version=2025-11-15-preview

Listar a versão mais recente de cada avaliador

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
tipo	consulta	Não		Filtre os avaliadores por tipo. Valores possíveis: 'all', 'custom', 'builtin'.
limit	consulta	Não	número 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
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	PagedEvaluatorVersion

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Avaliadores - versões por lista

GET {endpoint}/evaluators/{name}/versions?api-version=2025-11-15-preview

Listar todas as versões do avaliador

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso
tipo	consulta	Não		Filtre os avaliadores por tipo. Valores possíveis: 'all', 'custom', 'builtin'.
limit	consulta	Não	número 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
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	PagedEvaluatorVersion

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Avaliadores - criar versão

POST {endpoint}/evaluators/{name}/versions?api-version=2025-11-15-preview

Crie uma nova EvaluatorVersion com ID de versão incrementada automaticamente

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

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

Respostas

Código de status: 201

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

Tipo de conteúdo	Type	Descrição
application/json	EvaluatorVersion

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Avaliadores - obter versão

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso
versão	caminho	Yes	cadeia (de caracteres)	O id de versão específico do EvaluatorVersion a recuperar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	EvaluatorVersion

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Avaliadores - apagar versão

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

Exclua a versão específica do EvaluatorVersion. O serviço devolve 204 Sem Conteúdo se a EvaluatorVersion tiver sido eliminada com êxito ou se a EvaluatorVersion não existir.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso
versão	caminho	Yes	cadeia (de caracteres)	A versão do EvaluatorVersion para eliminar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 204

Descrição: Não há conteúdo para enviar para esta 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	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Avaliadores - versão atualizada

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso
versão	caminho	Yes	cadeia (de caracteres)	A versão do EvaluatorVersion a atualizar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

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

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	EvaluatorVersion

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Índices - lista mais recente

GET {endpoint}/indexes?api-version=2025-11-15-preview

Listar a versão mais recente de cada índice

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	PagedIndex

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Índices - versões por lista

GET {endpoint}/indexes/{name}/versions?api-version=2025-11-15-preview

Listar todas as versões do índice fornecido

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	PagedIndex

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Índices - obter versão

GET {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso
versão	caminho	Yes	cadeia (de caracteres)	O id de versão específico do índice a ser recuperado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Índice

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Índices - apagar versão

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

Exclua a versão específica do índice. O serviço retorna 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	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso
versão	caminho	Yes	cadeia (de caracteres)	A versão do índice a ser excluída.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 204

Descrição: Não há conteúdo para enviar para esta 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	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Índices - criar ou atualizar versão

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do recurso
versão	caminho	Yes	cadeia (de caracteres)	A ID de versão específica do índice a ser criado ou atualizado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Type-Content: application/merge-patch+json

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	O texto da descrição do ativo.	Não
etiquetas	objecto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não
tipo	objecto		Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Índice

Código de status: 201

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

Tipo de conteúdo	Type	Descrição
application/json	Índice

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Insights - gerar

POST {endpoint}/insights?api-version=2025-11-15-preview

Gerar Insights

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
Repetibilidade -Request-ID	cabeçalho	Não	cadeia (de caracteres)	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	cabeçalho	Não	cadeia (de caracteres)	Carimbo de data/hora que indica quando esta solicitação foi iniciada pela primeira vez. Usado em conjunto com repeatability-request-id para controle de idempotência.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
nome de exibição	cadeia (de caracteres)	Nome de exibição amigável para o insight.	Yes
id	cadeia (de caracteres)	O identificador exclusivo do relatório de insights.	Yes
metadados	objecto	Metadados sobre os insights.	Yes
└─ concluído At	cadeia (de caracteres)	O carimbo de data/hora quando as informações foram concluídas.	Não
└─ criadoEm	cadeia (de caracteres)	O carimbo de data/hora quando os insights foram criados.	Não
pedido	objecto	A solicitação do relatório de insights.	Yes
└─ tipo	InsightType	O tipo de pedido.	Não
Resultado	objecto	O resultado dos insights.	Não
└─ tipo	InsightType	O tipo de resultado de insights.	Não
state	objecto	Enum descrevendo estados de operação permitidos.	Yes

Respostas

Código de status: 201

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

Tipo de conteúdo	Type	Descrição
application/json	Visão

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Insights - lista

GET {endpoint}/insights?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
tipo	consulta	Não		Filtrar pelo tipo de análise.
evalId	consulta	Não	cadeia (de caracteres)	Filtrar pelo ID da avaliação.
runId	consulta	Não	cadeia (de caracteres)	Filtre pelo ID de execução da avaliação.
nome_agente	consulta	Não	cadeia (de caracteres)	Filtre pelo nome do agente.
incluiCoordenadas	consulta	Não	Booleano	Se as coordenadas para visualização devem ser incluídas na resposta. É definido para false por padrão.
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	PagedInsight

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Perspetivas - obter

GET {endpoint}/insights/{id}?api-version=2025-11-15-preview

Obtenha uma visão específica por Id.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
id	caminho	Yes	cadeia (de caracteres)	O identificador exclusivo do relatório de insights.
incluiCoordenadas	consulta	Não	Booleano	Se as coordenadas para visualização devem ser incluídas na resposta. É definido para false por padrão.
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Visão

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Criar armazenamento de memória

POST {endpoint}/memory_stores?api-version=2025-11-15-preview

Crie um armazenamento de memória.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
Definição	objecto	Definição de base para configurações de armazenamento de memória.	Yes
└─ amável	MemoryStoreKind	O tipo de armazenamento de memória.	Não
descrição	cadeia (de caracteres)	Uma descrição legível por humanos do armazenamento de memória.	Não
metadados	objecto	Metadados arbitrários de chave-valor a serem associados ao armazenamento de memória.	Não
nome	cadeia (de caracteres)	O nome do armazenamento de memória.	Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	MemoryStoreObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Listar Armazenamentos de Memória

GET {endpoint}/memory_stores?api-version=2025-11-15-preview

Liste todos os armazenamentos de memória.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
limit	consulta	Não	número 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.
order	consulta	Não	cadeia (de caracteres) Valores possíveis: `asc`, `desc`	Ordem de classificação pela marcação `created_at` de data e hora dos objetos. `asc` por ordem crescente e`desc` por ordem decrescente.
after	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `after` é um ID de objeto que define o 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 subsequente pode incluir after=obj_foo para obter a próxima página da lista.
antes	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `before` é um ID de objeto que define o 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 subsequente pode incluir before=obj_foo para obter a página anterior da lista.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	objecto	Os dados de resposta para uma lista solicitada de itens.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Atualização de memória

POST {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

Atualize um armazenamento de memória.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome da memória para atualizar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório	Predefinido
descrição	cadeia (de caracteres)	Uma descrição legível por humanos do armazenamento de memória.	Não
metadados	objecto	Metadados arbitrários de chave-valor a serem associados ao armazenamento de memória.	Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	MemoryStoreObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Obter memória

GET {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

Recupere um armazenamento de memória.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do armazenamento de memória a recuperar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	MemoryStoreObject

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Apagar armazenamento de memória

DELETE {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

Exclua um armazenamento de memória.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do armazenamento de memória a apagar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	DeleteMemoryStoreResponse

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Obtenha o resultado da atualização

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do armazenamento de memória.
update_id	caminho	Yes	cadeia (de caracteres)	O ID da operação de atualização de memória.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	MemoryStoreUpdateResponse

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Apagar memórias do telescópio

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do armazenamento de memória.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório	Predefinido
âmbito	cadeia (de caracteres)	O namespace que logicamente agrupa e isola memórias para eliminar, como um ID de utilizador.	Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	MemoryStoreDeleteScopeResponse

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Memórias de pesquisa

POST {endpoint}/memory_stores/{name}:search_memories?api-version=2025-11-15-preview

Procure memórias relevantes a partir de um armazenamento de memória com base no contexto da conversação.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome do armazenamento de memórias para pesquisar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
items	matriz	Itens para os quais procurar memórias relevantes.	Não
options	objecto	Opções de pesquisa de memória.	Não
└─ max_memories	número inteiro	Número máximo de itens de memória a serem retornados.	Não
previous_search_id	cadeia (de caracteres)	O ID exclusivo da solicitação de pesquisa anterior, permitindo a pesquisa de memória incremental de onde a última operação parou.	Não
âmbito	cadeia (de caracteres)	O namespace que agrupa e isola logicamente memórias, como um ID de usuário.	Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	MemoryStoreSearchResponse

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Atualizar memórias

POST {endpoint}/memory_stores/{name}:update_memories?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	O nome da memória para atualizar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório	Predefinido
items	matriz	Itens de conversação dos quais extrair memórias.	Não
previous_update_id	cadeia (de caracteres)	A ID exclusiva da solicitação de atualização anterior, permitindo atualizações incrementais de memória de onde a última operação parou.	Não
âmbito	cadeia (de caracteres)	O namespace que agrupa e isola logicamente memórias, como um ID de usuário.	Yes
update_delay	número 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 acionar imediatamente a atualização sem demora. O padrão é 300 (5 minutos).	Não	300

Respostas

Código de Estado: 202

Descrição: O pedido foi aceite para processamento, mas o processamento ainda não foi concluído.

Tipo de conteúdo	Type	Descrição
application/json	MemoryStoreUpdateResponse

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Cria conversa

POST {endpoint}/openai/conversations?api-version=2025-11-15-preview

Crie uma conversa.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório	Predefinido
items	matriz	Os itens iniciais incluem o contexto da conversa. Pode adicionar até 20 itens de cada vez.	Não
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.ConversationResource

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Conversas de lista

GET {endpoint}/openai/conversations?api-version=2025-11-15-preview

Devolve a lista de todas as conversas.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
limit	consulta	Não	número 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.
order	consulta	Não	cadeia (de caracteres) Valores possíveis: `asc`, `desc`	Ordem de classificação pela marcação `created_at` de data e hora dos objetos. `asc` por ordem crescente e`desc` por ordem decrescente.
after	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `after` é um ID de objeto que define o 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 subsequente pode incluir after=obj_foo para obter a próxima página da lista.
antes	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `before` é um ID de objeto que define o 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 subsequente pode incluir before=obj_foo para obter a página anterior da lista.
agent_name	consulta	Não	cadeia (de caracteres)	Filtrar por nome de agente. Se forem fornecidos, apenas os itens associados ao agente especificado serão devolvidos.
agent_id	consulta	Não	cadeia (de caracteres)	Filtrar por ID de agente no formato `name:version`. Se forem fornecidos, apenas os itens associados ao ID de agente especificado serão devolvidos.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	objecto	Os dados de resposta para uma lista solicitada de itens.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Conversa de atualização

POST {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

Atualizar uma conversa.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
conversation_id	caminho	Yes	cadeia (de caracteres)	O id da conversa para atualizar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório	Predefinido
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.ConversationResource

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Comece a conversar

GET {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

Recupera uma conversa.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
conversation_id	caminho	Yes	cadeia (de caracteres)	O id da conversa a recuperar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.ConversationResource

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Apagar conversa

DELETE {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

Apaga uma conversa.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
conversation_id	caminho	Yes	cadeia (de caracteres)	O id da conversa para apagar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.Deleted ConversationResource

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Criar elementos de conversa

POST {endpoint}/openai/conversations/{conversation_id}/items?api-version=2025-11-15-preview

Cria itens numa conversa com o ID indicado.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
conversation_id	caminho	Yes	cadeia (de caracteres)	O id da conversa em que o produto deve ser criado.
include	consulta	Não	matriz	Campos adicionais a incluir na resposta. Consulte o `include` parâmetro para listar os itens de Conversa para mais informações.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório	Predefinido
items	matriz	Os pontos a acrescentar à conversa. Pode adicionar até 20 itens de cada vez.	Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.ConversationItemList

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Listar itens de conversa

GET {endpoint}/openai/conversations/{conversation_id}/items?api-version=2025-11-15-preview

Liste todos os itens para uma conversa com o ID indicado.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
conversation_id	caminho	Yes	cadeia (de caracteres)	O ID da conversa onde os itens devem ser listados.
limit	consulta	Não	número 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.
order	consulta	Não	cadeia (de caracteres) Valores possíveis: `asc`, `desc`	Ordem de classificação pela marcação `created_at` de data e hora dos objetos. `asc` por ordem crescente e`desc` por ordem decrescente.
after	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `after` é um ID de objeto que define o 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 subsequente pode incluir after=obj_foo para obter a próxima página da lista.
antes	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `before` é um ID de objeto que define o 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 subsequente pode incluir before=obj_foo para obter a página anterior da lista.
item_type	consulta	Não		Filtrar por tipo de item. Se forem fornecidos, apenas os itens do tipo especificado serão devolvidos.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	objecto	Os dados de resposta para uma lista solicitada de itens.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Obtém assunto de conversa

GET {endpoint}/openai/conversations/{conversation_id}/items/{item_id}?api-version=2025-11-15-preview

Obtenha um único item de uma conversa com os IDs indicados.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
conversation_id	caminho	Yes	cadeia (de caracteres)	O ID da conversa que contém o item.
item_id	caminho	Yes	cadeia (de caracteres)	O ID do item da conversa a recuperar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.ItemResource

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Eliminar item de conversa

DELETE {endpoint}/openai/conversations/{conversation_id}/items/{item_id}?api-version=2025-11-15-preview

Apaga um item de uma conversa com os IDs indicados.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
conversation_id	caminho	Yes	cadeia (de caracteres)	O id da conversa de onde o item precisa de ser eliminado.
item_id	caminho	Yes	cadeia (de caracteres)	O ID do item da conversa para apagar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.ConversationResource

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Avaliações OpenAI - avaliações de listas

GET {endpoint}/openai/evals?api-version=2025-11-15-preview

Liste todas as avaliações Liste avaliações para um projeto.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
after	consulta	Não	cadeia (de caracteres)	Identificador da última execução da solicitação de paginação anterior.
limit	consulta	Não		Número de execuções a recuperar.
order	consulta	Não	cadeia (de caracteres) Valores possíveis: `asc`, `desc`	Ordem de classificação para execuções por carimbo de data/hora. Use `asc` para ordem crescente ou `desc` para ordem decrescente. O padrão é `asc`.
ordenar por	consulta	Não	cadeia (de caracteres) Valores possíveis: `created_at`, `updated_at`	Os Evals podem ser ordenados por hora de criação ou hora da última atualização. Utilização `created_at` Para a hora da criação ou `updated_at` para a última atualização.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	objecto	Os dados de resposta para uma lista solicitada de itens.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Avaliações OpenAI - criar avaliação

POST {endpoint}/openai/evals?api-version=2025-11-15-preview

Criar avaliação Crie a estrutura de uma avaliação que possa 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 dita 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. Suportamos vários tipos de classificadores e fontes de dados. Para mais informações, consulte o

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
configuração_fonte_dados	objecto	Um objeto CustomDataSourceConfig que define o esquema para a fonte de dados usada para as execuções de avaliação. Este esquema é usado para definir a forma dos dados que serão: - Usado para definir os seus critérios de teste e - Que dados são necessários ao criar uma execução	Yes
└─ incluir_esquema_exemplo	Booleano	Se o processo de avaliação deve esperar que você preencha o namespace de exemplo (ou seja, gerando respostas a partir da sua fonte de dados)	Não
└─ esquema_de_item	objecto	O esquema json para cada linha na fonte de dados.	Não
└─ metadados	objecto	Filtros de metadados para a fonte de dados de conclusão armazenada.	Não
└─ cenário	enumeração	Cenário de esquema de dados. Valores possíveis: `red_team`, `responses`, `traces`	Não
└─ tipo	enumeração	O tipo de objeto, que é sempre `label_model`. Valores possíveis: `azure_ai_source`	Não
metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia (de caracteres)	O nome da avaliação.	Não
propriedades	objecto	Conjunto de 16 pares chave-valor imutáveis que podem ser ligados a um objeto para armazenar informação adicional. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
critérios_teste	matriz	Uma lista de classificadores para todas as execuções de avaliação neste grupo. Os avaliadores podem fazer referência a variáveis na fonte de dados usando a 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

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Eval

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Avaliações OpenAI - eliminar avaliação

DELETE {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

Apagar uma avaliação Apagar uma avaliação.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
eval_id	caminho	Yes	cadeia (de caracteres)	O identificador da avaliação para eliminar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	DeleteEvalResponse

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Avaliações OpenAI - obter avaliação

GET {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

Faz uma avaliação Faz uma avaliação por ID.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
eval_id	caminho	Yes	cadeia (de caracteres)	O ID da avaliação que se pretende recuperar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Eval

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Avaliações OpenAI - avaliação atualizada

POST {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

Atualizar uma avaliação Atualizar certas propriedades de uma avaliação.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
eval_id	caminho	Yes	cadeia (de caracteres)	O identificador da avaliação a atualizar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia (de caracteres)		Não
propriedades	objecto	Conjunto de 16 pares chave-valor imutáveis que podem ser ligados a um objeto para armazenar informação adicional. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Eval

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Avaliações OpenAI - execuções por lista

GET {endpoint}/openai/evals/{eval_id}/runs?api-version=2025-11-15-preview

Obtenha uma lista de corridas para uma avaliação. Consiga uma lista de corridas para uma avaliação.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
eval_id	caminho	Yes	cadeia (de caracteres)	O ID da avaliação para o qual se deseja recuperar execuções.
after	consulta	Não	cadeia (de caracteres)	Identificador da última execução da solicitação de paginação anterior.
limit	consulta	Não		Número de execuções a recuperar.
order	consulta	Não	cadeia (de caracteres) Valores possíveis: `asc`, `desc`	Ordem de classificação para execuções por carimbo de data/hora. Use `asc` para ordem crescente ou `desc` para ordem decrescente. O padrão é `asc`.
estado	consulta	Não	cadeia (de caracteres) Valores possíveis: `queued`, `in_progress`, `completed`, `canceled`, `failed` . Filtrar execuções por status. Um de `queued`, `in_progress`, `failed`, `completed`, . `canceled`

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	objecto	Os dados de resposta para uma lista solicitada de itens.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Avaliações OpenAI - criar uma corrida de avaliação

POST {endpoint}/openai/evals/{eval_id}/runs?api-version=2025-11-15-preview

Criar avaliação, execução

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
eval_id	caminho	Yes	cadeia (de caracteres)	O ID da avaliação para a qual criar uma execução.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
fonte_de_dados	objecto	Um objeto JsonlRunDataSource que especifica um ficheiro JSONL que corresponde à avaliação.	Yes
└─ mensagens_de_entrada	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate ou OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReferência	Usado ao amostrar a partir de um modelo. Dita a estrutura das mensagens passadas para o modelo. Pode ser uma referência a uma trajetória pré-construída (ou seja, `item.input_trajectory`), ou um template com referências variáveis ao `item` namespace.	Não
└─ item_generation_params	RedTeamItemGenerationParams	Os parâmetros para geração de itens.	Não
└─ modelo	cadeia (de caracteres)	O nome do modelo a ser usado para gerar completações (por exemplo, "o3-mini").	Não
└─ parâmetros_de_amostragem	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Não
└─ fonte	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource ou OpenAI.EvalResponsesSource	Determina o que preenche o `item` namespace na fonte de dados desta execução.	Não
└─ Alvo	Target	A configuração alvo para a avaliação.	Não
└─ tipo	cadeia (de caracteres)	O discriminador de tipo de fonte de dados.	Não
metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia (de caracteres)	O nome da execução.	Não
propriedades	objecto	Conjunto de 16 pares chave-valor imutáveis que podem ser ligados a um objeto para armazenar informação adicional. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	EvalRun

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Avaliações OpenAI - eliminar a execução de avaliação

DELETE {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
eval_id	caminho	Yes	cadeia (de caracteres)	O ID da avaliação da qual excluir a execução.
run_id	caminho	Yes	cadeia (de caracteres)	A identificação da execução a ser eliminada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	DeleteEvalRunResponse

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Avaliações OpenAI - faça a avaliação correr

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

Faça uma avaliação por ID.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
eval_id	caminho	Yes	cadeia (de caracteres)	O ID da avaliação para o qual se deseja recuperar execuções.
run_id	caminho	Yes	cadeia (de caracteres)	O identificador da execução a ser recuperada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	EvalRun

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Avaliações OpenAI - cancelar execução de avaliação

POST {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

Cancelar a corrida de avaliação Cancelar uma execução de avaliação em curso.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
eval_id	caminho	Yes	cadeia (de caracteres)	O ID da avaliação cuja execução você deseja cancelar.
run_id	caminho	Yes	cadeia (de caracteres)	A identificação da execução a ser cancelada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	EvalRun

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Avaliações OpenAI - obtém itens de saída da avaliação

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}/output_items?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
eval_id	caminho	Yes	cadeia (de caracteres)
run_id	caminho	Yes	cadeia (de caracteres)	A ID da execução para recuperar itens de saída.
after	consulta	Não	cadeia (de caracteres)	Identificador da última execução da solicitação de paginação anterior.
limit	consulta	Não		Número de execuções a recuperar.
order	consulta	Não	cadeia (de caracteres) Valores possíveis: `asc`, `desc`	Ordem de classificação para execuções por carimbo de data/hora. Use `asc` para ordem crescente ou `desc` para ordem decrescente. O padrão é `asc`.
estado	consulta	Não	cadeia (de caracteres) Valores possíveis: `fail`, `pass`	Filtre os itens de saída por status. Usar `failed` para filtrar por saída falhada ou `pass` para filtrar pelos itens de saída passados.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	objecto	Os dados de resposta para uma lista solicitada de itens.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Avaliações OpenAI - obter o item de saída da avaliação

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
eval_id	caminho	Yes	cadeia (de caracteres)	O ID da avaliação para o qual se deseja recuperar execuções.
run_id	caminho	Yes	cadeia (de caracteres)	O identificador da execução a ser recuperada.
output_item_id	caminho	Yes	cadeia (de caracteres)	O ID do item de saída que deve ser recuperado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	EvalRunOutputItem

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Criar um trabalho de afinação fina

POST {endpoint}/openai/fine-tuning/jobs?api-version=2025-11-15-preview

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 da tarefa em fila, incluindo o estado da tarefa e o nome dos modelos afinados depois de concluídos.

Saiba mais sobre ajuste fino

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório	Predefinido
hiperparâmetros	objecto	Os hiperparâmetros usados para o trabalho de ajuste fino. Esse valor agora é preterido em favor de `method`, e deve ser passado sob o `method` parâmetro.	Não
└─ tamanho_do_lote (batch_size)	enumeração	Valores possíveis: `auto`	Não
└─ multiplicador_da_taxa_de_aprendizagem	enumeração	Valores possíveis: `auto`	Não
└─ n_epochs	enumeração	Valores possíveis: `auto`	Não
integrações	matriz	Uma lista de integrações para ativar para o seu trabalho de ajuste fino.	Não
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
método	Método OpenAI.FineTune	O método utilizado para o ajuste fino.	Não
modelo	string (ver modelos válidos abaixo)	O nome do modelo para ajuste. Pode selecionar uma das opções modelos suportados.	Yes
seed	número inteiro	A semente controla a reprodutibilidade do trabalho. Fornecer os mesmos parâmetros de semente e de trabalho deve produzir os mesmos resultados, mas poderá diferir em casos raros. Se uma semente não for especificada, uma será gerada para você.	Não
sufixo	cadeia (de caracteres)	Uma cadeia de até 64 caracteres pode ser adicionada ao nome do modelo personalizado. Por exemplo, um `suffix` de "custom-model-name" produziria um nome de modelo como `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`.	Não	Nenhum
ficheiro de treino	cadeia (de caracteres)	A ID de um arquivo carregado que contém dados de treinamento. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Além disso, você deve fazer o upload do seu arquivo com a finalidade `fine-tune`. O conteúdo do arquivo deve diferir dependendo se o modelo usa o chat, o formato de conclusão ou se o método de ajuste fino usa o formato de preferência. Consulte o guia de ajuste fino para obter mais detalhes.	Yes
ficheiro_de_validação	cadeia (de caracteres)	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 processo de afinação. Essas métricas podem ser visualizadas em O arquivo de resultados de ajuste fino. Os mesmos dados não devem estar presentes nos ficheiros de treino e de validação. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Você deve fazer o upload do seu arquivo com a finalidade `fine-tune`. Consulte o guia de ajuste fino para obter mais detalhes.	Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.FineTuningJob

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Listas de trabalhos de afinação fina paginados

GET {endpoint}/openai/fine-tuning/jobs?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
after	consulta	Não	cadeia (de caracteres)	Identificador do último trabalho da solicitação de paginação anterior.
limit	consulta	Não	número inteiro	Número de trabalhos de ajustamento a serem recuperados.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Recuperar o trabalho de afinação fina

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}?api-version=2025-11-15-preview

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

Saiba mais sobre ajuste fino

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
ID_de_tarefa_de_ajuste_fino	caminho	Yes	cadeia (de caracteres)	A ID do trabalho de ajuste fino.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.FineTuningJob

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Cancelar o trabalho de afinação fina

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/cancel?api-version=2025-11-15-preview

Cancele imediatamente um trabalho de afinamento.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
ID_de_tarefa_de_ajuste_fino	caminho	Yes	cadeia (de caracteres)	O ID do trabalho de ajuste de precisão a ser cancelado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.FineTuningJob

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Lista de pontos de controlo de tarefas de afinação

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=2025-11-15-preview

Lista os pontos de controlo para um trabalho de afinação.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
ID_de_tarefa_de_ajuste_fino	caminho	Yes	cadeia (de caracteres)	A ID do trabalho de ajuste fino para obter pontos de verificação.
after	consulta	Não	cadeia (de caracteres)	Identificador do último ID de ponto de verificação da solicitação de paginação anterior.
limit	consulta	Não	número inteiro	Número de pontos de verificação a recuperar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Lista de afinações de eventos de trabalho

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/events?api-version=2025-11-15-preview

Obtenha atualizações detalhadas sobre o estado para um trabalho de afinação.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
ID_de_tarefa_de_ajuste_fino	caminho	Yes	cadeia (de caracteres)	O ID da tarefa de ajuste fino para obter eventos.
after	consulta	Não	cadeia (de caracteres)	Identificador do último evento da solicitação de paginação anterior.
limit	consulta	Não	número inteiro	Número de eventos a recuperar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.ListFineTuningJobEventsResponse

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Pausa o ajuste fino

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/pause?api-version=2025-11-15-preview

Pausa um trabalho de afinação em curso.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
ID_de_tarefa_de_ajuste_fino	caminho	Yes	cadeia (de caracteres)	O ID da tarefa de ajuste fino a ser pausada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.FineTuningJob

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Trabalho de afinamento do currículo

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/resume?api-version=2025-11-15-preview

Retome uma tarefa de ajuste fino pausada.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
ID_de_tarefa_de_ajuste_fino	caminho	Yes	cadeia (de caracteres)	A ID do trabalho de ajuste fino a ser retomado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.FineTuningJob

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Criar resposta - criar fluxo de resposta

POST {endpoint}/openai/responses?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no seu Hub, use o formulário `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
Versão da API	consulta	Não	cadeia (de caracteres)	A versão da API a utilizar para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório	Predefinido
agente	AgentReference	O agente a usar para gerar a resposta.	Não
em segundo plano	Booleano	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas de fundo.	Não	Falso
conversa	string ou objeto		Não
include	matriz	Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Atualmente Os valores suportados são: - `code_interpreter_call.outputs`: Inclui as saídas de execução de código python Chamar itens na ferramenta de interpretação de código. - `computer_call_output.output.image_url`: Inclua URLs de imagens da saída de chamada do computador. - `file_search_call.results`: Incluir os resultados da pesquisa de a chamada da ferramenta de pesquisa de ficheiros. - `message.input_image.image_url`: Inclua urls de imagem da mensagem de entrada. - `message.output_text.logprobs`: Inclua logprobs com mensagens do assistente. - `reasoning.encrypted_content`: Inclui uma versão encriptada do raciocínio tokens em resultados de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em conversas com vários turnos ao usar a API de respostas sem estado (como quando o `store` parâmetro é definido como `false`, ou quando uma organização é inscritos no programa de retenção de dados zero).	Não
dados introduzidos	cadeia de caracteres ou matriz	Entradas de texto, imagem ou arquivo no modelo, usadas para gerar uma resposta. Saiba mais: - Entradas e saídas de texto - Entradas de imagem - Entradas de ficheiro - Gerir o estado da conversa - Chamada de função	Não
instructions	cadeia (de caracteres)	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao utilizar juntamente com `previous_response_id`, as instruções de uma etapa anterior a resposta não será transferida para a resposta seguinte. Isso simplifica para substituir mensagens do sistema (ou mensagens de desenvolvedor) em novas respostas.	Não
max_output_tokens	número inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
max_tool_calls	número inteiro	O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
modelo	cadeia (de caracteres)	O desdobramento do modelo a ser usado para a criação desta resposta.	Não
chamadas_de_ferramentas_em_paralelo	Booleano	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
previous_response_id	cadeia (de caracteres)	O ID único da resposta anterior dada ao modelo. Utilize esta opção para Crie conversas em vários turnos. Saiba mais sobre Gerir o estado de conversa.	Não
avisar	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis. Mais informações.	Não
reasoning	OpenAI.Reasoning	Apenas modelos da série O Opções de configuração para modelos de raciocínio.	Não
nível_de_serviço	OpenAI.ServiceTier	Nota: service_tier não se aplica ao Azure OpenAI.	Não
armazenar	Booleano	Se a resposta do modelo gerado deve ser armazenada para recuperação posterior via API.	Não	Verdade
fluxo	Booleano	Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente como é gerado usando eventos enviados pelo servidor. para mais informações.	Não	Falso
structured_inputs	objecto	As entradas estruturadas para a resposta que podem participar na substituição de modelos de prompt ou em ligações de argumentos de ferramenta.	Não
temperatura	número	Qual a temperatura de amostragem a utilizar, entre 0 e 2. Valores mais altos como 0,8 tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente, recomendamos alterar isto ou `top_p`, mas não ambos.	Não	1
enviar SMS	objecto	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Ver Entradas e saídas de texto e Saídas Estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
tool_choice	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject	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.	Não
Ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. As duas categorias de ferramentas que você pode fornecer ao modelo são: - Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o funcionalidades do modelo, como pesquisa de arquivos. - Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame seu próprio código.	Não
top_logprobs	número inteiro	Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis de serem retornados em cada posição de token, cada um com uma probabilidade em log associada.	Não
top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com probabilidade top_p massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade são considerados. Geralmente, recomendamos alterar isto ou `temperature`, mas não ambos.	Não	1
truncation	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: Se o contexto desta resposta e das anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará o resposta para se ajustar à janela de contexto, descartando itens de entrada. no meio da conversa. - `disabled` (padrão): se uma resposta do modelo exceder a janela de contexto tamanho para um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
utilizador	cadeia (de caracteres)	Saiba mais sobre as melhores práticas de segurança.	Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.Response
text/event-stream	OpenAI.ResponseStreamEvent

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Respostas da lista

GET {endpoint}/openai/responses?api-version=2025-11-15-preview

Devolve a lista de todas as respostas.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
limit	consulta	Não	número 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.
order	consulta	Não	cadeia (de caracteres) Valores possíveis: `asc`, `desc`	Ordem de classificação pela marcação `created_at` de data e hora dos objetos. `asc` por ordem crescente e`desc` por ordem decrescente.
after	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `after` é um ID de objeto que define o 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 subsequente pode incluir after=obj_foo para obter a próxima página da lista.
antes	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `before` é um ID de objeto que define o 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 subsequente pode incluir before=obj_foo para obter a página anterior da lista.
agent_name	consulta	Não	cadeia (de caracteres)	Filtrar por nome de agente. Se forem fornecidos, apenas os itens associados ao agente especificado serão devolvidos.
agent_id	consulta	Não	cadeia (de caracteres)	Filtrar por ID de agente no formato `name:version`. Se forem fornecidos, apenas os itens associados ao ID de agente especificado serão devolvidos.
conversation_id	consulta	Não	cadeia (de caracteres)	Filtrar por ID de conversa. Se forem fornecidos, apenas as respostas associadas à conversa especificada serão respondidas.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	objecto	Os dados de resposta para uma lista solicitada de itens.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Obtenha resposta - obtenha resposta fluxo

GET {endpoint}/openai/responses/{response_id}?api-version=2025-11-15-preview

Recupera uma resposta do modelo com a ID fornecida. Recupera uma resposta do modelo com o ID dado (resposta em streaming).

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no seu Hub, use o formulário `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
Versão da API	consulta	Não	cadeia (de caracteres)	A versão da API a utilizar para esta operação.
response_id	caminho	Yes	cadeia (de caracteres)
incluir[]	consulta	Não	matriz
fluxo	consulta	Não	Booleano
starting_after	consulta	Não	número inteiro
aceitar	cabeçalho	Não	cadeia (de caracteres) Valores possíveis: `text/event-stream`

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.Response
text/event-stream	OpenAI.ResponseStreamEvent

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Excluir resposta

DELETE {endpoint}/openai/responses/{response_id}?api-version=2025-11-15-preview

Apaga uma resposta modelo.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
response_id	caminho	Yes	cadeia (de caracteres)	O ID da resposta a eliminar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	DeleteResponseResult

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Cancelar resposta

POST {endpoint}/openai/responses/{response_id}/cancel?api-version=2025-11-15-preview

Cancela uma resposta de modelo.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
response_id	caminho	Yes	cadeia (de caracteres)	O ID da resposta para cancelar.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	OpenAI.Response

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Listar itens de entrada

GET {endpoint}/openai/responses/{response_id}/input_items?api-version=2025-11-15-preview

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
response_id	caminho	Yes	cadeia (de caracteres)
limit	consulta	Não	número 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.
order	consulta	Não	cadeia (de caracteres) Valores possíveis: `asc`, `desc`	Ordem de classificação pela marcação `created_at` de data e hora dos objetos. `asc` por ordem crescente e`desc` por ordem decrescente.
after	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `after` é um ID de objeto que define o 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 subsequente pode incluir after=obj_foo para obter a próxima página da lista.
antes	consulta	Não	cadeia (de caracteres)	Um cursor para uso na paginação. `before` é um ID de objeto que define o 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 subsequente pode incluir before=obj_foo para obter a página anterior da lista.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	objecto	Os dados de resposta para uma lista solicitada de itens.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	ApiErrorResponse

Redteams - lista

GET {endpoint}/redTeams/runs?api-version=2025-11-15-preview

Liste um redteam pelo nome.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	PagedRedTeam

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Redteams - obter

GET {endpoint}/redTeams/runs/{name}?api-version=2025-11-15-preview

Obtenha um redteam pelo nome.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
nome	caminho	Yes	cadeia (de caracteres)	Identificador da corrida da equipe vermelha.
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	RedTeam

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Redteams - criar

POST {endpoint}/redTeams/runs:run?api-version=2025-11-15-preview

Cria uma execução redteam.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório	Predefinido
Cenário de aplicação	cadeia (de caracteres)	Cenário de aplicação para a operação da equipe vermelha, para gerar ataques específicos do cenário.	Não
Estratégias de ataque	matriz	Lista de estratégias de ataque ou listas aninhadas de estratégias de ataque.	Não
nome de exibição	cadeia (de caracteres)	Nome da equipe vermelha executada.	Não
id	cadeia (de caracteres)	Identificador da corrida da equipe vermelha.	Yes
numTurns	número inteiro	Número de rondas de simulação.	Não
propriedades	objecto	Propriedades da equipa vermelha. Ao contrário das tags, as propriedades são somente add-only. Uma vez adicionada, uma propriedade não pode ser removida.	Não
riscoCategorias	matriz	Lista de categorias de risco para gerar objetivos de ataque.	Não
simulationOnly	Booleano	Apenas simulação ou simulação + avaliação. Default false, se true a verificação produz conversa e não resultado da avaliação.	Não	Falso
estado	cadeia (de caracteres)	Estatuto da equipa vermelha. Ele é definido por serviço e é somente leitura.	Não
etiquetas	objecto	Tags do time vermelho. Ao contrário das propriedades, as tags são totalmente mutáveis.	Não
destino	objecto	Classe abstrata para configuração de destino.	Yes
└─ tipo	cadeia (de caracteres)	Tipo de configuração do modelo.	Não

Respostas

Código de status: 201

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

Tipo de conteúdo	Type	Descrição
application/json	RedTeam

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Calendários - lista

GET {endpoint}/schedules?api-version=2025-11-15-preview

Listar todos os horários.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	PagedSchedule

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Horários - eliminar

DELETE {endpoint}/schedules/{id}?api-version=2025-11-15-preview

Excluir uma agenda.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
id	caminho	Yes	cadeia (de caracteres)	Identificador da agenda.
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 204

Descrição: Não há conteúdo para enviar para esta 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	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Horários - obter

GET {endpoint}/schedules/{id}?api-version=2025-11-15-preview

Obtenha um agendamento por id.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
id	caminho	Yes	cadeia (de caracteres)	Identificador da agenda.
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Horário

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Horários - criar ou atualizar

PUT {endpoint}/schedules/{id}?api-version=2025-11-15-preview

Crie ou atualize uma agenda por id.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
id	caminho	Yes	cadeia (de caracteres)	Identificador da agenda.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Órgão do Pedido

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	Descrição do horário.	Não
nome de exibição	cadeia (de caracteres)	Nome da agenda.	Não
ativado	Booleano	Status habilitado da agenda.	Yes
id	cadeia (de caracteres)	Identificador da agenda.	Yes
propriedades	objecto	Propriedades da programação. Ao contrário das tags, as propriedades são somente add-only. Uma vez adicionada, uma propriedade não pode ser removida.	Não
estadoDeProvisionamento	objecto	Agendar status de provisionamento.	Não
DadosDoSistema	objecto	Metadados do sistema para o recurso.	Yes
etiquetas	objecto	Tags da programação. Ao contrário das propriedades, as tags são totalmente mutáveis.	Não
tarefa	objecto	Agendar modelo de tarefa.	Yes
└─ Configuração	objecto	Configuração para a tarefa.	Não
└─ tipo	ScheduleTaskType	Tipo de tarefa.	Não
accionador	objecto	Modelo base para Trigger do cronograma.	Yes
└─ tipo	Tipo de Disparo	Tipo de gatilho.	Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	Horário

Código de status: 201

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

Tipo de conteúdo	Type	Descrição
application/json	Horário

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Horários - lista de corridas

GET {endpoint}/schedules/{id}/runs?api-version=2025-11-15-preview

Liste todas as execuções de agenda.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
id	caminho	Yes	cadeia (de caracteres)	Identificador da agenda.
ID de Pedido do Cliente X-MS	cabeçalho	Não		Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	PagedScheduleRun

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Horários - correr

GET {endpoint}/schedules/{scheduleId}/runs/{runId}?api-version=2025-11-15-preview

Obtenha uma agenda executada por id.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Endpoint do Projeto Foundry na forma `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Se só tiver um Projeto no seu Foundry Hub, ou para direcionar o Projeto padrão no 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 (de caracteres)	A versão da API a utilizar para esta operação.
scheduleId	caminho	Yes	cadeia (de caracteres)	Identificador da agenda.
runId	caminho	Yes	cadeia (de caracteres)	Identificador da execução da agenda.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	Exemplo: `Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Âmbito de aplicação: `https://ai.azure.com/.default`

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Descrição
application/json	ScheduleRun

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Descrição
application/json	Azure.Core.Foundations.ErrorResponse

Componentes

A2ATool

Um agente implementando o protocolo A2A.

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

AISearchIndexResource

Um recurso AI Search Index.

Nome	Tipo	Description	Obrigatório
filtro	cadeia (de caracteres)	cadeia de caracteres de filtro para recurso de pesquisa. Saiba mais aqui.	Não
index_asset_id	cadeia (de caracteres)	ID do ativo de índice para o recurso de pesquisa.	Não
nome_do_índice	cadeia (de caracteres)	O nome de um índice em um IndexResource anexado a esse agente.	Não
project_connection_id	cadeia (de caracteres)	Um ID de conexão de índice em um IndexResource anexado a este agente.	Não
tipo_de_consulta	objecto	Tipos de consulta disponíveis para a ferramenta Azure AI Search.	Não
top_k	número inteiro	Número de documentos a recuperar da pesquisa e apresentar ao modelo.	Não

AgentClusterInsightResult

Insights da análise de cluster de agentes.

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

AgentClusterInsightsRequest

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

Nome	Tipo	Description	Obrigatório
nome_agente	cadeia (de caracteres)	Identificador do agente.	Yes
modelConfiguration	objecto	Configuração do modelo utilizado na geração de insights.	Não
└─ modelDeploymentName	cadeia (de caracteres)	A implantação do modelo a ser avaliada. Aceita apenas o nome da implementação ou com o nome da ligação como `{connectionName}/<modelDeploymentName>`.	Não
tipo	enumeração	O tipo de pedido. Valores possíveis: `AgentClusterInsight`	Yes

AgentContainerObject

Os detalhes do contentor de uma versão específica de um agente.

Nome	Tipo	Description	Obrigatório
criado_em	cadeia (de caracteres)	O momento de criação do recipiente.	Yes
error_message	cadeia (de caracteres)	A mensagem de erro se o contentor não funcionar, se houver.	Não
max_replicas	número inteiro	O número máximo de réplicas para o contentor. A predefinição é 1.	Não
min_replicas	número inteiro	O número mínimo de réplicas para o contentor. A predefinição é 1.	Não
objecto	enumeração	O tipo de objeto, que é sempre 'agent.container'. Valores possíveis: `agent.container`	Yes
estado	objecto	Estado do contentor de uma versão específica de um agente.	Yes
updated_at	cadeia (de caracteres)	A última atualização do contentor.	Yes

AgentContainerOperationError

Os detalhes de erro da operação do contentor, se existirem.

Nome	Tipo	Description	Obrigatório
código	cadeia (de caracteres)	O código de erro da operação do contentor, se existir.	Yes
mensagem	cadeia (de caracteres)	A mensagem de erro da operação do contentor, se existir.	Yes
tipo	cadeia (de caracteres)	O tipo de erro da operação do contentor, se houver.	Yes

AgentContainerOperationObject

A operação de contentor para uma versão específica de um agente.

Nome	Tipo	Description	Obrigatório
agent_id	cadeia (de caracteres)	O ID do agente.	Yes
agent_version_id	cadeia (de caracteres)	O ID da versão do agente.	Yes
contentor	objecto	Os detalhes do contentor de uma versão específica de um agente.	Não
└─ created_at	cadeia (de caracteres)	O momento de criação do recipiente.	Não
└─ error_message	cadeia (de caracteres)	A mensagem de erro se o contentor não funcionar, se houver.	Não
└─ max_replicas	número inteiro	O número máximo de réplicas para o contentor. A predefinição é 1.	Não
└─ min_replicas	número inteiro	O número mínimo de réplicas para o contentor. A predefinição é 1.	Não
└─ objeto	enumeração	O tipo de objeto, que é sempre 'agent.container'. Valores possíveis: `agent.container`	Não
└─ estado	AgentContainerStatus	O estado do contentor de uma versão específica de um agente.	Não
└─ updated_at	cadeia (de caracteres)	A última atualização do contentor.	Não
erro	objecto	Os detalhes de erro da operação do contentor, se existirem.	Não
└─ código	cadeia (de caracteres)	O código de erro da operação do contentor, se existir.	Não
└─ mensagem	cadeia (de caracteres)	A mensagem de erro da operação do contentor, se existir.	Não
└─ tipo	cadeia (de caracteres)	O tipo de erro da operação do contentor, se houver.	Não
id	cadeia (de caracteres)	O ID da operação do contentor. Este id é um identificador único em todo o sistema.	Yes
estado	objecto	Estado da operação do contentor para uma versão específica de um agente.	Yes

AgentContainerOperationStatus

Estado da operação do contentor para uma versão específica de um agente.

Propriedade	valor
Descrição	Estado da operação do contentor para uma versão específica de um agente.
Type	cadeia (de caracteres)
Valores	`NotStarted` `InProgress` `Succeeded` `Failed`

AgentContainerStatus

Estado do contentor de uma versão específica de um agente.

Propriedade	valor
Descrição	Estado do contentor de uma versão específica de um agente.
Type	cadeia (de caracteres)
Valores	`Starting` `Running` `Stopping` `Stopped` `Failed` `Deleting` `Deleted` `Updating`

Definição de Agente

Discriminador para AgentDefinição

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

Valor do tipo	Schema
`workflow`	WorkflowAgentDefinition
`hosted`	HostedAgentDefinition
`container_app`	ContainerAppAgentDefinition
`prompt`	PromptAgentDefinição

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

ID do agente

Nome	Tipo	Description	Obrigatório
nome	cadeia (de caracteres)	O nome do agente.	Yes
tipo	enumeração	Valores possíveis: `agent_id`	Yes
versão	cadeia (de caracteres)	O identificador de versão do agente.	Yes

AgentKind

Propriedade	valor
Type	cadeia (de caracteres)
Valores	`prompt` `hosted` `container_app` `workflow`

AgentObject

Nome	Tipo	Description	Obrigatório
id	cadeia (de caracteres)	O identificador exclusivo do agente.	Yes
nome	cadeia (de caracteres)	O nome do agente.	Yes
objecto	enumeração	O tipo de objeto, que é sempre 'agente'. Valores possíveis: `agent`	Yes
versions	objecto	A última versão do agente.	Yes
└─ últimas	AgentVersionObject		Não

AgentProtocol

Propriedade	valor
Type	cadeia (de caracteres)
Valores	`activity_protocol` `responses`

AgentReference

Nome	Tipo	Description	Obrigatório
nome	cadeia (de caracteres)	O nome do agente.	Yes
tipo	enumeração	Valores possíveis: `agent_reference`	Yes
versão	cadeia (de caracteres)	O identificador de versão do agente.	Não

AgentTaxonomyInput

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

Nome	Tipo	Description	Obrigatório
riscoCategorias	matriz	Lista de categorias de risco a avaliar.	Yes
destino	objecto	Representa um destino especificando um agente de IA do Azure.	Yes
└─ nome	cadeia (de caracteres)	O identificador exclusivo do agente de IA do Azure.	Não
└─ tool_descriptions	matriz	Os parâmetros usados para controlar o comportamento de amostragem do agente durante a geração de texto.	Não
└─ tipo	enumeração	O tipo de alvo, sempre `azure_ai_agent`. Valores possíveis: `azure_ai_agent`	Não
└─ versão	cadeia (de caracteres)	A versão do agente de IA do Azure.	Não
tipo	enumeração	Tipo de entrada da taxonomia de avaliação. Valores possíveis: `agent`	Yes

AgenteTaxonomiaInputUpdate

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

Nome	Tipo	Description	Obrigatório
riscoCategorias	matriz	Lista de categorias de risco a avaliar.	Não
destino	objecto	Representa um destino especificando um agente de IA do Azure.	Não
└─ nome	cadeia (de caracteres)	O identificador exclusivo do agente de IA do Azure.	Não
└─ tool_descriptions	matriz	Os parâmetros usados para controlar o comportamento de amostragem do agente durante a geração de texto.	Não
└─ tipo	enumeração	O tipo de alvo, sempre `azure_ai_agent`. Valores possíveis: `azure_ai_agent`	Não
└─ versão	cadeia (de caracteres)	A versão do agente de IA do Azure.	Não
tipo	enumeração	Tipo de entrada da taxonomia de avaliação. Valores possíveis: `agent`	Não

AgentVersionObject

Nome	Tipo	Description	Obrigatório
criado_em	número inteiro	O carimbo de data/hora Unix (segundos) quando o agente foi criado.	Yes
Definição	Definição de Agente		Yes
descrição	cadeia (de caracteres)	Uma descrição do agente legível por humanos.	Não
id	cadeia (de caracteres)	O identificador exclusivo da versão do agente.	Yes
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
nome	cadeia (de caracteres)	O nome do agente. O nome pode ser usado para recuperar/atualizar/excluir o agente.	Yes
objecto	enumeração	O tipo de objeto, que é sempre 'agent.version'. Valores possíveis: `agent.version`	Yes
versão	cadeia (de caracteres)	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

AgenticIdentityCredentials

Definição de credenciais de identidade de agente

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

ApiErrorResponse

Resposta de erro para falhas de API.

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

ApiKeyCredentials

Definição de credencial de chave de API

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

RespostaCredencial de Ativos

Representa uma referência a um blob para consumo

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

Id do Ativo

Identificador de um ativo guardado.

Tipo: string

Estratégia de Ataque

Estratégias para ataques.

Propriedade	valor
Descrição	Estratégias para ataques.
Type	cadeia (de caracteres)
Valores	`easy` `moderate` `difficult` `ascii_art` `ascii_smuggler` `atbash` `base64` `binary` `caesar` `character_space` `jailbreak` `ansii_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
código	cadeia (de caracteres)	Um de um conjunto de códigos de erro definido pelo servidor.	Yes
details	matriz	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.	Não
innererror	objecto	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.	Não
└─ código	cadeia (de caracteres)	Um de um conjunto de códigos de erro definido pelo servidor.	Não
└─ innererror	Azure.Core.Foundations.InnerError	Erro interno.	Não
mensagem	cadeia (de caracteres)	Uma representação legível por humanos do erro.	Yes
destino	cadeia (de caracteres)	O alvo do erro.	Não

Azure.Core.Foundations.ErrorResponse

Uma resposta contendo detalhes do erro.

Nome	Tipo	Description	Obrigatório
erro	objecto	O objeto de erro.	Yes
└─ código	cadeia (de caracteres)	Um de um conjunto de códigos de erro definido pelo servidor.	Não
└─ detalhes	matriz	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.	Não
└─ innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.	Não
└─ mensagem	cadeia (de caracteres)	Uma representação legível por humanos do erro.	Não
└─ Alvo	cadeia (de caracteres)	O alvo do erro.	Não

Azure.Core.Foundations.InnerError

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

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

Azure.Core.Foundations.OperationState

Enum descrevendo estados de operação permitidos.

Propriedade	valor
Type	cadeia (de caracteres)
Valores	`NotStarted` `Running` `Succeeded` `Failed` `Canceled`

Azure.Core.uuid

Identificador Universalmente Único

Tipo: string

Formato: uuid

AzureAIAgentTarget

Representa um destino especificando um agente de IA do Azure.

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

AzureAIAgentTargetUpdate

Representa um destino especificando um agente de IA do Azure.

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

AzureAIAssistantTarget

Representa um alvo que especifica um endpoint Azure AI Assistant (Agent V1), incluindo o seu id.

Nome	Tipo	Description	Obrigatório
id	cadeia (de caracteres)	O identificador único do Azure AI Assistant.	Não
tool_descriptions	matriz	As descrições das ferramentas disponíveis para o assistente.	Yes
tipo	enumeração	O tipo de alvo, sempre `azure_ai_assistant`. Valores possíveis: `azure_ai_assistant`	Yes

AzureAIAssistantTargetUpdate

Representa um alvo que especifica um endpoint Azure AI Assistant (Agent V1), incluindo o seu id.

Nome	Tipo	Description	Obrigatório
id	cadeia (de caracteres)	O identificador único do Azure AI Assistant.	Não
tool_descriptions	matriz	As descrições das ferramentas disponíveis para o assistente.	Não
tipo	enumeração	O tipo de alvo, sempre `azure_ai_assistant`. Valores possíveis: `azure_ai_assistant`	Não

AzureAIEvaluator

Azure AI Evaluator definição para foundry evaluators.

Nome	Tipo	Description	Obrigatório
mapeamento de dados	objecto	O modelo a utilizar para a avaliação. Deve suportar resultados estruturados.	Não
evaluator_name	cadeia (de caracteres)	O nome do avaliador.	Yes
evaluator_version	cadeia (de caracteres)	A versão do avaliador.	Não
initialization_parameters	objecto	Os parâmetros de inicialização para a avaliação. Deve suportar resultados estruturados.	Não
nome	cadeia (de caracteres)	O nome do classificador.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `label_model`. Valores possíveis: `azure_ai_evaluator`	Yes

AzureAIModelTarget

Representa um alvo que especifica um modelo Azure AI para operações que requerem seleção de modelo.

Nome	Tipo	Description	Obrigatório
modelo	cadeia (de caracteres)	O identificador único do modelo Azure AI.	Não
parâmetros_de_amostragem	objecto	Representa um conjunto de parâmetros usados para controlar o comportamento de amostragem de um modelo de linguagem durante a geração de texto.	Não
└─ max_completion_tokens	número inteiro	O número máximo de fichas permitido na conclusão.	Não
└─ sementes	número inteiro	A semente aleatória da reprodutibilidade.	Não
└─ temperatura	número	O parâmetro de temperatura para amostragem.	Não
└─ top_p	número	O parâmetro top-p para amostragem de núcleos.	Não
tipo	enumeração	O tipo de alvo, sempre `azure_ai_model`. Valores possíveis: `azure_ai_model`	Yes

AzureAIModelTargetUpdate

Representa um alvo que especifica um modelo Azure AI para operações que requerem seleção de modelo.

Nome	Tipo	Description	Obrigatório
modelo	cadeia (de caracteres)	O identificador único do modelo Azure AI.	Não
parâmetros_de_amostragem	objecto	Representa um conjunto de parâmetros usados para controlar o comportamento de amostragem de um modelo de linguagem durante a geração de texto.	Não
└─ max_completion_tokens	número inteiro	O número máximo de fichas permitido na conclusão.	Não
└─ sementes	número inteiro	A semente aleatória da reprodutibilidade.	Não
└─ temperatura	número	O parâmetro de temperatura para amostragem.	Não
└─ top_p	número	O parâmetro top-p para amostragem de núcleos.	Não
tipo	enumeração	O tipo de alvo, sempre `azure_ai_model`. Valores possíveis: `azure_ai_model`	Não

AzureAIRedTeam

Nome	Tipo	Description	Obrigatório
item_generation_params	objecto	Representa os parâmetros para a geração de itens da equipa vermelha.	Yes
└─ attack_strategies	matriz	A coleção de estratégias de ataque a utilizar.	Não
└─ num_turns	número inteiro	O número de turnos permitidos no jogo.	Não
└─ tipo	enumeração	O tipo de parâmetros de geração de itens, sempre `red_team`. Valores possíveis: `red_team`	Não
destino	objecto	Classe base para alvos com suporte a discriminadores.	Yes
└─ tipo	cadeia (de caracteres)	O tipo de alvo.	Não
tipo	enumeração	O tipo de fonte de dados. Sempre `azure_ai_red_team`. Valores possíveis: `azure_ai_red_team`	Yes

AzureAIRrespondses

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 (de caracteres)	O nome da configuração do evento associado a esta avaliação executa-se.	Yes
item_generation_params	objecto	Representa os parâmetros para a geração contínua de itens.	Yes
└─ data_mapping	objecto	Mapeamento dos campos de origem para response_id campo, necessário para recuperar o histórico de conversas.	Não
└─ max_num_turns	número inteiro	O número máximo de turnos do histórico de chat a avaliar.	Não
└─ fonte	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource	A fonte de onde o conteúdo JSONL é lido.	Não
└─ tipo	enumeração	O tipo de parâmetros de geração de itens, sempre `ResponseRetrieval`. Valores possíveis: `response_retrieval`	Não
max_runs_hourly	número inteiro	Número máximo de avaliações permitidas por hora.	Yes
tipo	enumeração	O tipo de fonte de dados, sempre `AzureAIResponses`. Valores possíveis: `azure_ai_responses`	Yes

AzureAISearchAgentTool

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

Nome	Tipo	Description	Obrigatório
azure_ai_search	objecto	Um conjunto de recursos de índice usados pela ferramenta `azure_ai_search`.	Yes
└─ índices	matriz	Os índices ligados a este agente. Pode haver um máximo de 1 índice recurso associado ao agente.	Não
tipo	enumeração	O tipo de objeto, que é sempre 'azure_ai_search'. Valores possíveis: `azure_ai_search`	Yes

AzureAISearchIndex

Definição de Índice de Pesquisa do Azure AI

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	Tipo de índice Valores possíveis: `AzureSearch`	Yes

AzureAISearchIndexUpdate

Definição de Índice de Pesquisa do Azure AI

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	Tipo de índice Valores possíveis: `AzureSearch`	Yes

AzureAISearchQueryType

Tipos de consulta disponíveis para a ferramenta Azure AI Search.

Propriedade	valor
Descrição	Tipos de consulta disponíveis para a ferramenta Azure AI Search.
Type	cadeia (de caracteres)
Valores	`simple` `semantic` `vector` `vector_simple_hybrid` `vector_semantic_hybrid`

AzureAISearchToolResource

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

Nome	Tipo	Description	Obrigatório	Predefinido
índices	matriz	Os índices ligados a este agente. Pode haver um máximo de 1 índice recurso associado ao agente.	Yes

AzureAISource

Nome	Tipo	Description	Obrigatório	Predefinido
cenário	enumeração	Cenário de esquema de dados. Valores possíveis: `red_team`, `responses`, `traces`	Yes
tipo	enumeração	O tipo de objeto, que é sempre `label_model`. Valores possíveis: `azure_ai_source`	Yes

AzureFunctionAgentTool

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

Nome	Tipo	Description	Obrigatório
azure_function	objecto	A definição da função do Azure.	Yes
└─ Função	objecto	A definição da função azure e seus parâmetros.	Não
└─ Descrição	cadeia (de caracteres)	Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função.	Não
└─ nome	cadeia (de caracteres)	O nome da função a ser chamada.	Não
└─ parâmetros		Os parâmetros que as funções aceitam, descritos como um objeto de esquema JSON.	Não
└─ 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 ele.	Não
└─ 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.	Não
tipo	enumeração	O tipo de objeto, que é sempre 'browser_automation'. Valores possíveis: `azure_function`	Yes

AzureFunctionBinding

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

Nome	Tipo	Description	Obrigatório
storage_queue	objecto	A estrutura para manter o nome da fila de armazenamento e o URI.	Yes
└─ queue_name	cadeia (de caracteres)	O nome de uma fila de armazenamento de função do Azure.	Não
└─ queue_service_endpoint	cadeia (de caracteres)	URI para o serviço de Fila de Armazenamento do Azure permitindo manipular uma fila.	Não
tipo	enumeração	O tipo de ligação, que é sempre «storage_queue». Valores possíveis: `storage_queue`	Yes

AzureFunctionDefinition

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

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

AzureFunctionStorageQueue

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

Nome	Tipo	Description	Obrigatório	Predefinido
queue_name	cadeia (de caracteres)	O nome de uma fila de armazenamento de função do Azure.	Yes
queue_service_endpoint	cadeia (de caracteres)	URI para o serviço de Fila de Armazenamento do Azure permitindo manipular uma fila.	Yes

AzureOpenAIModelConfiguration

Configuração do modelo do Azure OpenAI. A versão da API seria selecionada pelo serviço para consultar o modelo.

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

BaseCredentials

Uma classe base para credenciais de conexão

Discriminador para BaseCredentials

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

Valor do tipo	Schema
`ApiKey`	ApiKeyCredentials
`AAD`	EntraIDCredentials
`CustomKeys`	CustomCredential
`SAS`	SASCredentiais
`None`	NoAuthenticationCredentials
`AgenticIdentityToken`	AgenticIdentityCredentials

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	objecto	O tipo de credencial usado pela conexão	Yes

BingCustomSearchAgentTool

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

Nome	Tipo	Description	Obrigatório
bing_custom_search_preview	objecto	Os parâmetros da ferramenta de pesquisa personalizada do Bing.	Yes
└─ search_configurations	matriz	As conexões do projeto anexadas a esta ferramenta. Pode haver um máximo de 1 ligação recurso associado à ferramenta.	Não
tipo	enumeração	O tipo de objeto, que é sempre 'bing_custom_search'. Valores possíveis: `bing_custom_search_preview`	Yes

BingCustomSearchConfiguração

Uma configuração de pesquisa personalizada do Bing.

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

BingCustomSearchToolParameters

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

Nome	Tipo	Description	Obrigatório	Predefinido
search_configurations	matriz	As conexões do projeto anexadas a esta ferramenta. Pode haver um máximo de 1 ligação recurso associado à ferramenta.	Yes

BingGroundingAgentTool

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

Nome	Tipo	Description	Obrigatório
bing_grounding	objecto	Os parâmetros da ferramenta de pesquisa de aterramento do Bing.	Yes
└─ search_configurations	matriz	As configurações de pesquisa anexadas a esta ferramenta. Pode haver um máximo de 1 Pesquise recurso de configuração associado à ferramenta.	Não
tipo	enumeração	O tipo de objeto, que é sempre 'bing_grounding'. Valores possíveis: `bing_grounding`	Yes

BingGroundingSearchConfiguração

Configuração de pesquisa para o Bing Grounding

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

BingGroundingSearchToolParameters

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

Nome	Tipo	Description	Obrigatório	Predefinido
search_configurations	matriz	As configurações de pesquisa anexadas a esta ferramenta. Pode haver um máximo de 1 Pesquise recurso de configuração associado à ferramenta.	Yes

BlobReference

Detalhes de referência do Blob.

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

BrowserAutomationAgentTool

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	objecto	Definição de parâmetros de entrada para a Browser Automation Tool.	Yes
└─ Ligação	BrowserAutomationToolConnectionParameters	Os parâmetros de conexão do projeto associados à Ferramenta de Automação do Navegador.	Não
tipo	enumeração	O tipo de objeto, que é sempre 'browser_automation'. Valores possíveis: `browser_automation_preview`	Yes

BrowserAutomationToolConnectionParameters

Definição de parâmetros de entrada para a conexão usada pela Browser Automation Tool.

Nome	Tipo	Description	Obrigatório	Predefinido
project_connection_id	cadeia (de caracteres)	A ID da conexão do projeto com seu recurso do Azure Playwright.	Yes

BrowserAutomationToolParameters

Definição de parâmetros de entrada para a Browser Automation Tool.

Nome	Tipo	Description	Obrigatório	Predefinido
ligação	objecto	Definição de parâmetros de entrada para a conexão usada pela Browser Automation Tool.	Yes
└─ project_connection_id	cadeia (de caracteres)	A ID da conexão do projeto com seu recurso do Azure Playwright.	Não

CaptureStructuredOutputsTool

Uma ferramenta para capturar saídas estruturadas

Nome	Tipo	Description	Obrigatório
saídas	objecto	Uma saída estruturada que pode ser produzida pelo agente.	Yes
└─ Descrição	cadeia (de caracteres)	Uma descrição da saída a emitir. Usado pelo modelo para determinar quando emitir a saída.	Não
└─ nome	cadeia (de caracteres)	O nome da saída estruturada.	Não
└─ esquema		O esquema JSON para a saída estruturada.	Não
└─ rigoroso	Booleano	Se a validação estrita deve ser imposta. Padrão `true`.	Não
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
tamanho	número inteiro	Tamanho do elemento gráfico.	Yes
x	número inteiro	Coordenada do eixo X.	Yes
y	número inteiro	Coordenada do eixo Y.	Yes

ChatResumoMemóriaItemMemória

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

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	O tipo do item de memória. Valores possíveis: `chat_summary`	Yes

ClusterInsightResult

Insights da análise de cluster.

Nome	Tipo	Description	Obrigatório
clusters	matriz	Lista de clusters identificados nos insights.	Yes
coordenadas	objecto	Mapeamento opcional de IDs para coordenadas 2D usadas pela UX para visualização. As chaves de mapa são identificadores de string (por exemplo, um id de cluster ou um id de amostra) e os valores são as coordenadas e o tamanho visual para renderização num gráfico 2D. Esta propriedade é omitida a menos que o cliente solicite coordenadas (por exemplo, passando `includeCoordinates=true` como 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 destinam-se apenas à visualização do lado do cliente e não o fazem Modificar os resultados dos insights canónicos.	Não
resumo	objecto	Resumo da análise de cluster de erros.	Yes
└─ Método	cadeia (de caracteres)	Método utilizado para agrupamento.	Não
└─ contagem de amostras	número inteiro	Número total de amostras analisadas.	Não
└─ uniqueClusterCount	número inteiro	Número total de clusters exclusivos.	Não
└─ uniqueSubclusterCount	número inteiro	Número total de rótulos de subcluster exclusivos.	Não
└─ utilização	ClusterTokenUsage	Uso de token durante a execução da análise de clustering	Não

ClusterTokenUsage

Uso de token para análise de cluster

Nome	Tipo	Description	Obrigatório
inputTokenUsage	número inteiro	Uso do token de entrada	Yes
outputTokenUsage	número inteiro	Uso do token de saída	Yes
totalTokenUsage	número inteiro	Utilização total de tokens	Yes

CodeBasedEvaluatorDefinition

Definição do avaliador baseado em código usando código python

Nome	Tipo	Description	Obrigatório	Predefinido
code_text	cadeia (de caracteres)	Texto de código embutido para o avaliador	Yes
tipo	enumeração	Valores possíveis: `code`	Yes

Conexão

Resposta da lista e obter operações de conexões

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

Tipo de conexão

O tipo (ou categoria) da conexão

Propriedade	valor
Descrição	O tipo (ou categoria) da conexão
Type	cadeia (de caracteres)
Valores	`AzureOpenAI` `AzureBlob` `AzureStorageAccount` `CognitiveSearch` `CosmosDB` `ApiKey` `AppConfig` `AppInsights` `CustomKeys` `RemoteTool`

ContainerAppAgentDefinition

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

Nome	Tipo	Description	Obrigatório
container_app_resource_id	cadeia (de caracteres)	A ID do recurso do Aplicativo de Contêiner do Azure que hospeda esse agente. Não mutável entre versões.	Yes
container_protocol_versions	matriz	Os protocolos que o agente suporta para comunicação de entrada dos contêineres.	Yes
ingress_subdomain_suffix	cadeia (de caracteres)	O sufixo a ser aplicado ao subdomínio do aplicativo ao enviar entrada para o agente. Pode ser um rótulo (por exemplo, '---atual'), uma revisão específica (por exemplo, '--0000001') ou vazio para usar o ponto de extremidade padrão para o aplicativo contêiner.	Yes
tipo	enumeração	Valores possíveis: `container_app`	Yes

ContinuousEvalItemGenerationParams

Representa os parâmetros para a geração contínua de itens.

Nome	Tipo	Description	Obrigatório
mapeamento de dados	objecto	Mapeamento dos campos de origem para response_id campo, necessário para recuperar o histórico de conversas.	Yes
max_num_turns	número inteiro	O número máximo de turnos do histórico de chat a avaliar.	Yes
origem	objecto		Yes
└─ conteúdo	matriz	O conteúdo do arquivo jsonl.	Não
└─ ID	cadeia (de caracteres)	O identificador do arquivo.	Não
└─ tipo	enumeração	O tipo de fonte jsonl. Sempre `file_id`. Valores possíveis: `file_id`	Não
tipo	enumeração	O tipo de parâmetros de geração de itens, sempre `ResponseRetrieval`. Valores possíveis: `response_retrieval`	Yes

RegragraAvaliação Contínua

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

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

CosmosDBIndex

Definição de índice do CosmosDB Vetor Store

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	Tipo de índice Valores possíveis: `CosmosDBNoSqlVectorStore`	Yes

CosmosDBIndexUpdate

Definição de índice do CosmosDB Vetor Store

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	Tipo de índice Valores possíveis: `CosmosDBNoSqlVectorStore`	Yes

CreateAgentFromManifestRequest

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	Uma descrição do agente legível por humanos.	Não
manifest_id	cadeia (de caracteres)	O ID do manifesto para importar a versão do agente.	Yes
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia (de caracteres)	O nome único que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve começar e terminar com caracteres alfanuméricos, - Pode conter hífenes no meio - Não deve exceder 63 caracteres.	Yes
parameter_values	objecto	As entradas para o manifesto resultarão num Agente totalmente materializado.	Yes

CreateAgentRequest

Nome	Tipo	Description	Obrigatório
Definição	objecto		Yes
└─ amável	AgentKind		Não
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo de IA Responsável (RAI) e recursos de segurança.	Não
descrição	cadeia (de caracteres)	Uma descrição do agente legível por humanos.	Não
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia (de caracteres)	O nome único que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve começar e terminar com caracteres alfanuméricos, - Pode conter hífenes no meio - Não deve exceder 63 caracteres.	Yes

CreateAgentVersionFromManifestRequest

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	Uma descrição do agente legível por humanos.	Não
manifest_id	cadeia (de caracteres)	O ID do manifesto para importar a versão do agente.	Yes
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
parameter_values	objecto	As entradas para o manifesto resultarão num Agente totalmente materializado.	Yes

CreateAgentVersionRequest

Nome	Tipo	Description	Obrigatório
Definição	objecto		Yes
└─ amável	AgentKind		Não
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo de IA Responsável (RAI) e recursos de segurança.	Não
descrição	cadeia (de caracteres)	Uma descrição do agente legível por humanos.	Não
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

CriarPedidoAvaliação

Nome	Tipo	Description	Obrigatório
configuração_fonte_dados	objecto	Um objeto CustomDataSourceConfig que define o esquema para a fonte de dados usada para as execuções de avaliação. Este esquema é usado para definir a forma dos dados que serão: - Usado para definir os seus critérios de teste e - Que dados são necessários ao criar uma execução	Yes
└─ incluir_esquema_exemplo	Booleano	Se o processo de avaliação deve esperar que você preencha o namespace de exemplo (ou seja, gerando respostas a partir da sua fonte de dados)	Não
└─ esquema_de_item	objecto	O esquema json para cada linha na fonte de dados.	Não
└─ metadados	objecto	Filtros de metadados para a fonte de dados de conclusão armazenada.	Não
└─ cenário	enumeração	Cenário de esquema de dados. Valores possíveis: `red_team`, `responses`, `traces`	Não
└─ tipo	enumeração	O tipo de objeto, que é sempre `label_model`. Valores possíveis: `azure_ai_source`	Não
metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia (de caracteres)	O nome da avaliação.	Não
propriedades	objecto	Conjunto de 16 pares chave-valor imutáveis que podem ser ligados a um objeto para armazenar informação adicional. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
critérios_teste	matriz	Uma lista de classificadores para todas as execuções de avaliação neste grupo. Os avaliadores podem fazer referência a variáveis na fonte de dados usando a 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

CriarSolicitaçãoDeExecuçãoDeAvaliação

Nome	Tipo	Description	Obrigatório
fonte_de_dados	objecto	Um objeto JsonlRunDataSource que especifica um ficheiro JSONL que corresponde à avaliação.	Yes
└─ mensagens_de_entrada	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate ou OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReferência	Usado ao amostrar a partir de um modelo. Dita a estrutura das mensagens passadas para o modelo. Pode ser uma referência a uma trajetória pré-construída (ou seja, `item.input_trajectory`), ou um template com referências variáveis ao `item` namespace.	Não
└─ item_generation_params	RedTeamItemGenerationParams	Os parâmetros para geração de itens.	Não
└─ modelo	cadeia (de caracteres)	O nome do modelo a ser usado para gerar completações (por exemplo, "o3-mini").	Não
└─ parâmetros_de_amostragem	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Não
└─ fonte	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource ou OpenAI.EvalResponsesSource	Determina o que preenche o `item` namespace na fonte de dados desta execução.	Não
└─ Alvo	Target	A configuração alvo para a avaliação.	Não
└─ tipo	cadeia (de caracteres)	O discriminador de tipo de fonte de dados.	Não
metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia (de caracteres)	O nome da execução.	Não
propriedades	objecto	Conjunto de 16 pares chave-valor imutáveis que podem ser ligados a um objeto para armazenar informação adicional. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

Criado Por

Nome	Tipo	Description	Obrigatório
agente	objecto		Não
└─ nome	cadeia (de caracteres)	O nome do agente.	Não
└─ tipo	enumeração	Valores possíveis: `agent_id`	Não
└─ versão	cadeia (de caracteres)	O identificador de versão do agente.	Não
response_id	cadeia (de caracteres)	A resposta sobre a qual o item é criado.	Não

Tipo de credencial

O tipo de credencial usado pela conexão

Propriedade	valor
Descrição	O tipo de credencial usado pela conexão
Type	cadeia (de caracteres)
Valores	`ApiKey` `AAD` `SAS` `CustomKeys` `None` `AgenticIdentityToken`

CronTrigger

Gatilho baseado em Cron.

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

CustomCredential

Definição de credencial personalizada

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

DailyRecurrenceSchedule

Esquema diário de recorrência.

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

DatasetType

Enum para determinar o tipo de dados.

Propriedade	valor
Descrição	Enum para determinar o tipo de dados.
Type	cadeia (de caracteres)
Valores	`uri_file` `uri_folder`

DatasetVersion

Definição de DatasetVersion

Discriminador para DatasetVersion

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

Valor do tipo	Schema
`uri_file`	FileDatasetVersion
`uri_folder`	FolderDatasetVersion

Nome	Tipo	Description	Obrigatório
nome_da_conexão	cadeia (de caracteres)	O nome de conexão da Conta de Armazenamento do Azure. Necessário se startPendingUploadVersion não foi chamado antes de criar o Dataset	Não
dataUri	cadeia (de caracteres)	URI dos dados (exemplo)	Yes
id	cadeia (de caracteres)	ID do ativo, um identificador exclusivo para o ativo	Não
isReference	Booleano	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 verdadeiro, os dados subjacentes não serão excluídos quando a versão do conjunto de dados for excluída	Não
nome	cadeia (de caracteres)	O nome do recurso	Yes
tipo	objecto	Enum para determinar o tipo de dados.	Yes
versão	cadeia (de caracteres)	A versão do recurso	Yes

DatasetVersionUpdate

Definição de DatasetVersion

Discriminador para DatasetVersionUpdate

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

Valor do tipo	Schema
`uri_file`	FileDatasetVersionUpdate
`uri_folder`	FolderDatasetVersionUpdate

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	O texto da descrição do ativo.	Não
etiquetas	objecto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não
tipo	objecto	Enum para determinar o tipo de dados.	Yes

Dia da Semana

Dias da semana para esquema de recorrência.

Propriedade	valor
Descrição	Dias da semana para esquema de recorrência.
Type	cadeia (de caracteres)
Valores	`Sunday` `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday`

DeleteAgentResponse

Um objeto de agente excluído

Nome	Tipo	Description	Obrigatório
Suprimido	Booleano	Se o agente foi excluído com êxito.	Yes
nome	cadeia (de caracteres)	O nome do agente.	Yes
objecto	enumeração	O tipo de objeto. Sempre 'agent.deleted'. Valores possíveis: `agent.deleted`	Yes

DeleteAgentVersionResponse

Um objeto de versão de agente excluído

Nome	Tipo	Description	Obrigatório
Suprimido	Booleano	Se o agente foi excluído com êxito.	Yes
nome	cadeia (de caracteres)	O nome do agente.	Yes
objecto	enumeração	O tipo de objeto. Sempre 'agent.deleted'. Valores possíveis: `agent.version.deleted`	Yes
versão	cadeia (de caracteres)	O identificador de versão do agente.	Yes

DeleteEvalResponse

Um Objeto de avaliação eliminado

Nome	Tipo	Description	Obrigatório
Suprimido	Booleano	Se a avaliação foi eliminada com sucesso.	Yes
eval_id	cadeia (de caracteres)	ID da avaliação.	Yes
objecto	enumeração	O tipo de objeto. Sempre 'eval.deleted'. Valores possíveis: `eval.deleted`	Yes

DeleteEvalRunResponse

Uma avaliação eliminada executa Object.

Nome	Tipo	Description	Obrigatório
Suprimido	Booleano	Se a avaliação foi eliminada com sucesso.	Não
objecto	enumeração	O tipo de objeto. Sempre 'eval.deleted'. Valores possíveis: `eval.deleted`	Não
run_id	cadeia (de caracteres)	ID da avaliação.	Não

DeleteMemoryStoreResponse

Nome	Tipo	Description	Obrigatório
Suprimido	Booleano	Se o armazenamento de memória foi excluído com êxito.	Yes
nome	cadeia (de caracteres)	O nome do armazenamento de memória.	Yes
objecto	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 eliminação.

Nome	Tipo	Description	Obrigatório
Suprimido	enumeração	Volta sempre fiel Valores possíveis: `True`	Yes
id	cadeia (de caracteres)	O ID da operação.	Yes
objecto	enumeração	Devolva sempre a palavra 'resposta'. Valores possíveis: `response`	Yes

Implantação

Definição de implantação de modelo

Discriminador para Implantação

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

Valor do tipo	Schema
`ModelDeployment`	ModelDeployment

Nome	Tipo	Description	Obrigatório	Predefinido
nome	cadeia (de caracteres)	Nome da implantação	Yes
tipo	objecto		Yes

Tipo de implantação

Propriedade	valor
Type	cadeia (de caracteres)
Valores	`ModelDeployment`

EntraIDCredentials

Definição de credenciais do Entra ID

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

Avaliação

Um objeto Eval com uma configuração de fonte de dados e critérios de teste. Um Eval representa uma tarefa para realizar na integração do seu 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 no meu caso de uso do que o gpt-4o

Nome	Tipo	Description	Obrigatório
criado_em	objecto		Yes
criado_por	cadeia (de caracteres)	o nome da pessoa que criou a corrida.	Não
configuração_fonte_dados	objecto	Um objeto CustomDataSourceConfig que define o esquema para a fonte de dados usada para as execuções de avaliação. Este esquema é usado para definir a forma dos dados que serão: - Usado para definir os seus critérios de teste e - Que dados são necessários ao criar uma execução	Yes
└─ incluir_esquema_exemplo	Booleano	Se o processo de avaliação deve esperar que você preencha o namespace de exemplo (ou seja, gerando respostas a partir da sua fonte de dados)	Não
└─ esquema_de_item	objecto	O esquema json para cada linha na fonte de dados.	Não
└─ metadados	objecto	Filtros de metadados para a fonte de dados de conclusão armazenada.	Não
└─ cenário	enumeração	Cenário de esquema de dados. Valores possíveis: `red_team`, `responses`, `traces`	Não
└─ tipo	enumeração	O tipo de objeto, que é sempre `label_model`. Valores possíveis: `azure_ai_source`	Não
id	cadeia (de caracteres)	Identificador único para a avaliação.	Yes
metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
modified_at	objecto		Não
nome	cadeia (de caracteres)	O nome da avaliação.	Yes
objecto	enumeração	O tipo de objeto. Valores possíveis: `eval`	Yes
propriedades	objecto	Conjunto de 16 pares chave-valor imutáveis que podem ser ligados a um objeto para armazenar informação adicional. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
critérios_teste	matriz	Uma lista de critérios de teste.	Yes

EvalCompareReport

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

Nome	Tipo	Description	Obrigatório
Comparações	matriz	Os resultados de comparação para cada tratamento decorrem em relação aos valores basais.	Yes
método	cadeia (de caracteres)	O método estatístico utilizado para comparação.	Yes
tipo	enumeração	O tipo de resultado de insights. Valores possíveis: `EvaluationComparison`	Yes

EvalResult

Resultado da avaliação.

Nome	Tipo	Description	Obrigatório
nome	cadeia (de caracteres)	Nome do cheque	Yes
aprovado	Booleano	indica se a verificação foi aprovada ou reprovada	Yes
classificação	número	classificação	Yes
tipo	cadeia (de caracteres)	Tipo de cheque	Yes

EvalRun

Um esquema que representa uma execução de avaliação.

Nome	Tipo	Description	Obrigatório
criado_em	objecto		Yes
criado_por	cadeia (de caracteres)	o nome da pessoa que criou a corrida.	Não
fonte_de_dados	objecto	Um objeto JsonlRunDataSource que especifica um ficheiro JSONL que corresponde à avaliação.	Yes
└─ mensagens_de_entrada	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate ou OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReferência	Usado ao amostrar a partir de um modelo. Dita a estrutura das mensagens passadas para o modelo. Pode ser uma referência a uma trajetória pré-construída (ou seja, `item.input_trajectory`), ou um template com referências variáveis ao `item` namespace.	Não
└─ item_generation_params	RedTeamItemGenerationParams	Os parâmetros para geração de itens.	Não
└─ modelo	cadeia (de caracteres)	O nome do modelo a ser usado para gerar completações (por exemplo, "o3-mini").	Não
└─ parâmetros_de_amostragem	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Não
└─ fonte	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource ou OpenAI.EvalResponsesSource	Determina o que preenche o `item` namespace na fonte de dados desta execução.	Não
└─ Alvo	Target	A configuração alvo para a avaliação.	Não
└─ tipo	cadeia (de caracteres)	O discriminador de tipo de fonte de dados.	Não
erro	OpenAI.EvalApiError	Um objeto que representa uma resposta de erro da API Eval.	Yes
eval_id	cadeia (de caracteres)	O identificador da avaliação associada.	Yes
id	cadeia (de caracteres)	Identificador exclusivo para a execução da avaliação.	Yes
metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
modelo	cadeia (de caracteres)	O modelo avaliado, se aplicável.	Yes
modified_at	objecto		Não
nome	cadeia (de caracteres)	O nome da sessão de avaliação.	Yes
objecto	enumeração	O tipo do objeto. Sempre «eval.run». Valores possíveis: `eval.run`	Yes
uso_por_modelo	matriz	Estatísticas de uso para cada modelo durante a execução da avaliação.	Yes
por_resultados_dos_criterios_de_teste	matriz	Resultados por critério de teste aplicado durante a execução da avaliação.	Yes
propriedades	objecto	Conjunto de 16 pares chave-valor imutáveis que podem ser ligados a um objeto para armazenar informação adicional. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
report_url	cadeia (de caracteres)	A URL para o relatório da execução da avaliação gerada no painel de controlo da interface do utilizador.	Yes
contagem_resultados	objecto		Yes
└─ Erro	OpenAI.integer		Não
└─ não conseguiu	OpenAI.integer		Não
└─ aprovado	OpenAI.integer		Não
└─ total	OpenAI.integer		Não
estado	cadeia (de caracteres)	O estado da execução da avaliação.	Yes

EvalRunDataSource

Classe base para executar fontes de dados com suporte a discriminadores.

Discriminador para EvalRunDataSource

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

Valor do tipo	Schema
`azure_ai_traces`	TracesEvalRunDataSource
`azure_ai_responses`	AzureAIRrespondses
`azure_ai_target_completions`	Finalizações de Alvos

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	cadeia (de caracteres)	O discriminador de tipo de fonte de dados.	Yes

EvalRunOutputItem

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

Nome	Tipo	Description	Obrigatório
criado_em	objecto		Yes
item_de_fonte_de_dados	objecto	Detalhes do item da fonte de dados de entrada.	Yes
id_item_fonte_de_dados	objecto		Yes
eval_id	cadeia (de caracteres)	O identificador do grupo de avaliação.	Yes
id	cadeia (de caracteres)	Identificador único para o item de saída do processo de avaliação.	Yes
objecto	enumeração	O tipo do objeto. Sempre "eval.run.output_item". Valores possíveis: `eval.run.output_item`	Yes
results	matriz	Uma lista dos resultados do avaliador para este item de saída.	Yes
run_id	cadeia (de caracteres)	O identificador da execução de avaliação associada a este item de saída.	Yes
amostra	objecto		Yes
└─ erro	OpenAI.EvalApiError	Um objeto que representa uma resposta de erro da API Eval.	Não
└─ motivo de término	cadeia (de caracteres)		Não
└─ entrada	matriz		Não
└─ max_completion_tokens	OpenAI.integer		Não
└─ modelo	cadeia (de caracteres)		Não
└─ saída	matriz		Não
└─ sementes	OpenAI.integer		Não
└─ temperatura	OpenAI.numeric		Não
└─ top_p	OpenAI.numeric		Não
└─ utilização	OpenAI.EvalRunOutputItemSampleUsage		Não
estado	cadeia (de caracteres)	O estado da execução da avaliação.	Yes

EvalRunOutputItemResult

Um resultado de um único avaliador para um item de execução de avaliação.

Nome	Tipo	Description	Obrigatório
etiqueta	cadeia (de caracteres)	O rótulo associado à métrica dos critérios do teste (por exemplo, "passar", "reprovar", "bom", "mau").	Não
métrica	cadeia (de caracteres)	O nome da métrica (por exemplo, "fluência", "f1_score").	Não
nome	cadeia (de caracteres)	O nome do classificador.	Yes
aprovado	Booleano	Se o avaliador considerou a saída uma passagem.	Yes
propriedades	objecto	Detalhes adicionais sobre a métrica dos critérios do teste.	Não
razão	cadeia (de caracteres)	A razão para a métrica de critérios de teste.	Não
amostra	objecto	Dados de amostra ou intermédios opcionais produzidos pelo avaliador.	Não
classificação	objecto		Yes
limiar	número	O limiar utilizado para determinar aprovação/reprovação neste critério de teste, se for numérico.	Não
tipo	cadeia (de caracteres)	O tipo de avaliador (por exemplo, "string-check-grader").	Não

EvalRunResultCompareItem

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

Nome	Tipo	Description	Obrigatório
deltaEstimativa	número	Diferença estimada entre o tratamento e o início do estudo.	Yes
pValor	número	Valor P para o efeito do tratamento.	Yes
tratamento Efeito	objecto	Tipo de efeito do tratamento.	Yes
treatmentRunId	cadeia (de caracteres)	O ID da execução do tratamento.	Yes
tratamentoRunResumo	objecto	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 corrida de avaliação.	Não
└─ runId	cadeia (de caracteres)	O ID da execução da avaliação.	Não
└─ contagem de amostras	número inteiro	Número de amostras na execução da avaliação.	Não
└─ DesvioPadrão	número	Desvio padrão da métrica na corrida de avaliação.	Não

EvalRunResultComparison

Os resultados de comparação para o tratamento são comparados com os valores basais.

Nome	Tipo	Description	Obrigatório
baselineRunSummary	objecto	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 corrida de avaliação.	Não
└─ runId	cadeia (de caracteres)	O ID da execução da avaliação.	Não
└─ contagem de amostras	número inteiro	Número de amostras na execução da avaliação.	Não
└─ DesvioPadrão	número	Desvio padrão da métrica na corrida de avaliação.	Não
compararItens	matriz	Lista de resultados de comparação para cada execução de tratamento.	Yes
avaliador	cadeia (de caracteres)	Nome do avaliador para este critério de teste.	Yes
métrica	cadeia (de caracteres)	Métrica a ser avaliada.	Yes
Critérios de teste	cadeia (de caracteres)	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 corrida de avaliação.	Yes
runId	cadeia (de caracteres)	O ID da execução da avaliação.	Yes
Contagem de amostras	número inteiro	Número de amostras na execução da avaliação.	Yes
desvio padrão	número	Desvio padrão da métrica na corrida de avaliação.	Yes

AvaliaçãoComparaçãoPedido

Pedido de comparação de avaliação

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

AmostraResultadoDeAvaliação

Uma amostra do resultado da avaliação.

Nome	Tipo	Description	Obrigatório
avaliaçãoResultado	objecto	Resultado da avaliação.	Yes
└─ nome	cadeia (de caracteres)	Nome do cheque	Não
└─ aprovado	Booleano	indica se a verificação foi aprovada ou reprovada	Não
└─ pontuação	número	classificação	Não
└─ tipo	cadeia (de caracteres)	Tipo de cheque	Não
tipo	enumeração	Tipo de amostra de resultado da avaliação Valores possíveis: `EvaluationResultSample`	Yes

Regra de Avaliação

Modelo de regras de avaliação.

Nome	Tipo	Description	Obrigatório
ação	objecto	Modelo de ação de avaliação.	Yes
└─ tipo	RegragraAvaliaçãoTipo de Ação	Tipo de ação de avaliação.	Não
descrição	cadeia (de caracteres)	Descrição da regra de avaliação.	Não
nome de exibição	cadeia (de caracteres)	Nome de exibição para a regra de avaliação.	Não
ativado	Booleano	Indica se a regra de avaliação está habilitada. A predefinição é verdadeira.	Yes
eventType	objecto	Tipo de evento da regra de avaliação.	Yes
filtro	objecto	Modelo de filtro de avaliação.	Não
└─ agentName	cadeia (de caracteres)	Filtrar por nome de agente.	Não
id	cadeia (de caracteres)	Identificador exclusivo da regra de avaliação.	Yes
DadosDoSistema	objecto	Metadados do sistema para a regra de avaliação.	Yes

EvaluationRuleAction

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

Discriminador para AvaliaçãoRegraAção

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

Valor do tipo	Schema
`continuousEvaluation`	RegragraAvaliação Contínua
`humanEvaluation`	RegragraAvaliação Humana

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	objecto	Tipo de ação de avaliação.	Yes

RegragraAvaliaçãoTipo de Ação

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

Propriedade	valor
Descrição	Tipo de ação de avaliação.
Type	cadeia (de caracteres)
Valores	`continuousEvaluation` `humanEvaluation`

RegragraAvaliaçãoEventoTipo

Tipo de evento da regra de avaliação.

Propriedade	valor
Descrição	Tipo de evento da regra de avaliação.
Type	cadeia (de caracteres)
Valores	`responseCompleted` `manual`

EvaluationRuleFilter

Modelo de filtro de avaliação.

Nome	Tipo	Description	Obrigatório	Predefinido
nome_agente	cadeia (de caracteres)	Filtrar por nome de agente.	Yes

AvaliaçãoRunClusterInsightResultado

Os insights da avaliação executam a análise de agrupamento.

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

AvaliaçãoRunClusterInsightsRequest

Insights sobre o conjunto de Resultados da Avaliação

Nome	Tipo	Description	Obrigatório
evalId	cadeia (de caracteres)	ID de avaliação para os insights.	Yes
modelConfiguration	objecto	Configuração do modelo utilizado na geração de insights.	Não
└─ modelDeploymentName	cadeia (de caracteres)	A implantação do modelo a ser avaliada. Aceita apenas o nome da implementação ou com o nome da ligação como `{connectionName}/<modelDeploymentName>`.	Não
runIds	matriz	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

TarefaAvaliaçãoAgendaTarefa

Tarefa de avaliação do cronograma.

Nome	Tipo	Description	Obrigatório
evalId	cadeia (de caracteres)	Identificador do grupo de avaliação.	Yes
evalRun	objecto	A carga útil executada pela avaliação.	Yes
tipo	enumeração	Valores possíveis: `Evaluation`	Yes

Taxonomia de Avaliação

Definição de Taxonomia de Avaliação

Nome	Tipo	Description	Obrigatório
id	cadeia (de caracteres)	ID do ativo, um identificador exclusivo para o ativo	Não
nome	cadeia (de caracteres)	O nome do recurso	Yes
propriedades	objecto	Propriedades adicionais para a taxonomia de avaliação.	Não
taxonomiaCategorias	matriz	Lista de categorias de taxonomia.	Não
taxonomiaEntrada	objecto	Configuração de entrada para a taxonomia de avaliação.	Yes
└─ tipo	AvaliaçãoTaxonomiaInputType	Tipo de entrada da taxonomia de avaliação.	Não
versão	cadeia (de caracteres)	A versão do recurso	Yes

AvaliaçãoTaxonomiaCriarOuAtualizar

Definição de Taxonomia de Avaliação

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	O texto da descrição do ativo.	Não
propriedades	objecto	Propriedades adicionais para a taxonomia de avaliação.	Não
etiquetas	objecto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não
taxonomiaCategorias	matriz	Lista de categorias de taxonomia.	Não
taxonomiaEntrada	objecto	Configuração de entrada para a taxonomia de avaliação.	Yes
└─ tipo	AvaliaçãoTaxonomiaInputType	Tipo de entrada da taxonomia de avaliação.	Não

AvaliaçãoTaxonomiaEntrada

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

Discriminador para AvaliaçãoTaxonomiaEntrada

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

Valor do tipo	Schema
`agent`	AgentTaxonomyInput

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

AvaliaçãoTaxonomiaInputType

Tipo de entrada da taxonomia de avaliação.

Propriedade	valor
Descrição	Tipo de entrada da taxonomia de avaliação.
Type	cadeia (de caracteres)
Valores	`agent` `policy`

AvaliaçãoTaxonomiaInputUpdate

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

Discriminador para AvaliaçãoTaxonomiaInputUpdate

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

Valor do tipo	Schema
`agent`	AgenteTaxonomiaInputUpdate

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

AvaliaçãoTaxonomiaAtualização

Definição de Taxonomia de Avaliação

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	O texto da descrição do ativo.	Não
propriedades	objecto	Propriedades adicionais para a taxonomia de avaliação.	Não
etiquetas	objecto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não
taxonomiaCategorias	matriz	Lista de categorias de taxonomia.	Não
taxonomiaEntrada	objecto	Configuração de entrada para a taxonomia de avaliação.	Não
└─ tipo	AvaliaçãoTaxonomiaInputType	Tipo de entrada da taxonomia de avaliação.	Não

AvaliatorCategory

A categoria do avaliador

Propriedade	valor
Descrição	A categoria do avaliador
Type	cadeia (de caracteres)
Valores	`quality` `safety` `agents`

DefiniçãoAvaliador

Configuração do avaliador de base com discriminador

Discriminador para AvaliadorDefinição

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

Valor do tipo	Schema
`code`	CodeBasedEvaluatorDefinition
`prompt`	PromptBasedEvaluatorDefinition

Nome	Tipo	Description	Obrigatório
data_schema		O esquema JSON (Draft 2020-12) para os dados de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	Não
init_parameters		O esquema JSON (Draft 2020-12) para os parâmetros de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	Não
métricas	objecto	Lista de métricas de saída produzidas por este avaliador	Não
tipo	objecto	O tipo de definição do avaliador	Yes

AvaliatorDefinitionType

O tipo de definição do avaliador

Propriedade	valor
Descrição	O tipo de definição do avaliador
Type	cadeia (de caracteres)
Valores	`prompt` `code` `prompt_and_code` `service` `openai_graders`

EvaluatorMetric

Métrica do Avaliador

Nome	Tipo	Description	Obrigatório
desirable_direction	objecto	A direção da métrica que indica se um valor mais alto é melhor, um valor menor é melhor ou neutro	Não
is_primary	Booleano	Indica se essa métrica é primária quando há várias métricas.	Não
max_value	número	Valor máximo para a métrica. Se não for especificado, presume-se que não tem limites.	Não
min_value	número	Valor mínimo para a métrica	Não
tipo	objecto	O tipo do avaliador	Não

AvaliatorMétricaDireção

A direção da métrica que indica se um valor mais alto é melhor, um valor menor é melhor ou neutro

Propriedade	valor
Descrição	A direção da métrica que indica se um valor mais alto é melhor, um valor menor é melhor ou neutro
Type	cadeia (de caracteres)
Valores	`increase` `decrease` `neutral`

EvaluatorMetricType

O tipo do avaliador

Propriedade	valor
Descrição	O tipo do avaliador
Type	cadeia (de caracteres)
Valores	`ordinal` `continuous` `boolean`

EvaluatorType

O tipo do avaliador

Propriedade	valor
Descrição	O tipo do avaliador
Type	cadeia (de caracteres)
Valores	`builtin` `custom`

EvaluatorVersion

Definição do Avaliador

Nome	Tipo	Description	Obrigatório
categories	matriz	As categorias do avaliador	Yes
criado_em	número inteiro	Data/hora de criação do avaliador	Yes
criado_por	cadeia (de caracteres)	Criador do avaliador	Yes
Definição	objecto	Configuração do avaliador de base com discriminador	Yes
└─ data_schema		O esquema JSON (Draft 2020-12) para os dados de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	Não
└─ init_parameters		O esquema JSON (Draft 2020-12) para os parâmetros de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	Não
└─ Métricas	objecto	Lista de métricas de saída produzidas por este avaliador	Não
└─ tipo	AvaliatorDefinitionType	O tipo de definição do avaliador	Não
display_name	cadeia (de caracteres)	Nome de exibição para o avaliador. Ajuda a encontrar facilmente o avaliador no Foundry. Não precisa ser único.	Não
evaluator_type	objecto	O tipo do avaliador	Yes
id	cadeia (de caracteres)	ID do ativo, um identificador exclusivo para o ativo	Não
metadados	objecto	Metadados sobre o avaliador	Não
modified_at	número inteiro	Data/hora da última modificação do avaliador	Yes
nome	cadeia (de caracteres)	O nome do recurso	Yes
versão	cadeia (de caracteres)	A versão do recurso	Yes

EvaluatorVersionCreate

Definição do Avaliador

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

EvaluatorVersionUpdate

Definição do Avaliador

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

FabricDataAgentToolParameters

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

Nome	Tipo	Description	Obrigatório	Predefinido
project_connections	matriz	As conexões do projeto anexadas a esta ferramenta. Pode haver um máximo de 1 ligação recurso associado à ferramenta.	Não

FileDatasetVersion

Definição FileDatasetVersion

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	Tipo de conjunto de dados Valores possíveis: `uri_file`	Yes

FileDatasetVersionUpdate

Definição FileDatasetVersion

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	Tipo de conjunto de dados Valores possíveis: `uri_file`	Yes

FolderDatasetVersion

Definição FileDatasetVersion

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	Tipo de conjunto de dados Valores possíveis: `uri_folder`	Yes

FolderDatasetVersionUpdate

Definição FileDatasetVersion

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	Tipo de conjunto de dados Valores possíveis: `uri_folder`	Yes

HostedAgentDefinition

A definição do agente hospedado.

Discriminador para HostedAgentDefinition

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

Valor do tipo	Schema
`hosted`	ImageBasedHostedAgentDefinition

Nome	Tipo	Description	Obrigatório
container_protocol_versions	matriz	Os protocolos que o agente suporta para comunicação de entrada dos contêineres.	Yes
cpu	cadeia (de caracteres)	A configuração da CPU para o agente hospedado.	Yes
environment_variables	objecto	Variáveis de ambiente a serem definidas no contêiner do agente hospedado.	Não
tipo	enumeração	Valores possíveis: `hosted`	Yes
memória	cadeia (de caracteres)	A configuração de memória para o agente hospedado.	Yes
Ferramentas	matriz	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.	Não

Horário de RecorrênciaHorário

Cronograma de recorrência horária.

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	Valores possíveis: `Hourly`	Yes

RegragraAvaliação Humana

Ação da regra de avaliação para avaliação humana.

Nome	Tipo	Description	Obrigatório	Predefinido
templateId	objecto	Identificador de um ativo guardado.	Yes
tipo	enumeração	Valores possíveis: `humanEvaluation`	Yes

ImageBasedHostedAgentDefinition

A definição de implantação baseada em imagem para um agente hospedado.

Nome	Tipo	Description	Obrigatório	Predefinido
imagem	cadeia (de caracteres)	A imagem para o agente hospedado.	Yes
tipo	enumeração	Valores possíveis: `hosted`	Yes

Index

Definição de recurso de índice

Discriminador para Índice

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

Valor do tipo	Schema
`AzureSearch`	AzureAISearchIndex
`ManagedAzureSearch`	ManagedAzureAISearchIndex
`CosmosDBNoSqlVectorStore`	CosmosDBIndex

Nome	Tipo	Description	Obrigatório
id	cadeia (de caracteres)	ID do ativo, um identificador exclusivo para o ativo	Não
nome	cadeia (de caracteres)	O nome do recurso	Yes
tipo	objecto		Yes
versão	cadeia (de caracteres)	A versão do recurso	Yes

IndexType

Propriedade	valor
Type	cadeia (de caracteres)
Valores	`AzureSearch` `CosmosDBNoSqlVectorStore` `ManagedAzureSearch`

IndexUpdate

Definição de recurso de índice

Discriminador para o IndexUpdate

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

Valor do tipo	Schema
`AzureSearch`	AzureAISearchIndexUpdate
`ManagedAzureSearch`	ManagedAzureAISearchIndexUpdate
`CosmosDBNoSqlVectorStore`	CosmosDBIndexUpdate

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	O texto da descrição do ativo.	Não
etiquetas	objecto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não
tipo	objecto		Yes

Visão

O corpo de resposta para insights de cluster.

Nome	Tipo	Description	Obrigatório
nome de exibição	cadeia (de caracteres)	Nome de exibição amigável para o insight.	Yes
id	cadeia (de caracteres)	O identificador exclusivo do relatório de insights.	Yes
metadados	objecto	Metadados sobre os insights.	Yes
└─ concluído At	cadeia (de caracteres)	O carimbo de data/hora quando as informações foram concluídas.	Não
└─ criadoEm	cadeia (de caracteres)	O carimbo de data/hora quando os insights foram criados.	Não
pedido	objecto	A solicitação do relatório de insights.	Yes
└─ tipo	InsightType	O tipo de pedido.	Não
Resultado	objecto	O resultado dos insights.	Não
└─ tipo	InsightType	O tipo de resultado de insights.	Não
state	objecto	Enum descrevendo estados de operação permitidos.	Yes

InsightCluster

Um conjunto de amostras de análise.

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	Descrição do cluster de análise.	Yes
id	cadeia (de caracteres)	A id do cluster de análise.	Yes
etiqueta	cadeia (de caracteres)	Rótulo para o cluster	Yes
Samples	matriz	Lista de exemplos que pertencem a este cluster. Vazio se as amostras fizerem parte de subclusters.	Não
subClusters	matriz	Lista de subclusters dentro deste cluster. Vazio se não existirem subclusters.	Não
Sugestão	cadeia (de caracteres)	Sugestão para o cluster	Yes
Sugestão Título	cadeia (de caracteres)	O título da sugestão para o cluster	Yes
weight	número inteiro	O peso do cluster de análise. Isso indica o número de amostras no cluster.	Yes

InsightModelConfiguration

Configuração do modelo utilizado na geração de insights.

Nome	Tipo	Description	Obrigatório	Predefinido
modelDeploymentName	cadeia (de caracteres)	A implantação do modelo a ser avaliada. Aceita apenas o nome da implementação ou com o nome da ligação como `{connectionName}/<modelDeploymentName>`.	Yes

InsightRequest

A solicitação do relatório de insights.

Discriminador para InsightRequest

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

Valor do tipo	Schema
`EvaluationRunClusterInsight`	AvaliaçãoRunClusterInsightsRequest
`AgentClusterInsight`	AgentClusterInsightsRequest
`EvaluationComparison`	AvaliaçãoComparaçãoPedido

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	objecto	O pedido dos insights.	Yes

InsightResult

O resultado dos insights.

Discriminador para InsightResult

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

Valor do tipo	Schema
`EvaluationComparison`	EvalCompareReport
`EvaluationRunClusterInsight`	AvaliaçãoRunClusterInsightResultado
`AgentClusterInsight`	AgentClusterInsightResult

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	objecto	O pedido dos insights.	Yes

InsightSample

Uma amostra da análise.

Discriminador para InsightSample

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

Valor do tipo	Schema
`EvaluationResultSample`	AmostraResultadoDeAvaliação

Nome	Tipo	Description	Obrigatório
correlationInfo	objecto	Informações sobre a correlação para a amostra de análise.	Yes
features	objecto	Recursos para ajudar com a filtragem adicional de dados em UX.	Yes
id	cadeia (de caracteres)	O identificador único da amostra de análise.	Yes
tipo	objecto	O tipo de amostra utilizada na análise.	Yes

InsightScheduleTask

Tarefa de insight para a agenda.

Nome	Tipo	Description	Obrigatório
informações	objecto	O corpo de resposta para insights de cluster.	Yes
└─ displayName	cadeia (de caracteres)	Nome de exibição amigável para o insight.	Não
└─ ID	cadeia (de caracteres)	O identificador exclusivo do relatório de insights.	Não
└─ metadados	InsightsMetadados	Metadados sobre o relatório de insights.	Não
└─ pedido	InsightRequest	Solicite a análise de insights.	Não
└─ Resultado	InsightResult	O resultado do relatório de insights.	Não
└─ Estado	Azure.Core.Foundations.OperationState	O estado atual dos insights.	Não
tipo	enumeração	Valores possíveis: `Insight`	Yes

ResumoInsightSummary

Resumo da análise de cluster de erros.

Nome	Tipo	Description	Obrigatório
método	cadeia (de caracteres)	Método utilizado para agrupamento.	Yes
Contagem de amostras	número inteiro	Número total de amostras analisadas.	Yes
uniqueClusterCount	número inteiro	Número total de clusters exclusivos.	Yes
SubuniqueClusterCount	número inteiro	Número total de rótulos de subcluster exclusivos.	Yes
utilização	objecto	Uso de token para análise de cluster	Yes
└─ inputTokenUsage	número inteiro	Uso do token de entrada	Não
└─ outputTokenUsage	número inteiro	Uso do token de saída	Não
└─ totalTokenUsage	número inteiro	Utilização total de tokens	Não

InsightType

O pedido dos insights.

Propriedade	valor
Type	cadeia (de caracteres)
Valores	`EvaluationRunClusterInsight` `AgentClusterInsight` `EvaluationComparison`

InsightsMetadados

Metadados sobre os insights.

Nome	Tipo	Description	Obrigatório	Predefinido
concluídoAt	cadeia (de caracteres)	O carimbo de data/hora quando as informações foram concluídas.	Não
criadoEm	cadeia (de caracteres)	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 itens.

Discriminador para ItemGenerationParams

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

Valor do tipo	Schema

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	cadeia (de caracteres)	O tipo de parâmetros de geração de itens a usar.	Yes

ManagedAzureAISearchIndex

Definição de Índice de Pesquisa de IA do Azure Gerenciado

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	Tipo de índice Valores possíveis: `ManagedAzureSearch`	Yes

ManagedAzureAISearchIndexUpdate

Definição de Índice de Pesquisa de IA do Azure Gerenciado

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

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

Valor do tipo	Schema
`user_profile`	UserProfileMemoryItem
`chat_summary`	ChatResumoMemóriaItemMemória

Nome	Tipo	Description	Obrigatório
conteúdo	cadeia (de caracteres)	O conteúdo da memória.	Yes
tipo	objecto	Tipo de item de memória.	Yes
memory_id	cadeia (de caracteres)	A ID exclusiva do item de memória.	Yes
âmbito	cadeia (de caracteres)	O namespace que agrupa e isola logicamente memórias, como um ID de usuário.	Yes
updated_at	número inteiro	A última hora de atualização do item de memória.	Yes

MemoryItemKind

Tipo de item de memória.

Propriedade	valor
Descrição	Tipo de item de memória.
Type	cadeia (de caracteres)
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
tipo	objecto	Tipo de operação de memória.	Yes
memory_item	objecto	Um único item de memória armazenado no armazenamento de memória, contendo conteúdo e metadados.	Yes
└─ conteúdo	cadeia (de caracteres)	O conteúdo da memória.	Não
└─ amável	MemoryItemKind	O tipo do item de memória.	Não
└─ memory_id	cadeia (de caracteres)	A ID exclusiva do item de memória.	Não
└─ Âmbito	cadeia (de caracteres)	O namespace que agrupa e isola logicamente memórias, como um ID de usuário.	Não
└─ updated_at	número inteiro	A última hora de atualização do item de memória.	Não

MemoryOperationKind

Tipo de operação de memória.

Propriedade	valor
Descrição	Tipo de operação de memória.
Type	cadeia (de caracteres)
Valores	`create` `update` `delete`

MemorySearchItem

Um item de memória recuperado da pesquisa de memória.

Nome	Tipo	Description	Obrigatório
memory_item	objecto	Um único item de memória armazenado no armazenamento de memória, contendo conteúdo e metadados.	Yes
└─ conteúdo	cadeia (de caracteres)	O conteúdo da memória.	Não
└─ amável	MemoryItemKind	O tipo do item de memória.	Não
└─ memory_id	cadeia (de caracteres)	A ID exclusiva do item de memória.	Não
└─ Âmbito	cadeia (de caracteres)	O namespace que agrupa e isola logicamente memórias, como um ID de usuário.	Não
└─ updated_at	número inteiro	A última hora de atualização do item de memória.	Não

MemorySearchOptions

Opções de pesquisa de memória.

Nome	Tipo	Description	Obrigatório	Predefinido
max_memories	número inteiro	Número máximo de itens de memória a serem retornados.	Não

MemorySearchTool

Uma ferramenta para integrar memórias no agente.

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

MemorySearchToolCallItemParam

Nome	Tipo	Description	Obrigatório	Predefinido
results	matriz	Os resultados retornados da pesquisa de memória.	Não
tipo	enumeração	Valores possíveis: `memory_search_call`	Yes

MemorySearchToolCallItemResource

Nome	Tipo	Description	Obrigatório
results	matriz	Os resultados retornados da pesquisa de memória.	Não
estado	enumeração	O estado da ferramenta de pesquisa de memória chama. Um dos `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	Predefinido
chat_model	cadeia (de caracteres)	O nome ou identificador da implantação do modelo de conclusão de chat usado para processamento de memória.	Yes
embedding_model	cadeia (de caracteres)	O nome ou identificador da implantação do modelo de incorporação usado para processamento de memória.	Yes
tipo	enumeração	O tipo de armazenamento de memória. Valores possíveis: `default`	Yes
options	objecto	Configurações de armazenamento de memória padrão.	Não
└─ chat_summary_enabled	Booleano	Se a extração e o armazenamento do resumo do chat devem ser habilitados. A predefinição é verdadeira.	Não	Verdade
└─ user_profile_details	cadeia (de caracteres)	Categorias específicas ou tipos de informações de perfil de usuário para extrair e armazenar.	Não
└─ user_profile_enabled	Booleano	Se a extração e o armazenamento de perfil de usuário devem ser habilitados. A predefinição é verdadeira.	Não	Verdade

MemoryStoreDefaultOptions

Configurações de armazenamento de memória padrão.

Nome	Tipo	Description	Obrigatório	Predefinido
chat_summary_enabled	Booleano	Se a extração e o armazenamento do resumo do chat devem ser habilitados. A predefinição é verdadeira.	Yes	Verdade
user_profile_details	cadeia (de caracteres)	Categorias específicas ou tipos de informações de perfil de usuário para extrair e armazenar.	Não
user_profile_enabled	Booleano	Se a extração e o armazenamento de perfil de usuário devem ser habilitados. A predefinição é verdadeira.	Yes	Verdade

MemoryStoreDefinition

Definição de base para configurações de armazenamento de memória.

Discriminador para MemoryStoreDefinition

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

Valor do tipo	Schema
`default`	MemoryStoreDefaultDefinition

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	objecto	O tipo de implementação de armazenamento de memória a ser usado.	Yes

MemoryStoreDeleteScopeResponse

Resposta para excluir memórias de um escopo.

Nome	Tipo	Description	Obrigatório
Suprimido	Booleano	Se a operação de exclusão foi bem-sucedida.	Yes
nome	cadeia (de caracteres)	O nome do armazenamento de memória.	Yes
objecto	enumeração	O tipo de objeto. Sempre 'memory_store.scope.deleted'. Valores possíveis: `memory_store.scope.deleted`	Yes
âmbito	cadeia (de caracteres)	O escopo do qual as memórias foram excluídas.	Yes

MemoryStoreKind

O tipo de implementação de armazenamento de memória a ser usado.

Propriedade	valor
Descrição	O tipo de implementação de armazenamento de memória a ser usado.
Type	cadeia (de caracteres)
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	número inteiro	O carimbo de data/hora Unix (segundos) quando o armazenamento de memória foi criado.	Yes
Definição	objecto	Definição de base para configurações de armazenamento de memória.	Yes
└─ amável	MemoryStoreKind	O tipo de armazenamento de memória.	Não
descrição	cadeia (de caracteres)	Uma descrição legível por humanos do armazenamento de memória.	Não
id	cadeia (de caracteres)	O identificador exclusivo do armazenamento de memória.	Yes
metadados	objecto	Metadados arbitrários de chave-valor a serem associados ao armazenamento de memória.	Não
nome	cadeia (de caracteres)	O nome do armazenamento de memória.	Yes
objecto	enumeração	O tipo de objeto, que é sempre 'memory_store'. Valores possíveis: `memory_store`	Yes
updated_at	número inteiro	O carimbo de data/hora do Unix (segundos) quando o armazenamento 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	número inteiro	O número de tokens de incorporação.	Yes
input_tokens	número inteiro	O número de tokens de entrada.	Yes
input_tokens_details	objecto	Um detalhamento detalhado dos tokens de entrada.	Yes
└─ tokens em cache	número inteiro	O número de tokens que foram recuperados do cache. Saiba mais sobre o cache de prompts.	Não
output_tokens	número inteiro	O número de tokens de saída.	Yes
output_tokens_details	objecto	Um detalhamento detalhado dos tokens de saída.	Yes
└─ tokens de raciocínio	número inteiro	O número de tokens de raciocínio.	Não
total_tokens	número inteiro	O número total de tokens usados.	Yes

MemoryStoreSearchResponse

Resposta de pesquisa de memória.

Nome	Tipo	Description	Obrigatório
Memórias	matriz	Itens de memória relacionados encontrados durante a operação de pesquisa.	Yes
search_id	cadeia (de caracteres)	O ID exclusivo desta solicitação de pesquisa. Use esse valor como previous_search_id em solicitações subsequentes para executar pesquisas incrementais.	Yes
utilização	objecto	Estatísticas de uso de uma operação de armazenamento de memória.	Yes
└─ embedding_tokens	número inteiro	O número de tokens de incorporação.	Não
└─ tokens de entrada	número inteiro	O número de tokens de entrada.	Não
└─ detalhes_de_tokens_de_entrada	objecto	Um detalhamento detalhado dos tokens de entrada.	Não
└─ tokens em cache	número inteiro	O número de tokens que foram recuperados do cache. Saiba mais sobre o cache de prompts.	Não
└─ output_tokens	número inteiro	O número de tokens de saída.	Não
└─ output_tokens_details	objecto	Um detalhamento detalhado dos tokens de saída.	Não
└─ tokens de raciocínio	número inteiro	O número de tokens de raciocínio.	Não
└─ fichas_totais	número inteiro	O número total de tokens usados.	Não

MemoryStoreUpdateCompletedResult

Resultado da atualização de memória.

Nome	Tipo	Description	Obrigatório
memory_operations	matriz	Uma lista de operações de memória individuais que foram executadas durante a atualização.	Yes
utilização	objecto	Estatísticas de uso de uma operação de armazenamento de memória.	Yes
└─ embedding_tokens	número inteiro	O número de tokens de incorporação.	Não
└─ tokens de entrada	número inteiro	O número de tokens de entrada.	Não
└─ detalhes_de_tokens_de_entrada	objecto	Um detalhamento detalhado dos tokens de entrada.	Não
└─ tokens em cache	número inteiro	O número de tokens que foram recuperados do cache. Saiba mais sobre o cache de prompts.	Não
└─ output_tokens	número inteiro	O número de tokens de saída.	Não
└─ output_tokens_details	objecto	Um detalhamento detalhado dos tokens de saída.	Não
└─ tokens de raciocínio	número inteiro	O número de tokens de raciocínio.	Não
└─ fichas_totais	número inteiro	O número total de tokens usados.	Não

MemoryStoreUpdateResponse

Fornece o status de uma operação de atualização de armazenamento de memória.

Nome	Tipo	Description	Obrigatório
erro	objecto		Não
└─ Informação adicional	objecto		Não
└─ código	cadeia (de caracteres)		Não
└─ debugInfo	objecto		Não
└─ detalhes	matriz		Não
└─ mensagem	cadeia (de caracteres)		Não
└─ Param	cadeia (de caracteres)		Não
└─ tipo	cadeia (de caracteres)		Não
Resultado	objecto	Resultado da atualização de memória.	Não
└─ memory_operations	matriz	Uma lista de operações de memória individuais que foram executadas durante a atualização.	Não
└─ utilização	MemoryStoreOperationUsage	Estatísticas de uso associadas à operação de atualização de memória.	Não
estado	objecto	Status de uma operação de atualização de armazenamento de memória.	Yes
superseded_by	cadeia (de caracteres)	O update_id operação foi substituído por quando o status é "substituído".	Não
update_id	cadeia (de caracteres)	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 de armazenamento de memória.

Propriedade	valor
Descrição	Status de uma operação de atualização de armazenamento de memória.
Type	cadeia (de caracteres)
Valores	`queued` `in_progress` `completed` `failed` `superseded`

MicrosoftFabricAgentTool

As informações de definição de entrada para uma ferramenta do Microsoft Fabric como usada para configurar um agente.

Nome	Tipo	Description	Obrigatório
fabric_dataagent_preview	objecto	Os parâmetros da ferramenta do agente de dados de malha.	Yes
└─ project_connections	matriz	As conexões do projeto anexadas a esta ferramenta. Pode haver um máximo de 1 ligação recurso associado à ferramenta.	Não
tipo	enumeração	O tipo de objeto, que é sempre 'fabric_dataagent'. Valores possíveis: `fabric_dataagent_preview`	Yes

ModelDeployment

Definição de implantação de modelo

Nome	Tipo	Description	Obrigatório
capabilities	objecto	Recursos do modelo implantado	Yes
nome_da_conexão	cadeia (de caracteres)	Nome da conexão da qual a implantação vem	Não
modelName	cadeia (de caracteres)	Nome específico do editor do modelo implantado	Yes
modelPublisher	cadeia (de caracteres)	Nome do editor do modelo implantado	Yes
versão do modelo	cadeia (de caracteres)	Versão específica do editor do modelo implantado	Yes
sku	objecto	Informações sobre Sku	Yes
└─ Capacidade	número inteiro	Capacidade de Sku	Não
└─ Família	cadeia (de caracteres)	Família Sku	Não
└─ nome	cadeia (de caracteres)	Nome Sku	Não
└─ Tamanho	cadeia (de caracteres)	Tamanho do Sku	Não
└─ Nível	cadeia (de caracteres)	Nível de Sku	Não
tipo	enumeração	O tipo de 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	número inteiro	O número máximo de fichas permitido na conclusão.	Yes
seed	número inteiro	A semente aleatória da 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úcleos.	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	número inteiro	O número máximo de fichas permitido na conclusão.	Não
seed	número inteiro	A semente aleatória da reprodutibilidade.	Não
temperatura	número	O parâmetro de temperatura para amostragem.	Não
top_p	número	O parâmetro top-p para amostragem de núcleos.	Não

Horário de Recorrência Mensal

Esquema mensal de recorrência.

Nome	Tipo	Description	Obrigatório	Predefinido
daysOfMonth	matriz	Dias do mês para o cronograma 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	Predefinido
tipo	enumeração	O tipo de credencial Valores possíveis: `None`	Yes

OAuthConsentRequestItemResource

Solicite ao serviço que o utilizador realize o consentimento OAuth.

Nome	Tipo	Description	Obrigatório
consent_link	cadeia (de caracteres)	O link que o utilizador pode usar para realizar o consentimento OAuth.	Yes
id	cadeia (de caracteres)		Yes
rótulo de servidor	cadeia (de caracteres)	A etiqueta do servidor para o pedido de consentimento OAuth.	Yes
tipo	enumeração	Valores possíveis: `oauth_consent_request`	Yes

OneTimeTrigger

Gatilho único.

Nome	Tipo	Description	Obrigatório	Predefinido
Fuso horário	cadeia (de caracteres)	Fuso horário para o gatilho único.	Não	UTC
triggerAt	cadeia (de caracteres)	Data e hora do gatilho único no formato ISO 8601.	Yes
tipo	enumeração	Valores possíveis: `OneTime`	Yes

OpenAI.Annotation

Discriminador para OpenAI.Annotation

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

Valor do tipo	Schema
`file_citation`	OpenAI.AnnotationFileCitation
`url_citation`	OpenAI.AnnotationUrlCitation
`file_path`	OpenAI.AnnotationFilePath

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	OpenAI.AnnotationType		Yes

OpenAI.AnnotationFileCitation

Uma citação a um ficheiro.

Nome	Tipo	Description	Obrigatório
identificação_de_ficheiro	cadeia (de caracteres)	A ID do arquivo.	Yes
filename	cadeia (de caracteres)	O nome do arquivo citado.	Yes
indexar	número inteiro	O índice do arquivo na lista de arquivos.	Yes
tipo	enumeração	O tipo de citação do arquivo. Sempre `file_citation`. Valores possíveis: `file_citation`	Yes

OpenAI.AnnotationFilePath

Um caminho para um arquivo.

Nome	Tipo	Description	Obrigatório
identificação_de_ficheiro	cadeia (de caracteres)	A ID do arquivo.	Yes
indexar	número inteiro	O índice do arquivo na lista de arquivos.	Yes
tipo	enumeração	O tipo do caminho do arquivo. Sempre `file_path`. Valores possíveis: `file_path`	Yes

OpenAI.AnnotationType

Propriedade	valor
Type	cadeia (de caracteres)
Valores	`file_citation` `url_citation` `file_path` `container_file_citation`

OpenAI.AnnotationUrlCitation

Uma citação para um recurso da Web usado para gerar uma resposta de modelo.

Nome	Tipo	Description	Obrigatório
end_index	número inteiro	O índice do último caractere da citação de URL na mensagem.	Yes
start_index	número inteiro	O índice do primeiro caractere da citação de URL na mensagem.	Yes
title	cadeia (de caracteres)	O título do recurso Web.	Yes
tipo	enumeração	O tipo de citação de URL. Sempre `url_citation`. Valores possíveis: `url_citation`	Yes
url	cadeia (de caracteres)	O URL do recurso Web.	Yes

OpenAI.ApproximateLocation

Nome	Tipo	Description	Obrigatório
city	cadeia (de caracteres)		Não
country	cadeia (de caracteres)		Não
região	cadeia (de caracteres)		Não
timezone	cadeia (de caracteres)		Não
tipo	enumeração	Valores possíveis: `approximate`	Yes

FerramentaDeConcluãoDeChatDaOpenAI

Uma ferramenta funcional que pode ser usada para gerar uma resposta.

Nome	Tipo	Description	Obrigatório	Predefinido
função	OpenAI.FunctionObject		Yes
tipo	enumeração	O tipo da ferramenta. Atualmente, apenas `function` é suportado. Valores possíveis: `function`	Yes

OpenAI.CodeInterpreterOutput

Discriminador para OpenAI.CodeInterpreterOutput

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

Valor do tipo	Schema
`image`	OpenAI.CodeInterpreterOutputImage
`logs`	OpenAI.CodeInterpreterOutputLogs

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	OpenAI.CodeInterpreterOutputType		Yes

OpenAI.CodeInterpreterOutputImage

A saída de imagem do interpretador de código.

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	O tipo de saída. Sempre 'imagem'. Valores possíveis: `image`	Yes
url	cadeia (de caracteres)	O URL da imagem gerada pelo interpretador de código.	Yes

OpenAI.CodeInterpreterOutputLogs

A saída de logs do interpretador de código.

Nome	Tipo	Description	Obrigatório	Predefinido
registos	cadeia (de caracteres)	A saída de logs do interpretador de código.	Yes
tipo	enumeração	O tipo de saída. Sempre 'logs'. Valores possíveis: `logs`	Yes

OpenAI.CodeInterpreterOutputType

Propriedade	valor
Type	cadeia (de caracteres)
Valores	`logs` `image`

OpenAI.CodeInterpreterTool

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

Nome	Tipo	Description	Obrigatório
contentor	objecto	Configuração para um contêiner de interpretador de código. Opcionalmente, especifique os IDs dos arquivos para executar o código neles.	Yes
└─ identificadores_de_ficheiro	matriz	Uma lista opcional de arquivos carregados para disponibilizar para o seu código.	Não
└─ tipo	enumeração	Sempre `auto`. Valores possíveis: `auto`	Não
tipo	enumeração	O tipo da ferramenta de interpretador de código. Sempre `code_interpreter`. Valores possíveis: `code_interpreter`	Yes

"OpenAI.CodeInterpreterToolAuto"

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	Predefinido
identificadores_de_arquivo	matriz	Uma lista opcional de arquivos carregados para disponibilizar para o seu código.	Não
tipo	enumeração	Sempre `auto`. Valores possíveis: `auto`	Yes

OpenAI.CodeInterpreterToolCallItemParam

Uma chamada de ferramenta para executar código.

Nome	Tipo	Description	Obrigatório
código	cadeia (de caracteres)	O código a ser executado ou null se não estiver disponível.	Yes
container_id	cadeia (de caracteres)	A ID do contêiner usado para executar o código.	Yes
saídas	matriz	As saídas geradas pelo interpretador de código, como logs ou imagens. Pode ser nulo se nenhuma saída estiver disponível.	Yes
tipo	enumeração	Valores possíveis: `code_interpreter_call`	Yes

OpenAI.CodeInterpreterToolCallItemResource

Uma chamada de ferramenta para executar código.

Nome	Tipo	Description	Obrigatório
código	cadeia (de caracteres)	O código a ser executado ou null se não estiver disponível.	Yes
container_id	cadeia (de caracteres)	A ID do contêiner usado para executar o código.	Yes
saídas	matriz	As saídas geradas pelo interpretador de código, como logs ou imagens. Pode ser nulo se nenhuma saída estiver disponível.	Yes
estado	enumeração	Valores possíveis: `in_progress`, `completed`, `incomplete`, `interpreting`, , `failed`	Yes
tipo	enumeração	Valores possíveis: `code_interpreter_call`	Yes

OpenAI.ComparisonFilter

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 (de caracteres)	A chave pela qual se compara o valor.	Yes
tipo	enumeração	Especifica o operador de comparação: `eq` (igual), `ne` (não igual), `gt` (maior que), `gte` (maior que ou igual), `lt` (menor que), `lte` (menor que igual). Valores possíveis: `eq`, `ne`, `gt`, `gte`, , `lt`, `lte`	Yes
valor	string ou número ou booleano		Yes

OpenAI.CompoundFilter

Combine vários filtros usando and ou or.

Nome	Tipo	Description	Obrigatório	Predefinido
filters	matriz	Matriz de filtros para combinar. 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

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

Valor do tipo	Schema
`click`	OpenAI.ComputerActionClick
`double_click`	OpenAI.ComputerActionDoubleClick
`drag`	OpenAI.ComputerActionDrag
`move`	OpenAI.ComputerActionMove
`screenshot`	OpenAI.ComputerActionScreenshot
`scroll`	OpenAI.ComputerActionScroll
`type`	OpenAI.ComputerActionTypeKeys
`wait`	OpenAI.ComputerActionWait
`keypress`	OpenAI.ComputerActionKeyPress

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	OpenAI.ComputerActionType		Yes

OpenAI.ComputerActionClick

Uma ação de clique.

Nome	Tipo	Description	Obrigatório
botão	enumeração	Indica qual botão do mouse foi pressionado durante o clique. Um de `left`, `right`, `wheel`, `back`, ou `forward`. Valores possíveis: `left`, `right`, `wheel`, `back`, , `forward`	Yes
tipo	enumeração	Especifica o tipo de evento. Para uma ação de clique, esta propriedade é sempre definido como `click`. Valores possíveis: `click`	Yes
x	número inteiro	A coordenada x onde ocorreu o clique.	Yes
y	número inteiro	A coordenada y onde ocorreu o clique.	Yes

OpenAI.ComputerActionDoubleClick

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, esta propriedade é sempre definido como `double_click`. Valores possíveis: `double_click`	Yes
x	número inteiro	A coordenada x onde ocorreu o duplo clique.	Yes
y	número inteiro	A coordenada y onde ocorreu o duplo clique.	Yes

OpenAI.ComputerActionDrag

Uma ação de arrastar.

Nome	Tipo	Description	Obrigatório	Predefinido
caminho	matriz	Uma matriz de coordenadas que representa o caminho da ação de arrastar. As coordenadas aparecerão 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, esta propriedade é sempre definido como `drag`. Valores possíveis: `drag`	Yes

OpenAI.ComputerActionKeyPress

Uma coleção de pressionamentos de teclas que o modelo gostaria de realizar.

Nome	Tipo	Description	Obrigatório	Predefinido
Teclas	matriz	A combinação de teclas que o modelo está solicitando para ser pressionada. Este é um matriz de cadeias de caracteres, cada uma representando uma chave.	Yes
tipo	enumeração	Especifica o tipo de evento. Para uma ação de pressionamento de teclas, esta propriedade é sempre definido como `keypress`. Valores possíveis: `keypress`	Yes

OpenAI.ComputerActionMove

Uma ação de movimento do mouse.

Nome	Tipo	Description	Obrigatório
tipo	enumeração	Especifica o tipo de evento. Para uma ação de movimentação, esta propriedade é sempre definido como `move`. Valores possíveis: `move`	Yes
x	número inteiro	A coordenada x para a qual mover.	Yes
y	número inteiro	A coordenada y para a qual mover.	Yes

OpenAI.ComputerActionScreenshot

Uma ação de captura de tela.

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	Especifica o tipo de evento. Para uma ação de captura de tela, esta propriedade é sempre definido como `screenshot`. Valores possíveis: `screenshot`	Yes

OpenAI.ComputerActionScroll

Uma ação de rolagem.

Nome	Tipo	Description	Obrigatório
scroll_x	número inteiro	A distância de rolagem horizontal.	Yes
scroll_y	número inteiro	A distância de rolagem vertical.	Yes
tipo	enumeração	Especifica o tipo de evento. Para uma ação de rolagem, esta propriedade é sempre definido como `scroll`. Valores possíveis: `scroll`	Yes
x	número inteiro	A coordenada x onde ocorreu a rolagem.	Yes
y	número inteiro	A coordenada y onde ocorreu a rolagem.	Yes

OpenAI.ComputerActionType

Propriedade	valor
Type	cadeia (de caracteres)
Valores	`screenshot` `click` `double_click` `scroll` `type` `wait` `keypress` `drag` `move`

OpenAI.ComputerActionTypeKeys

Uma ação para digitar texto.

Nome	Tipo	Description	Obrigatório	Predefinido
enviar SMS	cadeia (de caracteres)	O texto a ser digitado.	Yes
tipo	enumeração	Especifica o tipo de evento. Para um tipo de ação, esta propriedade é sempre definido como `type`. Valores possíveis: `type`	Yes

OpenAI.ComputerActionWait

Uma ação de espera.

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	Especifica o tipo de evento. Para uma ação de espera, esta propriedade é sempre definido como `wait`. Valores possíveis: `wait`	Yes

OpenAI.ComputerToolCallItemParam

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 (de caracteres)	Um identificador usado ao responder a uma solicitação da ferramenta com resultados.	Yes
pending_safety_checks	matriz	As verificações de segurança pendentes para a chamada do computador.	Yes
tipo	enumeração	Valores possíveis: `computer_call`	Yes

OpenAI.ComputerToolCallItemResource

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 (de caracteres)	Um identificador usado ao responder a uma solicitação da ferramenta com resultados.	Yes
pending_safety_checks	matriz	As verificações de segurança pendentes para a chamada do computador.	Yes
estado	enumeração	O estado do item. Um dos `in_progress`, `completed`, ou `incomplete`. É preenchido quando os itens são retornados via API. Valores possíveis: `in_progress`, `completed`, `incomplete`	Yes
tipo	enumeração	Valores possíveis: `computer_call`	Yes

OpenAI.ComputerToolCallOutputItemOutput

Discriminador para OpenAI.ComputerToolCallOutputItemOutput

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

Valor do tipo	Schema
`computer_screenshot`	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	OpenAI.ComputerToolCallOutputItemOutputType	Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.	Yes

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Nome	Tipo	Description	Obrigatório
identificação_de_ficheiro	cadeia (de caracteres)		Não
image_url	cadeia (de caracteres)		Não
tipo	enumeração	Valores possíveis: `computer_screenshot`	Yes

OpenAI.ComputerToolCallOutputItemOutputType

Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.

Propriedade	valor
Descrição	Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.
Type	cadeia (de caracteres)
Valores	`computer_screenshot`

OpenAI.ComputerToolCallOutputItemParam

A saída de uma chamada de ferramenta de computador.

Nome	Tipo	Description	Obrigatório
acknowledged_safety_checks	matriz	As verificações de segurança comunicadas pela API que foram reconhecidas pelo desenvolvedor.	Não
call_id	cadeia (de caracteres)	O ID da chamada de ferramenta de computador que produziu a saída.	Yes
output	OpenAI.ComputerToolCallOutputItemOutput		Yes
tipo	enumeração	Valores possíveis: `computer_call_output`	Yes

OpenAI.ComputerToolCallOutputItemResource

A saída de uma chamada de ferramenta de computador.

Nome	Tipo	Description	Obrigatório
acknowledged_safety_checks	matriz	As verificações de segurança comunicadas pela API que foram reconhecidas pelo desenvolvedor.	Não
call_id	cadeia (de caracteres)	O ID da chamada de ferramenta de computador que produziu a saída.	Yes
output	OpenAI.ComputerToolCallOutputItemOutput		Yes
estado	enumeração	O estado do item. Um dos `in_progress`, `completed`, ou `incomplete`. É preenchido quando os itens são retornados via API. Valores possíveis: `in_progress`, `completed`, `incomplete`	Yes
tipo	enumeração	Valores possíveis: `computer_call_output`	Yes

OpenAI.ComputerToolCallSafetyCheck

Uma verificação de segurança pendente para a chamada no computador.

Nome	Tipo	Description	Obrigatório
código	cadeia (de caracteres)	O tipo de verificação de segurança pendente.	Yes
id	cadeia (de caracteres)	ID da verificação de segurança pendente.	Yes
mensagem	cadeia (de caracteres)	Detalhes sobre a verificação de segurança pendente.	Yes

OpenAI.FerramentaDePréVisualizaçãoDeUsoDoComputador

Uma ferramenta que controla um computador virtual.

Nome	Tipo	Description	Obrigatório
altura do ecrã	número inteiro	A altura do ecrã do computador.	Yes
largura de exibição	número inteiro	A largura do ecrã do computador.	Yes
ambiente	enumeração	O tipo de ambiente de computador a controlar. Valores possíveis: `windows`, `mac`, `linux`, `ubuntu`, , `browser`	Yes
tipo	enumeração	O tipo de ferramenta de uso do computador. Sempre `computer_use_preview`. Valores possíveis: `computer_use_preview`	Yes

OpenAI.ConversationItemList

Nome	Tipo	Description	Obrigatório
dados	matriz		Yes
first_id	cadeia (de caracteres)		Yes
tem_mais	Booleano		Yes
last_id	cadeia (de caracteres)		Yes
objecto	enumeração	Valores possíveis: `list`	Yes

OpenAI.ConversationResource

Nome	Tipo	Description	Obrigatório
criado_em	número inteiro		Yes
id	cadeia (de caracteres)	O ID exclusivo da conversação.	Yes
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
objecto	enumeração	O tipo de objeto, que é sempre 'conversa'. Valores possíveis: `conversation`	Yes

OpenAI.Coordinate

Um par de coordenadas x/y, por exemplo. { x: 100, y: 200 }

Nome	Tipo	Description	Obrigatório	Predefinido
x	número inteiro	A coordenada x.	Yes
y	número inteiro	A coordenada y.	Yes

OpenAI.CreateConversationRequest

Criar uma conversa

Nome	Tipo	Description	Obrigatório	Predefinido
items	matriz	Os itens iniciais incluem o contexto da conversa. Pode adicionar até 20 itens de cada vez.	Não
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

OpenAI.CreateEvalCompletionsRunDataSource

Um objeto CompletionsRunDataSource que descreve uma configuração de amostragem de modelo.

Nome	Tipo	Description	Obrigatório
mensagens_de_entrada	objecto		Não
└─ referência_do_item	cadeia (de caracteres)		Não
└─ modelo	matriz		Não
└─ tipo	enumeração	Valores possíveis: `item_reference`	Não
modelo	cadeia (de caracteres)	O nome do modelo a ser usado para gerar completações (por exemplo, "o3-mini").	Não
parâmetros_de_amostragem	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		Não
origem	objecto		Yes
└─ conteúdo	matriz	O conteúdo do arquivo jsonl.	Não
└─ criado_depois	OpenAI.integer		Não
└─ criado_antes	OpenAI.integer		Não
└─ ID	cadeia (de caracteres)	O identificador do arquivo.	Não
└─ limite	OpenAI.integer		Não
└─ metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ modelo	cadeia (de caracteres)		Não
└─ tipo	enumeração	O tipo de fonte. Sempre `stored_completions`. Valores possíveis: `stored_completions`	Não
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	Predefinido
item_reference	cadeia (de caracteres)		Yes
tipo	enumeração	Valores possíveis: `item_reference`	Yes

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Nome	Tipo	Description	Obrigatório	Predefinido
modelo	matriz		Yes
tipo	enumeração	Valores possíveis: `template`	Yes

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Nome	Tipo	Description	Obrigatório	Predefinido
max_completion_tokens	OpenAI.integer		Não
esforço de raciocínio	OpenAI.ReasoningEffort	Restringe o esforço no raciocínio para modelos de raciocínio. Os valores atualmente suportados são nenhum, mínimo, baixo, médio e alto. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta. O GPT-5.1 por defeito é nenhum, que não executa raciocínio. Os valores de raciocínio suportados para gpt-5.1 são nenhum, baixo, médio e alto. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. Todos os modelos anteriores ao gpt-5.1 usam por defeito o esforço de raciocínio médio e não suportam nenhum. O modelo gpt-5-pro tem por defeito (e só suporta) um esforço de raciocínio elevado.	Não
formato_de_resposta	objecto	Formato de resposta padrão. Usado para gerar respostas de texto.	Não
└─ json_schema	objecto	Opções de configuração de Saídas Estruturadas, incluindo um Esquema JSON.	Não
└─ Descrição	cadeia (de caracteres)	Uma descrição da finalidade do formato de resposta utilizada pelo modelo para Determine como responder no formato.	Não
└─ nome	cadeia (de caracteres)	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.	Não
└─ esquema	objecto		Não
└─ rigoroso	Booleano	Se a adesão estrita ao esquema deve ser habilitada ao gerar a saída. Se definido como true, o modelo sempre seguirá o esquema exato definido no campo `schema`. Somente um subconjunto do esquema JSON é suportado quando `strict` é `true`. Para saber mais, leia os Outputs estruturados guia.	Não	Falso
└─ tipo	enumeração	O tipo de formato de resposta que está sendo definido. Sempre `json_object`. Valores possíveis: `json_object`	Não
seed	objecto		Não
temperatura	objecto		Não
Ferramentas	matriz		Não
top_p	objecto		Não

OpenAI.CreateEvalCustomDataSourceConfig

Um objeto CustomDataSourceConfig que define o esquema para a fonte de dados usada para as execuções de avaliação. Este 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_schema_exemplo	Booleano	Se o processo de avaliação deve esperar que você preencha o namespace de exemplo (ou seja, gerando respostas a partir da sua fonte de dados)	Não
item_esquema	objecto	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 que especifica um ficheiro JSONL que corresponde à avaliação.

Nome	Tipo	Description	Obrigatório
origem	objecto		Yes
└─ conteúdo	matriz	O conteúdo do arquivo jsonl.	Não
└─ ID	cadeia (de caracteres)	O identificador do arquivo.	Não
└─ tipo	enumeração	O tipo de fonte jsonl. Sempre `file_id`. Valores possíveis: `file_id`	Não
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 de sua consulta de logs. Geralmente são metadados como usecase=chatbot ou prompt-version=v2, etc.

Nome	Tipo	Description	Obrigatório	Predefinido
metadados	objecto	Filtros de metadados para a fonte de dados de logs.	Não
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	objecto		Não
└─ referência_do_item	cadeia (de caracteres)		Não
└─ modelo	matriz		Não
└─ tipo	enumeração	Valores possíveis: `item_reference`	Não
modelo	cadeia (de caracteres)	O nome do modelo a ser usado para gerar completações (por exemplo, "o3-mini").	Não
parâmetros_de_amostragem	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Não
origem	objecto		Yes
└─ conteúdo	matriz	O conteúdo do arquivo jsonl.	Não
└─ criado_depois	OpenAI.integer		Não
└─ criado_antes	OpenAI.integer		Não
└─ ID	cadeia (de caracteres)	O identificador do arquivo.	Não
└─ instruções_busca	cadeia (de caracteres)		Não
└─ metadados	objecto		Não
└─ modelo	cadeia (de caracteres)		Não
└─ esforço_de_raciocínio	OpenAI.ReasoningEffort	Restringe o esforço no raciocínio para modelos de raciocínio. Os valores atualmente suportados são nenhum, mínimo, baixo, médio e alto. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta. O GPT-5.1 por defeito é nenhum, que não executa raciocínio. Os valores de raciocínio suportados para gpt-5.1 são nenhum, baixo, médio e alto. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. Todos os modelos anteriores ao gpt-5.1 usam por defeito o esforço de raciocínio médio e não suportam nenhum. O modelo gpt-5-pro tem por defeito (e só suporta) um esforço de raciocínio elevado.	Não
└─ temperatura	OpenAI.numeric		Não
└─ Ferramentas	matriz		Não
└─ top_p	OpenAI.numeric		Não
└─ tipo	enumeração	O tipo de fonte de dados de execução. Sempre `responses`. Valores possíveis: `responses`	Não
└─ Utilizadores	matriz		Não
tipo	enumeração	O tipo de fonte de dados de execução. Sempre `responses`. Valores possíveis: `responses`	Yes

OpenAI.CreateEvalResponsesRunDataDataInputMessagesItemReference

Nome	Tipo	Description	Obrigatório	Predefinido
item_reference	cadeia (de caracteres)		Yes
tipo	enumeração	Valores possíveis: `item_reference`	Yes

OpenAI.CreateEvalResponsesRunDataDataSourceInputMessagesTemplate

Nome	Tipo	Description	Obrigatório	Predefinido
modelo	matriz		Yes
tipo	enumeração	Valores possíveis: `template`	Yes

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Nome	Tipo	Description	Obrigatório
max_completion_tokens	OpenAI.integer		Não
esforço de raciocínio	OpenAI.ReasoningEffort	Restringe o esforço no raciocínio para modelos de raciocínio. Os valores atualmente suportados são nenhum, mínimo, baixo, médio e alto. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta. O GPT-5.1 por defeito é nenhum, que não executa raciocínio. Os valores de raciocínio suportados para gpt-5.1 são nenhum, baixo, médio e alto. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. Todos os modelos anteriores ao gpt-5.1 usam por defeito o esforço de raciocínio médio e não suportam nenhum. O modelo gpt-5-pro tem por defeito (e só suporta) um esforço de raciocínio elevado.	Não
seed	objecto		Não
temperatura	objecto		Não
enviar SMS	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		Não
Ferramentas	matriz		Não
top_p	objecto		Não

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

Nome	Tipo	Description	Obrigatório	Predefinido
format	OpenAI.TextResponseFormatConfiguration	Um objeto que especifica o formato que o modelo deve produzir. A configuração `{ "type": "json_schema" }` permite saídas estruturadas, o que garante que o modelo corresponderá 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:* Definir para `{ "type": "json_object" }` ativa o modo JSON mais antigo, que garante que a mensagem que o modelo gera é JSON válida. Usando `json_schema` é preferível para modelos que o suportem.	Não

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

Preterido em favor de LogsDataSourceConfig.

Nome	Tipo	Description	Obrigatório	Predefinido
metadados	objecto	Filtros de metadados para a fonte de dados de conclusão armazenada.	Não
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	Predefinido
hiperparâmetros	objecto	Os hiperparâmetros usados para o trabalho de ajuste fino. Esse valor agora é preterido em favor de `method`, e deve ser passado sob o `method` parâmetro.	Não
└─ tamanho_do_lote (batch_size)	enumeração	Valores possíveis: `auto`	Não
└─ multiplicador_da_taxa_de_aprendizagem	enumeração	Valores possíveis: `auto`	Não
└─ n_epochs	enumeração	Valores possíveis: `auto`	Não
integrações	matriz	Uma lista de integrações para ativar para o seu trabalho de ajuste fino.	Não
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
método	Método OpenAI.FineTune	O método utilizado para o ajuste fino.	Não
modelo	string (ver modelos válidos abaixo)	O nome do modelo para ajuste. Pode selecionar uma das opções modelos suportados.	Yes
seed	número inteiro	A semente controla a reprodutibilidade do trabalho. Fornecer os mesmos parâmetros de semente e de trabalho deve produzir os mesmos resultados, mas poderá diferir em casos raros. Se uma semente não for especificada, uma será gerada para você.	Não
sufixo	cadeia (de caracteres)	Uma cadeia de até 64 caracteres pode ser adicionada ao nome do modelo personalizado. Por exemplo, um `suffix` de "custom-model-name" produziria um nome de modelo como `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`.	Não	Nenhum
ficheiro de treino	cadeia (de caracteres)	A ID de um arquivo carregado que contém dados de treinamento. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Além disso, você deve fazer o upload do seu arquivo com a finalidade `fine-tune`. O conteúdo do arquivo deve diferir dependendo se o modelo usa o chat, o formato de conclusão ou se o método de ajuste fino usa o formato de preferência. Consulte o guia de ajuste fino para obter mais detalhes.	Yes
ficheiro_de_validação	cadeia (de caracteres)	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 processo de afinação. Essas métricas podem ser visualizadas em O arquivo de resultados de ajuste fino. Os mesmos dados não devem estar presentes nos ficheiros de treino e de validação. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Você deve fazer o upload do seu arquivo com a finalidade `fine-tune`. Consulte o guia de ajuste fino para obter mais detalhes.	Não

OpenAI.CreateFineTuningJobRequestIntegration

Discriminador para OpenAI.CreateFineTuningJobRequestIntegration

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

Valor do tipo	Schema
`wandb`	OpenAI.CreateFineTuningJobRequestWandbIntegration

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	string (ver modelos válidos abaixo)		Yes

OpenAI.CreateFineTuningJobRequestWandbIntegration

Nome	Tipo	Description	Obrigatório
tipo	enumeração	Valores possíveis: `wandb`	Yes
wandb	objecto		Yes
└─ entidade	cadeia (de caracteres)		Não
└─ nome	cadeia (de caracteres)		Não
└─ projeto	cadeia (de caracteres)		Não
└─ Tags	matriz		Não

OpenAI.CreateResponse

Nome	Tipo	Description	Obrigatório	Predefinido
agente	objecto		Não
└─ nome	cadeia (de caracteres)	O nome do agente.	Não
└─ tipo	enumeração	Valores possíveis: `agent_reference`	Não
└─ versão	cadeia (de caracteres)	O identificador de versão do agente.	Não
em segundo plano	Booleano	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas de fundo.	Não	Falso
conversa	objecto		Não
└─ ID	cadeia (de caracteres)		Não
include	matriz	Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Atualmente Os valores suportados são: - `code_interpreter_call.outputs`: Inclui as saídas de execução de código python Chamar itens na ferramenta de interpretação de código. - `computer_call_output.output.image_url`: Inclua URLs de imagens da saída de chamada do computador. - `file_search_call.results`: Incluir os resultados da pesquisa de a chamada da ferramenta de pesquisa de ficheiros. - `message.input_image.image_url`: Inclua urls de imagem da mensagem de entrada. - `message.output_text.logprobs`: Inclua logprobs com mensagens do assistente. - `reasoning.encrypted_content`: Inclui uma versão encriptada do raciocínio tokens em resultados de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em conversas com vários turnos ao usar a API de respostas sem estado (como quando o `store` parâmetro é definido como `false`, ou quando uma organização é inscritos no programa de retenção de dados zero).	Não
dados introduzidos	cadeia de caracteres ou matriz		Não
instructions	cadeia (de caracteres)	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao utilizar juntamente com `previous_response_id`, as instruções de uma etapa anterior a resposta não será transferida para a resposta seguinte. Isso simplifica para substituir mensagens do sistema (ou mensagens de desenvolvedor) em novas respostas.	Não
max_output_tokens	número inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
max_tool_calls	número inteiro	O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
modelo	cadeia (de caracteres)	O desdobramento do modelo a ser usado para a criação desta resposta.	Não
chamadas_de_ferramentas_em_paralelo	Booleano	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
previous_response_id	cadeia (de caracteres)	O ID único da resposta anterior dada ao modelo. Utilize esta opção para Crie conversas em vários turnos. Saiba mais sobre Gerir o estado de conversa.	Não
avisar	objecto	Referência a um modelo de prompt e as suas variáveis. Mais informações.	Não
└─ ID	cadeia (de caracteres)	O identificador exclusivo do modelo de prompt a ser usado.	Não
└─ variáveis	OpenAI.ResponsePromptVariables	Mapa opcional de valores para substituir variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros. Tipos de entrada de resposta, como imagens ou arquivos.	Não
└─ versão	cadeia (de caracteres)	Versão opcional do modelo de prompt.	Não
reasoning	objecto	Apenas modelos da série O Opções de configuração para modelos de raciocínio.	Não
└─ esforço	OpenAI.ReasoningEffort	Restringe o esforço no raciocínio para modelos de raciocínio. Os valores atualmente suportados são nenhum, mínimo, baixo, médio e alto. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta. O GPT-5.1 por defeito é nenhum, que não executa raciocínio. Os valores de raciocínio suportados para gpt-5.1 são nenhum, baixo, médio e alto. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. Todos os modelos anteriores ao gpt-5.1 usam por defeito o esforço de raciocínio médio e não suportam nenhum. O modelo gpt-5-pro tem por defeito (e só suporta) um esforço de raciocínio elevado.	Não
└─ gerar_resumo	enumeração	Preterido: use `summary` em vez disso. Um resumo do raciocínio realizado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo. Um de `auto`, `concise`ou `detailed`. Valores possíveis: `auto`, `concise`, `detailed`	Não
└─ Resumo	enumeração	Um resumo do raciocínio realizado pelo modelo. Isto pode ser útil para depurar e compreender o processo de raciocínio do modelo. Um de `auto`, `concise`ou `detailed`. Valores possíveis: `auto`, `concise`, `detailed`	Não
nível_de_serviço	objecto	Especifica o tipo de processamento usado para atender à solicitação. * Se definido como 'auto', então o pedido será processado no nível de serviço configurado nas definições do Projeto. A menos que configurado de outra forma, o projeto usará 'default'. * Se definido como 'default', o pedido será processado com o standard preços e desempenho para o modelo selecionado. * Se definido para 'flex' ou 'prioridade', então o pedido será processado com o serviço correspondente de nível. Entre em contato com o departamento de vendas para saber mais sobre o processamento prioritário. * Quando não está definido, o comportamento padrão é 'auto'. Quando o `service_tier` parâmetro é definido, o corpo de resposta incluirá o `service_tier` valor baseado no modo de processamento efetivamente utilizado para servir o pedido. Este valor de resposta pode ser diferente do valor definido no parâmetro.	Não
armazenar	Booleano	Se a resposta do modelo gerado deve ser armazenada para recuperação posterior via API.	Não	Verdade
fluxo	Booleano	Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente como é gerado usando eventos enviados pelo servidor. para mais informações.	Não	Falso
structured_inputs	objecto	As entradas estruturadas para a resposta que podem participar na substituição de modelos de prompt ou em ligações de argumentos de ferramenta.	Não
temperatura	número	Qual a temperatura de amostragem a utilizar, entre 0 e 2. Valores mais altos como 0,8 tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente, recomendamos alterar isto ou `top_p`, mas não ambos.	Não	1
enviar SMS	objecto	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Ver Entradas e saídas de texto e Saídas Estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
tool_choice	objecto	Controla qual (se houver) ferramenta é 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 fazer uma chamada. mais ferramentas. `required` significa que o modelo deve chamar uma ou mais ferramentas.	Não
└─ tipo	OpenAI.ToolChoiceObjectType	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas integradas.	Não
Ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. As duas categorias de ferramentas que você pode fornecer ao modelo são: - Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o funcionalidades do modelo, como pesquisa de arquivos. - Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame seu próprio código.	Não
top_logprobs	número inteiro	Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis de serem retornados em cada posição de token, cada um com uma probabilidade em log associada.	Não
top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com probabilidade top_p massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade são considerados. Geralmente, recomendamos alterar isto ou `temperature`, mas não ambos.	Não	1
truncation	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: Se o contexto desta resposta e das anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará o resposta para se ajustar à janela de contexto, descartando itens de entrada. no meio da conversa. - `disabled` (padrão): se uma resposta do modelo exceder a janela de contexto tamanho para um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
utilizador	cadeia (de caracteres)	Saiba mais sobre as melhores práticas de segurança.	Não

OpenAI.Deleted ConversationResource

Nome	Tipo	Description	Obrigatório
Suprimido	Booleano		Yes
id	cadeia (de caracteres)		Yes
objecto	enumeração	Valores possíveis: `conversation.deleted`	Yes

OpenAI.EasyInputMessage

Nome	Tipo	Description	Obrigatório	Predefinido
conteúdo	cadeia de caracteres ou matriz		Yes
função	cadeia (de caracteres)		Yes

OpenAI.Error

Nome	Tipo	Obrigatório
informação adicional	objecto	Não
código	cadeia (de caracteres)	Yes
debugInfo	objecto	Não
details	matriz	Não
mensagem	cadeia (de caracteres)	Yes
param	cadeia (de caracteres)	Yes
tipo	cadeia (de caracteres)	Yes

OpenAI.EvalApiError

Um objeto que representa uma resposta de erro da API Eval.

Nome	Tipo	Description	Obrigatório	Predefinido
código	cadeia (de caracteres)	O código de erro.	Yes
mensagem	cadeia (de caracteres)	A mensagem de erro.	Yes

OpenAI.EvalGraderLabelModel

Nome	Tipo	Description	Obrigatório
dados introduzidos	matriz		Yes
labels	matriz	Os rótulos a atribuir a cada item na avaliação.	Yes
modelo	cadeia (de caracteres)	O modelo a utilizar para a avaliação. Deve suportar resultados estruturados.	Yes
nome	cadeia (de caracteres)	O nome do classificador.	Yes
etiquetas_de_passagem	matriz	Os rótulos que indicam um resultado positivo. 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
etiqueta_imagem	cadeia (de caracteres)	A tag de imagem a ser usada para o script python.	Não
nome	cadeia (de caracteres)	O nome do classificador.	Yes
limite_de_passagem	objecto		Não
origem	cadeia (de caracteres)	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
dados introduzidos	matriz	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Yes
modelo	cadeia (de caracteres)	O modelo a utilizar para a avaliação.	Yes
nome	cadeia (de caracteres)	O nome do classificador.	Yes
limite_de_passagem	objecto		Não
intervalo	matriz	O intervalo da pontuação. O padrão é `[0, 1]`.	Não
parâmetros_de_amostragem	objecto		Não
└─ max_completions_tokens	OpenAI.integer		Não
└─ esforço_de_raciocínio	OpenAI.ReasoningEffort	Restringe o esforço no raciocínio para modelos de raciocínio. Os valores atualmente suportados são nenhum, mínimo, baixo, médio e alto. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta. O GPT-5.1 por defeito é nenhum, que não executa raciocínio. Os valores de raciocínio suportados para gpt-5.1 são nenhum, baixo, médio e alto. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. Todos os modelos anteriores ao gpt-5.1 usam por defeito o esforço de raciocínio médio e não suportam nenhum. O modelo gpt-5-pro tem por defeito (e só suporta) um esforço de raciocínio elevado.	Não
└─ sementes	OpenAI.integer		Não
└─ temperatura	OpenAI.numeric		Não
└─ top_p	OpenAI.numeric		Não
tipo	enumeração	O tipo de objeto, que é sempre `score_model`. Valores possíveis: `score_model`	Yes

OpenAI.EvalGraderScoreModelSamplingParams

Nome	Tipo	Description	Obrigatório
max_completions_tokens	objecto		Não
esforço de raciocínio	OpenAI.ReasoningEffort	Restringe o esforço no raciocínio para modelos de raciocínio. Os valores atualmente suportados são nenhum, mínimo, baixo, médio e alto. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta. O GPT-5.1 por defeito é nenhum, que não executa raciocínio. Os valores de raciocínio suportados para gpt-5.1 são nenhum, baixo, médio e alto. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. Todos os modelos anteriores ao gpt-5.1 usam por defeito o esforço de raciocínio médio e não suportam nenhum. O modelo gpt-5-pro tem por defeito (e só suporta) um esforço de raciocínio elevado.	Não
seed	objecto		Não
temperatura	objecto		Não
top_p	objecto		Não

OpenAI.EvalGraderStringCheck

Nome	Tipo	Description	Obrigatório
dados introduzidos	cadeia (de caracteres)	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Yes
nome	cadeia (de caracteres)	O nome do classificador.	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`, `like`, `ilike`	Yes
referenciar	cadeia (de caracteres)	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 dos `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`, `gleumeteor`, `rouge_1rouge_2`, `rouge_3`, `rouge_4rouge_5rouge_l`	Yes
dados introduzidos	cadeia (de caracteres)	O texto que está a ser classificado.	Yes
nome	cadeia (de caracteres)	O nome do classificador.	Yes
limite_de_passagem	objecto		Yes
referenciar	cadeia (de caracteres)	O texto que está a ser avaliado.	Yes
tipo	enumeração	O tipo de motoniveladora. Valores possíveis: `text_similarity`	Yes

OpenAI.EvalItem

Uma entrada de mensagem para o modelo com uma função que indica a adesão a uma hierarquia de instruções. As instruções dadas com a developer função ou system têm precedência sobre as instruções dadas com a user função. 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	objecto	Uma entrada de texto para o modelo.	Yes
└─ dados	cadeia (de caracteres)	Dados de áudio codificados em Base64.	Não
└─ detalhe	cadeia (de caracteres)		Não
└─ formato	enumeração	O formato dos dados de áudio. Os formatos atualmente suportados são `mp3` e `wav`. Valores possíveis: `mp3`, `wav`	Não
└─ image_url	cadeia (de caracteres)		Não
└─ texto	cadeia (de caracteres)		Não
└─ tipo	enumeração	O tipo do item de entrada. Sempre `input_audio`. Valores possíveis: `input_audio`	Não
função	enumeração	A função da entrada de mensagem. Um dos `user`, `assistant`, `system`, ou `developer`. Valores possíveis: `user`, `assistant`, `system`, `developer`	Yes
tipo	enumeração	O tipo de entrada de mensagem. Sempre `message`. Valores possíveis: `message`	Não

OpenAI.EvalItemContentInputImage

Nome	Tipo	Description	Obrigatório
detail	cadeia (de caracteres)		Não
image_url	cadeia (de caracteres)		Yes
tipo	enumeração	Valores possíveis: `input_image`	Yes

OpenAI.EvalItemContentOutputText

Nome	Tipo	Description	Obrigatório	Predefinido
enviar SMS	cadeia (de caracteres)		Yes
tipo	enumeração	Valores possíveis: `output_text`	Yes

OpenAI.EvalJsonlFileContentSource

Nome	Tipo	Description	Obrigatório	Predefinido
conteúdo	matriz	O conteúdo do arquivo jsonl.	Yes
tipo	enumeração	O tipo de fonte jsonl. Sempre `file_content`. Valores possíveis: `file_content`	Yes

OpenAI.EvalJsonlFileContentSourceContent

Nome	Tipo	Description	Obrigatório	Predefinido
item	objecto		Yes
amostra	objecto		Não

OpenAI.EvalJsonlFileIdSource

Nome	Tipo	Description	Obrigatório	Predefinido
id	cadeia (de caracteres)	O identificador do arquivo.	Yes
tipo	enumeração	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
criado_depois	objecto		Não
criado_antes	objecto		Não
instructions_search	cadeia (de caracteres)		Não
metadados	objecto		Não
modelo	cadeia (de caracteres)		Não
esforço de raciocínio	objecto	Restringe o esforço no raciocínio para modelos de raciocínio. Os valores atualmente suportados são nenhum, mínimo, baixo, médio e alto. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta. O GPT-5.1 por defeito é nenhum, que não executa raciocínio. Os valores de raciocínio suportados para gpt-5.1 são nenhum, baixo, médio e alto. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. Todos os modelos anteriores ao gpt-5.1 usam por defeito o esforço de raciocínio médio e não suportam nenhum. O modelo gpt-5-pro tem por defeito (e só suporta) um esforço de raciocínio elevado.	Não
temperatura	objecto		Não
Ferramentas	matriz		Não
top_p	objecto		Não
tipo	enumeração	O tipo de fonte de dados de execução. Sempre `responses`. Valores possíveis: `responses`	Yes
users	matriz		Não

OpenAI.EvalRunOutputItemSample

Nome	Tipo	Description	Obrigatório
erro	OpenAI.EvalApiError	Um objeto que representa uma resposta de erro da API Eval.	Yes
motivo_de_finalização	cadeia (de caracteres)		Yes
dados introduzidos	matriz		Yes
max_completion_tokens	OpenAI.integer		Yes
modelo	cadeia (de caracteres)		Yes
output	matriz		Yes
seed	OpenAI.integer		Yes
temperatura	OpenAI.numeric		Yes
top_p	OpenAI.numeric		Yes
utilização	OpenAI.EvalRunOutputItemSampleUsage		Yes

OpenAI.EvalRunOutputItemSampleInput

Nome	Tipo	Description	Obrigatório	Predefinido
conteúdo	cadeia (de caracteres)		Yes
função	cadeia (de caracteres)		Yes

OpenAI.EvalRunOutputItemSampleOutput

Nome	Tipo	Description	Obrigatório	Predefinido
conteúdo	cadeia (de caracteres)		Não
função	cadeia (de caracteres)		Não

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 (de caracteres)	Yes
prompt_tokens	OpenAI.integer	Yes
total_tokens	OpenAI.integer	Yes

OpenAI.EvalRunPerTestingCriteriaResults

Nome	Tipo	Obrigatório
com falhas	OpenAI.integer	Yes
aprovado	OpenAI.integer	Yes
critérios_teste	cadeia (de caracteres)	Yes

OpenAI.EvalRunResultCounts

Nome	Tipo	Obrigatório
erro	OpenAI.integer	Yes
com falhas	OpenAI.integer	Yes
aprovado	OpenAI.integer	Yes
total	OpenAI.integer	Yes

OpenAI.EvalStoredCompletionsSource

Uma configuração StoredCompletionsRunDataSource descrevendo um conjunto de filtros

Nome	Tipo	Description	Obrigatório
criado_depois	objecto		Não
criado_antes	objecto		Não
limit	objecto		Não
metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
modelo	cadeia (de caracteres)		Não
tipo	enumeração	O tipo de fonte. Sempre `stored_completions`. Valores possíveis: `stored_completions`	Yes

OpenAI.FileSearchTool

Uma ferramenta que procura conteúdo relevante a partir de ficheiros carregados.

Nome	Tipo	Description	Obrigatório
filters	objecto		Não
máximo_número_de_resultados	número inteiro	O número máximo de resultados a serem retornados. Este número deve situar-se entre 1 e 50, inclusive.	Não
opções_de_classificação	objecto		Não
└─ classificador	enumeração	O classificador a ser usado para a pesquisa de arquivos. Valores possíveis: `auto`, `default-2024-11-15`	Não
└─ limiar_de_pontuação	número	O limite de pontuação para a pesquisa de ficheiros, 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.	Não
tipo	enumeração	O tipo da ferramenta de pesquisa de ficheiros. Sempre `file_search`. Valores possíveis: `file_search`	Yes
identificadores_de_armazém_de_vectores	matriz	Os IDs do vetor armazena para pesquisar.	Yes

OpenAI.FileSearchToolCallItemParam

Os resultados de uma chamada de ferramenta de pesquisa de arquivos. Consulte o guia de pesquisa de arquivos para obter mais informações.

Nome	Tipo	Description	Obrigatório
queries	matriz	As consultas usadas para procurar arquivos.	Yes
results	matriz	Os resultados da chamada da ferramenta de pesquisa de ficheiros.	Não
tipo	enumeração	Valores possíveis: `file_search_call`	Yes

OpenAI.FileSearchToolCallItemResource

Os resultados de uma chamada de ferramenta de pesquisa de arquivos. Consulte o guia de pesquisa de arquivos para obter mais informações.

Nome	Tipo	Description	Obrigatório
queries	matriz	As consultas usadas para procurar arquivos.	Yes
results	matriz	Os resultados da chamada da ferramenta de pesquisa de ficheiros.	Não
estado	enumeração	O status da chamada da ferramenta de pesquisa de arquivos. Um dos `in_progress`, `searching`, `incomplete` ou `failed`, Valores possíveis: `in_progress`, `searching`, `completed`, `incomplete`, , `failed`	Yes
tipo	enumeração	Valores possíveis: `file_search_call`	Yes

OpenAI.Filtros

Nome	Tipo	Description	Obrigatório
filters	matriz	Matriz de filtros para combinar. Os itens podem ser `ComparisonFilter` ou `CompoundFilter`.	Yes
chave	cadeia (de caracteres)	A chave pela qual se compara o valor.	Yes
tipo	enumeração	Tipo de operação: `and` ou `or`. Valores possíveis: `and`, `or`	Yes
valor	string ou número ou booleano	O valor a ser comparado com a chave de atributo; suporta tipos de string, número ou booleanos.	Yes

OpenAI.FineTuneDPOHyperparameters

Os hiperparâmetros usados para a tarefa de otimização do DPO.

Nome	Tipo	Description	Obrigatório
tamanho do lote	enumeração	Valores possíveis: `auto`	Não
beta	enumeração	Valores possíveis: `auto`	Não
multiplicador_da_taxa_de_aprendizagem	enumeração	Valores possíveis: `auto`	Não
número_de_épocas	enumeração	Valores possíveis: `auto`	Não

OpenAI.FineTuneDPOMethod

Configuração para o método de ajuste fino do DPO.

Nome	Tipo	Description	Obrigatório	Predefinido
hiperparâmetros	OpenAI.FineTuneDPOHyperparameters	Os hiperparâmetros usados para a tarefa de otimização do DPO.	Não

Método OpenAI.FineTune

O método utilizado para o ajuste fino.

Nome	Tipo	Description	Obrigatório
Responsável pela Proteção de Dados (DPO)	OpenAI.FineTuneDPOMethod	Configuração para o método de ajuste fino do DPO.	Não
reforço	OpenAI.FineTuneReinforcementMethod	Configuração para o método de ajuste fino de reforço.	Não
supervisionado	OpenAI.FineTuneSupervisedMethod	Configuração para o método de ajuste fino supervisionado.	Não
tipo	enumeração	O tipo de método. É `supervised`, `dpo` ou `reinforcement`. Valores possíveis: `supervised`, `dpo`, `reinforcement`	Yes

OpenAI.FineTuneReinforcementHyperparameters

Os hiperparâmetros utilizados para o trabalho de ajuste fino de reforço.

Nome	Tipo	Description	Obrigatório
tamanho do lote	enumeração	Valores possíveis: `auto`	Não
compute_multiplier	enumeração	Valores possíveis: `auto`	Não
intervalo_de_avaliação	enumeração	Valores possíveis: `auto`	Não
amostras de avaliação	enumeração	Valores possíveis: `auto`	Não
multiplicador_da_taxa_de_aprendizagem	enumeração	Valores possíveis: `auto`	Não
número_de_épocas	enumeração	Valores possíveis: `auto`	Não
esforço de raciocínio	enumeração	Nível de esforço de raciocínio. Valores possíveis: `default`, `low`, `medium`, `high`	Não

OpenAI.FineTuneReinforcementMethod

Configuração para o método de ajuste fino de reforço.

Nome	Tipo	Description	Obrigatório
Motoniveladora	objecto	Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada.	Yes
└─ calcular_saída	cadeia (de caracteres)	Uma fórmula para calcular o resultado com base nos resultados do classificador.	Não
└─ métrica_de_avaliação	enumeração	A métrica de avaliação a ser usada. Um dos `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`, `gleumeteor`, `rouge_1rouge_2`, `rouge_3`, `rouge_4rouge_5rouge_l`	Não
└─ Motoniveladoras	OpenAI.GraderStringCheck ou OpenAI.GraderTextSimilarity ou OpenAI.GraderPython ou OpenAI.GraderScoreModel ou OpenAI.GraderLabelModel	Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada.	Não
└─ tag de imagem	cadeia (de caracteres)	A tag de imagem a ser usada para o script python.	Não
└─ entrada	matriz	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Não
└─ modelo	cadeia (de caracteres)	O modelo a utilizar para a avaliação.	Não
└─ nome	cadeia (de caracteres)	O nome do classificador.	Não
└─ 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`, `like`, `ilike`	Não
└─ gama	matriz	O intervalo da pontuação. O padrão é `[0, 1]`.	Não
└─ referência	cadeia (de caracteres)	O texto que está a ser avaliado.	Não
└─ parâmetros_de_amostragem	OpenAI.EvalGraderScoreModelSamplingParams	Os parâmetros de amostragem para o modelo.	Não
└─ fonte	cadeia (de caracteres)	O código-fonte do script python.	Não
└─ tipo	enumeração	O tipo de objeto, que é sempre `multi`. Valores possíveis: `multi`	Não
hiperparâmetros	OpenAI.FineTuneReinforcementHyperparameters	Os hiperparâmetros utilizados para o trabalho de ajuste fino de reforço.	Não

OpenAI.FineTuneSupervisedHyperparameters

Os hiperparâmetros usados para o trabalho de ajuste fino.

Nome	Tipo	Description	Obrigatório
tamanho do lote	enumeração	Valores possíveis: `auto`	Não
multiplicador_da_taxa_de_aprendizagem	enumeração	Valores possíveis: `auto`	Não
número_de_épocas	enumeração	Valores possíveis: `auto`	Não

OpenAI.FineTuneSupervisedMethod

Configuração para o método de ajuste fino supervisionado.

Nome	Tipo	Description	Obrigatório	Predefinido
hiperparâmetros	OpenAI.FineTuneSupervisedHyperparameters	Os hiperparâmetros usados para o trabalho de ajuste fino.	Não

OpenAI.FineTuningIntegration

Discriminador para OpenAI.FineTuningIntegration

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

Valor do tipo	Schema
`wandb`	OpenAI.FineTuningIntegrationWandb

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	string (ver modelos válidos abaixo)		Yes

OpenAI.FineTuningIntegrationWandb

Nome	Tipo	Description	Obrigatório
tipo	enumeração	O tipo de integração que está sendo habilitado para o trabalho de ajuste fino Valores possíveis: `wandb`	Yes
wandb	objecto	As configurações para a sua integração com Weights and Biases. Esta carga especifica o projeto que As métricas serão enviadas para. Opcionalmente, você pode definir um nome de exibição explícito para sua execução, adicionar tags à sua execução, e defina uma entidade padrão (equipa, nome de utilizador, etc.) para ser associada à sua execução.	Yes
└─ entidade	cadeia (de caracteres)	A entidade a ser usada para a execução. Isso permite que você defina a equipa ou o nome de utilizador do WandB que você deseja. como associado à corrida. Se não estiver definida, a entidade padrão para a chave WandB API registrada será usada.	Não
└─ nome	cadeia (de caracteres)	Um nome de exibição a ser definido para a execução. Se não estiver definido, usaremos o ID do trabalho como o nome.	Não
└─ projeto	cadeia (de caracteres)	O nome do projeto sob o qual a nova execução será executada.	Não
└─ Tags	matriz	Uma lista de tags para serem anexadas à execução recém-criada. Essas tags são passadas diretamente para WandB. Some as tags padrão são geradas pelo OpenAI: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".	Não

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
criado_em	número inteiro	O carimbo de data/hora do Unix (em segundos) em que a tarefa de ajuste fino foi criada.	Yes
erro	objecto	Para trabalhos de ajuste fino que têm `failed`, isso conterá mais informações sobre a causa da falha.	Yes
└─ código	cadeia (de caracteres)	Um código de erro legível por máquina.	Não
└─ mensagem	cadeia (de caracteres)	Uma mensagem de erro legível por humanos.	Não
└─ Param	cadeia (de caracteres)	O parâmetro que era inválido, geralmente `training_file` ou `validation_file`. Este campo será nulo se a falha não for específica do parâmetro.	Não
conclusão_estimada	número inteiro	O carimbo de data/hora do Unix (em segundos) para quando o trabalho de ajuste fino é estimado para terminar. O valor será nulo se o trabalho de ajuste fino não estiver em execução.	Não
fine_tuned_model	cadeia (de caracteres)	O nome do modelo aprimorado que está em processo de criação. O valor será nulo se o trabalho de ajuste fino ainda estiver em execução.	Yes
concluído_em	número inteiro	A marca temporal Unix (em segundos) para quando o trabalho de ajustamento fino foi concluído. O valor será nulo se o trabalho de ajuste fino ainda estiver em execução.	Yes
hiperparâmetros	objecto	Os hiperparâmetros usados para o trabalho de ajuste fino. Esse valor só será retornado ao executar `supervised` trabalhos.	Yes
└─ tamanho_do_lote (batch_size)	enumeração	Valores possíveis: `auto`	Não
└─ multiplicador_da_taxa_de_aprendizagem	enumeração	Valores possíveis: `auto`	Não
└─ n_epochs	enumeração	Valores possíveis: `auto`	Não
id	cadeia (de caracteres)	O identificador de objeto, que pode ser referenciado nos endpoints da API.	Yes
integrações	matriz	Uma lista de integrações para habilitar esse trabalho de ajuste fino.	Não
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
método	Método OpenAI.FineTune	O método utilizado para o ajuste fino.	Não
modelo	cadeia (de caracteres)	O modelo base que está a ser afinado.	Yes
objecto	enumeração	O tipo de objeto, que é sempre "fine_tuning.job". Valores possíveis: `fine_tuning.job`	Yes
organization_id	cadeia (de caracteres)	A organização proprietária da tarefa de ajuste fino.	Yes
ficheiros_resultado	matriz	Os ID(s) do arquivo de resultados compilados para a tarefa de afinação. Você pode recuperar os resultados com a API de arquivos.	Yes
seed	número inteiro	A semente usada para o trabalho de ajuste de precisão.	Yes
estado	enumeração	O status atual do trabalho de ajuste fino, que pode ser `validating_files`, `queued`, `running`, `succeeded`, `failed` ou `cancelled`. Valores possíveis: `validating_files`, `queued`, `running`, `succeeded`, , `failed`, `cancelled`	Yes
trained_tokens	número inteiro	O número total de tokens faturáveis processados por esse trabalho de ajuste fino. O valor será nulo se o trabalho de ajuste fino ainda estiver em execução.	Yes
ficheiro de treino	cadeia (de caracteres)	O identificador do ficheiro usado para treinamento. Você pode recuperar os dados de treinamento com a API de arquivos.	Yes
user_provided_suffix	cadeia (de caracteres)	O sufixo descritivo aplicado ao trabalho, conforme especificado na solicitação de criação de trabalho.	Não
ficheiro_de_validação	cadeia (de caracteres)	O ID do arquivo usado para validação. Você pode recuperar os resultados da validação com a API de arquivos.	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	número inteiro	O carimbo de data/hora Unix (em segundos) para quando o ponto de verificação foi criado.	Yes
ponto de verificação do modelo ajustado	cadeia (de caracteres)	O nome do modelo de ponto de verificação ajustado que é criado.	Yes
ID_de_tarefa_de_ajuste_fino	cadeia (de caracteres)	O nome do trabalho de ajuste fino a partir do qual esse ponto de verificação foi criado.	Yes
id	cadeia (de caracteres)	O identificador de ponto de verificação, que pode ser referenciado nos endpoints da API.	Yes
métricas	objecto	Métricas na etapa especificada durante o processo de ajuste fino.	Yes
└─ perda_validação_completa	número		Não
└─ precisão_média_do_token_válido_total	número		Não
└─ passo	número		Não
└─ perda_treino	número		Não
└─ precisão_média_de_tokens_de_treinamento	número		Não
└─ perda_de_validação	número		Não
└─ precisão_média_do_token_válido	número		Não
objecto	enumeração	O tipo de objeto, que é sempre "fine_tuning.job.checkpoint". Valores possíveis: `fine_tuning.job.checkpoint`	Yes
número_etapa	número inteiro	O número da etapa em que o ponto de verificação foi criado.	Yes

OpenAI.FineTuningJobEvent

Otimização do objeto de evento de tarefa

Nome	Tipo	Description	Obrigatório
criado_em	número inteiro	O carimbo de data/hora do Unix (em segundos) em que a tarefa de ajuste fino foi criada.	Yes
dados		Os dados associados ao evento.	Não
id	cadeia (de caracteres)	O identificador de objeto.	Yes
nível	enumeração	O nível de log do evento. Valores possíveis: `info`, `warn`, `error`	Yes
mensagem	cadeia (de caracteres)	A mensagem do evento.	Yes
objecto	enumeração	O tipo de objeto, que é invariavelmente "fine_tuning.job.event". Valores possíveis: `fine_tuning.job.event`	Yes
tipo	enumeração	O tipo de evento. Valores possíveis: `message`, `metrics`	Não

OpenAI.FunctionObject

Nome	Tipo	Description	Obrigatório	Predefinido
descrição	cadeia (de caracteres)	Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função.	Não
nome	cadeia (de caracteres)	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
parâmetros		Os parâmetros que as funções aceitam, descritos como um objeto de esquema JSON. Consulte o guia para obter exemplos e a referência de esquema JSON para obter documentação sobre o formato. Omitir `parameters` define uma função com uma lista de parâmetros vazia.	Não
rigoroso	Booleano	Se a adesão estrita ao esquema deve ser ativada ao gerar a chamada de função. Se definido como true, o modelo seguirá o esquema exato definido no `parameters` campo. Somente um subconjunto de esquema JSON é suportado quando `strict` é `true`. Saiba mais sobre Saídas Estruturadas no	Não	Falso

OpenAI.FunctionTool

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

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	Uma descrição da função. Usado pelo modelo para determinar se a função deve ou não ser chamada.	Não
nome	cadeia (de caracteres)	O nome da função a ser chamada.	Yes
parâmetros		Um objeto de esquema JSON que descreve os parâmetros da função.	Yes
rigoroso	Booleano	Se a validação de parâmetros estrita deve ser imposta. Padrão `true`.	Yes
tipo	enumeração	O tipo da ferramenta de função. Sempre `function`. Valores possíveis: `function`	Yes

OpenAI.FunctionToolCallItemParam

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 (de caracteres)	Uma cadeia de caracteres JSON dos argumentos a serem passados para a função.	Yes
call_id	cadeia (de caracteres)	O ID exclusivo da chamada da ferramenta funcional gerada pelo modelo.	Yes
nome	cadeia (de caracteres)	O nome da função a ser executada.	Yes
tipo	enumeração	Valores possíveis: `function_call`	Yes

OpenAI.FunctionToolCallItemResource

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 (de caracteres)	Uma cadeia de caracteres JSON dos argumentos a serem passados para a função.	Yes
call_id	cadeia (de caracteres)	O ID exclusivo da chamada da ferramenta funcional gerada pelo modelo.	Yes
nome	cadeia (de caracteres)	O nome da função a ser executada.	Yes
estado	enumeração	O estado do item. Um dos `in_progress`, `completed`, ou `incomplete`. É preenchido quando os itens são retornados via API. Valores possíveis: `in_progress`, `completed`, `incomplete`	Yes
tipo	enumeração	Valores possíveis: `function_call`	Yes

OpenAI.FunctionToolCallOutputItemParam

A saída de uma chamada de ferramenta funcional.

Nome	Tipo	Description	Obrigatório
call_id	cadeia (de caracteres)	O ID exclusivo da chamada da ferramenta funcional gerada pelo modelo.	Yes
output	cadeia (de caracteres)	Uma cadeia de caracteres JSON da saída da chamada da ferramenta funcional.	Yes
tipo	enumeração	Valores possíveis: `function_call_output`	Yes

OpenAI.FunctionToolCallOutputItemResource

A saída de uma chamada de ferramenta funcional.

Nome	Tipo	Description	Obrigatório
call_id	cadeia (de caracteres)	O ID exclusivo da chamada da ferramenta funcional gerada pelo modelo.	Yes
output	cadeia (de caracteres)	Uma cadeia de caracteres JSON da saída da chamada da ferramenta funcional.	Yes
estado	enumeração	O estado do item. Um dos `in_progress`, `completed`, ou `incomplete`. É preenchido quando os itens são retornados via API. Valores possíveis: `in_progress`, `completed`, `incomplete`	Yes
tipo	enumeração	Valores possíveis: `function_call_output`	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
dados introduzidos	matriz		Yes
labels	matriz	Os rótulos a atribuir a cada item na avaliação.	Yes
modelo	cadeia (de caracteres)	O modelo a utilizar para a avaliação. Deve suportar resultados estruturados.	Yes
nome	cadeia (de caracteres)	O nome do classificador.	Yes
etiquetas_de_passagem	matriz	Os rótulos que indicam um resultado positivo. 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 classificadores para produzir uma única pontuação.

Nome	Tipo	Description	Obrigatório
calcular_saida	cadeia (de caracteres)	Uma fórmula para calcular o resultado com base nos resultados do classificador.	Yes
Motoniveladoras	objecto	Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada.	Yes
└─ métrica_de_avaliação	enumeração	A métrica de avaliação a ser usada. Um dos `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`, `gleumeteor`, `rouge_1rouge_2`, `rouge_3`, `rouge_4rouge_5rouge_l`	Não
└─ tag de imagem	cadeia (de caracteres)	A tag de imagem a ser usada para o script python.	Não
└─ entrada	matriz		Não
└─ Rótulos	matriz	Os rótulos a atribuir a cada item na avaliação.	Não
└─ modelo	cadeia (de caracteres)	O modelo a utilizar para a avaliação. Deve suportar resultados estruturados.	Não
└─ nome	cadeia (de caracteres)	O nome do classificador.	Não
└─ 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`, `like`, `ilike`	Não
└─ passing_labels	matriz	Os rótulos que indicam um resultado positivo. Deve ser um subconjunto de rótulos.	Não
└─ gama	matriz	O intervalo da pontuação. O padrão é `[0, 1]`.	Não
└─ referência	cadeia (de caracteres)	O texto que está a ser avaliado.	Não
└─ parâmetros_de_amostragem	OpenAI.EvalGraderScoreModelSamplingParams	Os parâmetros de amostragem para o modelo.	Não
└─ fonte	cadeia (de caracteres)	O código-fonte do script python.	Não
└─ tipo	enumeração	O tipo de objeto, que é sempre `label_model`. Valores possíveis: `label_model`	Não
nome	cadeia (de caracteres)	O nome do classificador.	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
etiqueta_imagem	cadeia (de caracteres)	A tag de imagem a ser usada para o script python.	Não
nome	cadeia (de caracteres)	O nome do classificador.	Yes
origem	cadeia (de caracteres)	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
dados introduzidos	matriz	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Yes
modelo	cadeia (de caracteres)	O modelo a utilizar para a avaliação.	Yes
nome	cadeia (de caracteres)	O nome do classificador.	Yes
intervalo	matriz	O intervalo da pontuação. O padrão é `[0, 1]`.	Não
parâmetros_de_amostragem	objecto		Não
└─ max_completions_tokens	OpenAI.integer		Não
└─ esforço_de_raciocínio	OpenAI.ReasoningEffort	Restringe o esforço no raciocínio para modelos de raciocínio. Os valores atualmente suportados são nenhum, mínimo, baixo, médio e alto. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta. O GPT-5.1 por defeito é nenhum, que não executa raciocínio. Os valores de raciocínio suportados para gpt-5.1 são nenhum, baixo, médio e alto. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. Todos os modelos anteriores ao gpt-5.1 usam por defeito o esforço de raciocínio médio e não suportam nenhum. O modelo gpt-5-pro tem por defeito (e só suporta) um esforço de raciocínio elevado.	Não
└─ sementes	OpenAI.integer		Não
└─ temperatura	OpenAI.numeric		Não
└─ top_p	OpenAI.numeric		Não
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
dados introduzidos	cadeia (de caracteres)	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Yes
nome	cadeia (de caracteres)	O nome do classificador.	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`, `like`, `ilike`	Yes
referenciar	cadeia (de caracteres)	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 dos `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`, `gleumeteor`, `rouge_1rouge_2`, `rouge_3`, `rouge_4rouge_5rouge_l`	Yes
dados introduzidos	cadeia (de caracteres)	O texto que está a ser classificado.	Yes
nome	cadeia (de caracteres)	O nome do classificador.	Yes
referenciar	cadeia (de caracteres)	O texto que está a ser avaliado.	Yes
tipo	enumeração	O tipo de motoniveladora. Valores possíveis: `text_similarity`	Yes

OpenAI.ImageGenTool

Uma ferramenta que gera imagens usando um modelo como gpt-image-1.

Nome	Tipo	Description	Obrigatório	Predefinido
em segundo plano	enumeração	Tipo de plano de fundo para a imagem gerada. Um dos `transparent`, `opaque`, ou `auto`. Padrão: `auto`. Valores possíveis: `transparent`, `opaque`, `auto`	Não
máscara_da_imagem_de_entrada	objecto	Máscara opcional para inpainting. Contém `image_url` (string, opcional) e `file_id` (string, opcional).	Não
└─ id_do_arquivo	cadeia (de caracteres)	ID do ficheiro para a imagem da máscara.	Não
└─ image_url	cadeia (de caracteres)	Imagem de máscara codificada em Base64.	Não
modelo	enumeração	O modelo de geração de imagem a ser usado. Padrão: `gpt-image-1`. Valores possíveis: `gpt-image-1`	Não
moderation	enumeração	Nível de moderação para a imagem gerada. Padrão: `auto`. Valores possíveis: `auto`, `low`	Não
compressão_de_saída	número inteiro	Nível de compressão para a imagem de saída. Padrão: 100.	Não	100
formato_de_saida	enumeração	O formato de saída da imagem gerada. Um dos `png`, `webp`, ou `jpeg`. Padrão: `png`. Valores possíveis: `png`, `webp`, `jpeg`	Não
imagens parciais	número inteiro	Número de imagens parciais para gerar no modo de streaming, de 0 (valor padrão) a 3.	Não	0
qualidade	enumeração	A qualidade da imagem gerada. Um dos `low`, `medium`, `high`, ou `auto`. Padrão: `auto`. Valores possíveis: `low`, `medium`, `high`, `auto`	Não
tamanho	enumeração	O tamanho da imagem gerada. Um dos `1024x1024`, `1024x1536`, `1536x1024`, ou `auto`. Padrão: `auto`. Valores possíveis: `1024x1024`, `1024x1536`, `1536x1024`, `auto`	Não
tipo	enumeração	O tipo da ferramenta de geração de imagem. Sempre `image_generation`. Valores possíveis: `image_generation`	Yes

OpenAI.ImageGenToolCallItemParam

Um pedido de geração de imagem feito pelo modelo.

Nome	Tipo	Description	Obrigatório	Predefinido
Resultado	cadeia (de caracteres)	A imagem gerada codificada em base64.	Yes
tipo	enumeração	Valores possíveis: `image_generation_call`	Yes

OpenAI.ImageGenToolCallItemResource

Um pedido de geração de imagem feito pelo modelo.

Nome	Tipo	Description	Obrigatório
Resultado	cadeia (de caracteres)	A imagem gerada codificada em base64.	Yes
estado	enumeração	Valores possíveis: `in_progress`, `completed`, `generating`, `failed`	Yes
tipo	enumeração	Valores possíveis: `image_generation_call`	Yes

OpenAI.Includable

Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Os valores atualmente suportados são:

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

Propriedade	valor
Descrição	Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Atualmente Os valores suportados são: - `code_interpreter_call.outputs`: Inclui as saídas de execução de código python Chamar itens na ferramenta de interpretação de código. - `computer_call_output.output.image_url`: Inclua URLs de imagens da saída de chamada do computador. - `file_search_call.results`: Incluir os resultados da pesquisa de a chamada da ferramenta de pesquisa de ficheiros. - `message.input_image.image_url`: Inclua urls de imagem da mensagem de entrada. - `message.output_text.logprobs`: Inclua logprobs com mensagens do assistente. - `reasoning.encrypted_content`: Inclui uma versão encriptada do raciocínio tokens em resultados de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em conversas com vários turnos ao usar a API de respostas sem estado (como quando o `store` parâmetro é definido como `false`, ou quando uma organização é inscritos no programa de retenção de dados zero).
Type	cadeia (de caracteres)
Valores	`code_interpreter_call.outputs` `computer_call_output.output.image_url` `file_search_call.results` `message.input_image.image_url` `message.output_text.logprobs` `reasoning.encrypted_content` `web_search_call.results` `web_search_call.action.sources` `memory_search_call.results`

OpenAI.ItemContent

Discriminador para OpenAI.ItemContent

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

Valor do tipo	Schema
`input_audio`	OpenAI.ItemContentInputAudio
`output_audio`	OpenAI.ItemContentOutputAudio
`refusal`	OpenAI.ItemContentRefusal
`input_text`	OpenAI.ItemContentInputText
`input_image`	OpenAI.ItemContentInputImage
`input_file`	OpenAI.ItemContentInputFile
`output_text`	OpenAI.ItemContentOutputText

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	OpenAI.ItemContentType	Conteúdos multimodais de entrada e saída.	Yes

OpenAI.ItemContentInputAudio

Uma entrada de áudio para o modelo.

Nome	Tipo	Description	Obrigatório
dados	cadeia (de caracteres)	Dados de áudio codificados em Base64.	Yes
format	enumeração	O formato dos dados de áudio. Os formatos atualmente suportados são `mp3` e `wav`. Valores possíveis: `mp3`, `wav`	Yes
tipo	enumeração	O tipo do item de entrada. Sempre `input_audio`. Valores possíveis: `input_audio`	Yes

OpenAI.ItemContentInputFile

Uma entrada de arquivo para o modelo.

Nome	Tipo	Description	Obrigatório
file_data	cadeia (de caracteres)	O conteúdo do arquivo a ser enviado para o modelo.	Não
identificação_de_ficheiro	cadeia (de caracteres)	A ID do arquivo a ser enviado para o modelo.	Não
filename	cadeia (de caracteres)	O nome do arquivo a ser enviado para o modelo.	Não
tipo	enumeração	O tipo do item de entrada. Sempre `input_file`. Valores possíveis: `input_file`	Yes

OpenAI.ItemContentInputImage

Uma entrada de imagem para o modelo. Saiba mais sobre entradas de imagem.

Nome	Tipo	Description	Obrigatório
detail	enumeração	O nível de detalhe da imagem a ser enviada para o modelo. Um de `high`, `low`ou `auto`. O padrão é `auto`. Valores possíveis: `low`, `high`, `auto`	Não
identificação_de_ficheiro	cadeia (de caracteres)	A ID do arquivo a ser enviado para o modelo.	Não
image_url	cadeia (de caracteres)	O URL da imagem a ser enviada para o modelo. Um URL totalmente qualificado ou uma imagem codificada em base64 em um URL de dados.	Não
tipo	enumeração	O tipo do item de entrada. Sempre `input_image`. Valores possíveis: `input_image`	Yes

OpenAI.ItemContentInputText

Uma entrada de texto para o modelo.

Nome	Tipo	Description	Obrigatório	Predefinido
enviar SMS	cadeia (de caracteres)	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.ItemContentOutputAudio

Uma saída de áudio do modelo.

Nome	Tipo	Description	Obrigatório
dados	cadeia (de caracteres)	Dados de áudio codificados em Base64 do modelo.	Yes
transcrição	cadeia (de caracteres)	A transcrição dos dados de áudio do modelo.	Yes
tipo	enumeração	O tipo de áudio de saída. Sempre `output_audio`. Valores possíveis: `output_audio`	Yes

OpenAI.ItemContentOutputText

Uma saída de texto do modelo.

Nome	Tipo	Description	Obrigatório
anotações	matriz	As anotações sobre a saída de texto.	Yes
Logprobs	matriz		Não
enviar SMS	cadeia (de caracteres)	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.ItemContentRefusal

Uma recusa do modelo.

Nome	Tipo	Description	Obrigatório	Predefinido
refusal	cadeia (de caracteres)	A explicação da recusa por parte do modelo.	Yes
tipo	enumeração	O tipo de recusa. Sempre `refusal`. Valores possíveis: `refusal`	Yes

OpenAI.ItemContentType

Conteúdos multimodais de entrada e saída.

Propriedade	valor
Descrição	Conteúdos multimodais de entrada e saída.
Type	cadeia (de caracteres)
Valores	`input_text` `input_audio` `input_image` `input_file` `output_text` `output_audio` `refusal`

OpenAI.ItemParam

Item de conteúdo usado para gerar uma resposta.

Discriminador para OpenAI.ItemParam

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

Valor do tipo	Schema
`message`	OpenAI.ResponsesMessageItemParam
`function_call_output`	OpenAI.FunctionToolCallOutputItemParam
`file_search_call`	OpenAI.FileSearchToolCallItemParam
`computer_call`	OpenAI.ComputerToolCallItemParam
`computer_call_output`	OpenAI.ComputerToolCallOutputItemParam
`web_search_call`	OpenAI.WebSearchToolCallItemParam
`function_call`	OpenAI.FunctionToolCallItemParam
`reasoning`	OpenAI.ReasoningItemParam
`item_reference`	OpenAI.ItemReferenceItemParam
`image_generation_call`	OpenAI.ImageGenToolCallItemParam
`code_interpreter_call`	OpenAI.CodeInterpreterToolCallItemParam
`local_shell_call`	OpenAI.LocalShellToolCallItemParam
`local_shell_call_output`	OpenAI.LocalShellToolCallOutputItemParam
`mcp_list_tools`	OpenAI.MCPListToolsItemParam
`mcp_approval_request`	OpenAI.MCPApprovalRequestItemParam
`mcp_approval_response`	OpenAI.MCPApprovalResponseItemParam
`mcp_call`	OpenAI.MCPCallItemParam
`memory_search_call`	MemorySearchToolCallItemParam

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	OpenAI.ItemType		Yes

OpenAI.ItemReferenceItemParam

Um identificador interno para um item a ser referenciado.

Nome	Tipo	Description	Obrigatório	Predefinido
id	cadeia (de caracteres)	O ID originado pelo serviço do item de resposta gerado anteriormente a que se faz referência.	Yes
tipo	enumeração	Valores possíveis: `item_reference`	Yes

OpenAI.ItemResource

Item de conteúdo usado para gerar uma resposta.

Discriminador de OpenAI.ItemResource

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

Valor do tipo	Schema
`structured_outputs`	StructuredOutputsItemResource
`workflow_action`	WorkflowAçãoSaídaItemRecurso
`oauth_consent_request`	OAuthConsentRequestItemResource
`message`	OpenAI.ResponsesMessageItemResource
`computer_call_output`	OpenAI.ComputerToolCallOutputItemResource
`function_call`	OpenAI.FunctionToolCallItemResource
`function_call_output`	OpenAI.FunctionToolCallOutputItemResource
`mcp_approval_response`	OpenAI.MCPApprovalResponseItemResource
`file_search_call`	OpenAI.FileSearchToolCallItemResource
`computer_call`	OpenAI.ComputerToolCallItemResource
`web_search_call`	OpenAI.WebSearchToolCallItemResource
`reasoning`	OpenAI.ReasoningItemResource
`image_generation_call`	OpenAI.ImageGenToolCallItemResource
`code_interpreter_call`	OpenAI.CodeInterpreterToolCallItemResource
`local_shell_call`	OpenAI.LocalShellToolCallItemResource
`local_shell_call_output`	OpenAI.LocalShellToolCallOutputItemResource
`mcp_list_tools`	OpenAI.MCPListToolsItemResource
`mcp_approval_request`	OpenAI.MCPApprovalRequestItemResource
`mcp_call`	OpenAI.MCPCallItemResource
`memory_search_call`	MemorySearchToolCallItemResource

Nome	Tipo	Description	Obrigatório
criado_por	objecto		Não
└─ agente	ID do agente	O agente que criou o item.	Não
└─ response_id	cadeia (de caracteres)	A resposta sobre a qual o item é criado.	Não
id	cadeia (de caracteres)		Yes
tipo	OpenAI.ItemType		Yes

OpenAI.ItemType

Propriedade valor

Type cadeia (de caracteres)

Valores message
file_search_call
function_call
function_call_output
computer_call
computer_call_output
web_search_call
reasoning
item_reference
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
structured_outputs
workflow_action
memory_search_call
oauth_consent_request

OpenAI.ListFineTuningJobCheckpointsResponse

Nome	Tipo	Description	Obrigatório
dados	matriz		Yes
first_id	cadeia (de caracteres)		Não
tem_mais	Booleano		Yes
last_id	cadeia (de caracteres)		Não
objecto	enumeração	Valores possíveis: `list`	Yes

OpenAI.ListFineTuningJobEventsResponse

Nome	Tipo	Description	Obrigatório
dados	matriz		Yes
tem_mais	Booleano		Yes
objecto	enumeração	Valores possíveis: `list`	Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Nome	Tipo	Description	Obrigatório
dados	matriz		Yes
tem_mais	Booleano		Yes
objecto	enumeração	Valores possíveis: `list`	Yes

OpenAI.LocalShellExecAction

Execute um comando shell no servidor.

Nome	Tipo	Description	Obrigatório
comando	matriz	O comando a ser executado.	Yes
env	objecto	Variáveis de ambiente a serem definidas para o comando.	Yes
timeout_ms (tempo limite em milissegundos)	número inteiro	Tempo limite opcional em milissegundos para o comando.	Não
tipo	enumeração	O tipo de ação do shell local. Sempre `exec`. Valores possíveis: `exec`	Yes
utilizador	cadeia (de caracteres)	Usuário opcional para executar o comando como.	Não
diretório_de_trabalho	cadeia (de caracteres)	Diretório de trabalho opcional para executar o comando.	Não

OpenAI.LocalShellTool

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

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

OpenAI.LocalShellToolCallItemParam

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 (de caracteres)	A ID exclusiva da chamada de ferramenta de shell local gerada pelo modelo.	Yes
tipo	enumeração	Valores possíveis: `local_shell_call`	Yes

OpenAI.LocalShellToolCallItemResource

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 (de caracteres)	A ID exclusiva da chamada de ferramenta de shell local gerada pelo modelo.	Yes
estado	enumeração	Valores possíveis: `in_progress`, `completed`, `incomplete`	Yes
tipo	enumeração	Valores possíveis: `local_shell_call`	Yes

OpenAI.LocalShellToolCallOutputItemParam

A saída de uma chamada de ferramenta shell local.

Nome	Tipo	Description	Obrigatório	Predefinido
output	cadeia (de caracteres)	Uma cadeia de caracteres JSON da saída da chamada da ferramenta shell local.	Yes
tipo	enumeração	Valores possíveis: `local_shell_call_output`	Yes

OpenAI.LocalShellToolCallOutputItemResource

A saída de uma chamada de ferramenta shell local.

Nome	Tipo	Description	Obrigatório
output	cadeia (de caracteres)	Uma cadeia de caracteres JSON da saída da chamada da ferramenta shell local.	Yes
estado	enumeração	Valores possíveis: `in_progress`, `completed`, `incomplete`	Yes
tipo	enumeração	Valores possíveis: `local_shell_call_output`	Yes

OpenAI.Localização

Discriminador para OpenAI.Location

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

Valor do tipo	Schema
`approximate`	OpenAI.AproximadaLocalização

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	OpenAI.LocationType		Yes

OpenAI.LocationType

Propriedade	valor
Type	cadeia (de caracteres)
Valores	`approximate`

OpenAI.LogProb

A probabilidade logarítmica de um token.

Nome	Tipo	Obrigatório
bytes	matriz	Yes
logprob	número	Yes
token	cadeia (de caracteres)	Yes
top_logprobs	matriz	Yes

OpenAI.MCPApprovalRequestItemParam

Um pedido de aprovação humana de uma invocação de ferramenta.

Nome	Tipo	Description	Obrigatório
arguments	cadeia (de caracteres)	Uma cadeia de argumentos JSON para a ferramenta.	Yes
nome	cadeia (de caracteres)	O nome da ferramenta a ser executada.	Yes
rótulo de servidor	cadeia (de caracteres)	O rótulo do servidor MCP que faz a solicitação.	Yes
tipo	enumeração	Valores possíveis: `mcp_approval_request`	Yes

OpenAI.MCPApprovalRequestItemResource

Um pedido de aprovação humana de uma invocação de ferramenta.

Nome	Tipo	Description	Obrigatório
arguments	cadeia (de caracteres)	Uma cadeia de argumentos JSON para a ferramenta.	Yes
nome	cadeia (de caracteres)	O nome da ferramenta a ser executada.	Yes
rótulo de servidor	cadeia (de caracteres)	O rótulo do servidor MCP que faz a solicitação.	Yes
tipo	enumeração	Valores possíveis: `mcp_approval_request`	Yes

OpenAI.MCPApprovalResponseItemParam

Uma resposta a uma solicitação de aprovação de MCP.

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia (de caracteres)	O identificador do pedido de aprovação ao qual se está a responder.	Yes
approve	Booleano	Se o pedido foi aprovado.	Yes
razão	cadeia (de caracteres)	Motivo facultativo da decisão.	Não
tipo	enumeração	Valores possíveis: `mcp_approval_response`	Yes

OpenAI.MCPApprovalResponseItemResource

Uma resposta a uma solicitação de aprovação de MCP.

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia (de caracteres)	O identificador do pedido de aprovação ao qual se está a responder.	Yes
approve	Booleano	Se o pedido foi aprovado.	Yes
razão	cadeia (de caracteres)	Motivo facultativo da decisão.	Não
tipo	enumeração	Valores possíveis: `mcp_approval_response`	Yes

OpenAI.MCPCallItemParam

Uma invocação de uma ferramenta em um servidor MCP.

Nome	Tipo	Description	Obrigatório
arguments	cadeia (de caracteres)	Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta.	Yes
erro	cadeia (de caracteres)	O erro na chamada da ferramenta, se houver.	Não
nome	cadeia (de caracteres)	O nome da ferramenta que foi executada.	Yes
output	cadeia (de caracteres)	A saída da chamada da ferramenta.	Não
rótulo de servidor	cadeia (de caracteres)	O rótulo do servidor MCP que executa a ferramenta.	Yes
tipo	enumeração	Valores possíveis: `mcp_call`	Yes

OpenAI.MCPCallItemResource

Uma invocação de uma ferramenta em um servidor MCP.

Nome	Tipo	Description	Obrigatório
arguments	cadeia (de caracteres)	Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta.	Yes
erro	cadeia (de caracteres)	O erro na chamada da ferramenta, se houver.	Não
nome	cadeia (de caracteres)	O nome da ferramenta que foi executada.	Yes
output	cadeia (de caracteres)	A saída da chamada da ferramenta.	Não
rótulo de servidor	cadeia (de caracteres)	O rótulo do servidor MCP que executa a ferramenta.	Yes
tipo	enumeração	Valores possíveis: `mcp_call`	Yes

OpenAI.MCPListToolsItemParam

Uma lista de ferramentas disponíveis em um servidor MCP.

Nome	Tipo	Description	Obrigatório
erro	cadeia (de caracteres)	Mensagem de erro se o servidor não pôde listar ferramentas.	Não
rótulo de servidor	cadeia (de caracteres)	O rótulo do servidor MCP.	Yes
Ferramentas	matriz	As ferramentas disponíveis no servidor.	Yes
tipo	enumeração	Valores possíveis: `mcp_list_tools`	Yes

OpenAI.MCPListToolsItemResource

Uma lista de ferramentas disponíveis em um servidor MCP.

Nome	Tipo	Description	Obrigatório
erro	cadeia (de caracteres)	Mensagem de erro se o servidor não pôde listar ferramentas.	Não
rótulo de servidor	cadeia (de caracteres)	O rótulo do servidor MCP.	Yes
Ferramentas	matriz	As ferramentas disponíveis no servidor.	Yes
tipo	enumeração	Valores possíveis: `mcp_list_tools`	Yes

OpenAI.MCPListToolsTool

Uma ferramenta disponível em um servidor MCP.

Nome	Tipo	Description	Obrigatório
anotações		Anotações adicionais sobre a ferramenta.	Não
descrição	cadeia (de caracteres)	A descrição da ferramenta.	Não
input_schema		O esquema JSON que descreve a entrada da ferramenta.	Yes
nome	cadeia (de caracteres)	O nome da ferramenta.	Yes

OpenAI.MCPTool

Dê ao modelo acesso a ferramentas adicionais por meio de servidores MCP (Model Context Protocol) remotos. Saiba mais sobre o MCP.

Nome	Tipo	Description	Obrigatório
ferramentas permitidas	objecto		Não
└─ nomes_de_ferramentas	matriz	Lista de nomes de ferramentas permitidas.	Não
headers	objecto	Cabeçalhos HTTP opcionais para enviar ao servidor MCP. Uso para autenticação ou outros fins.	Não
project_connection_id	cadeia (de caracteres)	O ID de conexão no projeto para o servidor MCP. A conexão armazena autenticação e outros detalhes de conexão necessários para se conectar ao servidor MCP.	Não
requer_aprovação	objeto (ver modelos válidos abaixo)	Especifique quais das ferramentas do servidor MCP requerem aprovação.	Não
rótulo de servidor	cadeia (de caracteres)	Um rótulo para este servidor MCP, usado para identificá-lo em chamadas de ferramentas.	Yes
URL do servidor	cadeia (de caracteres)	A URL do servidor MCP.	Yes
tipo	enumeração	O tipo da ferramenta MCP. Sempre `mcp`. Valores possíveis: `mcp`	Yes

OpenAI.Metadata

As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.

Tipo: objeto

OpenAI.Prompt

Referência a um modelo de prompt e as suas variáveis. Mais informações.

Nome	Tipo	Description	Obrigatório
id	cadeia (de caracteres)	O identificador exclusivo do modelo de prompt a ser usado.	Yes
variáveis	objecto	Mapa opcional de valores para substituir variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros. Tipos de entrada de resposta, como imagens ou arquivos.	Não
versão	cadeia (de caracteres)	Versão opcional do modelo de prompt.	Não

Opções de Classificação da OpenAI

Nome	Tipo	Description	Obrigatório	Predefinido
classificador	enumeração	O classificador a ser usado para a pesquisa de arquivos. Valores possíveis: `auto`, `default-2024-11-15`	Não
limiar_de_pontuação	número	O limite de pontuação para a pesquisa de ficheiros, 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.	Não

OpenAI.Reasoning

Apenas modelos da série O

Opções de configuração para modelos de raciocínio.

Nome	Tipo	Description	Obrigatório
effort	objecto	Restringe o esforço no raciocínio para modelos de raciocínio. Os valores atualmente suportados são nenhum, mínimo, baixo, médio e alto. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta. O GPT-5.1 por defeito é nenhum, que não executa raciocínio. Os valores de raciocínio suportados para gpt-5.1 são nenhum, baixo, médio e alto. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. Todos os modelos anteriores ao gpt-5.1 usam por defeito o esforço de raciocínio médio e não suportam nenhum. O modelo gpt-5-pro tem por defeito (e só suporta) um esforço de raciocínio elevado.	Não
generate_summary	enumeração	Preterido: use `summary` em vez disso. Um resumo do raciocínio realizado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo. Um de `auto`, `concise`ou `detailed`. Valores possíveis: `auto`, `concise`, `detailed`	Não
resumo	enumeração	Um resumo do raciocínio realizado pelo modelo. Isto pode ser útil para depurar e compreender o processo de raciocínio do modelo. Um de `auto`, `concise`ou `detailed`. Valores possíveis: `auto`, `concise`, `detailed`	Não

OpenAI.EsforçoDeRaciocínio

Restringe o esforço no raciocínio para modelos de raciocínio.

Os valores atualmente suportados são nenhum, mínimo, baixo, médio e alto.

Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta.

O GPT-5.1 por defeito é nenhum, que não executa raciocínio. Os valores de raciocínio suportados para gpt-5.1 são nenhum, baixo, médio e alto. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1.

Todos os modelos anteriores ao gpt-5.1 usam por defeito o esforço de raciocínio médio e não suportam nenhum.

O modelo gpt-5-pro tem por defeito (e só suporta) um esforço de raciocínio elevado.

Propriedade	valor
Descrição	Restringe o esforço no raciocínio para modelos de raciocínio. Os valores atualmente suportados são nenhum, mínimo, baixo, médio e alto. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta. O GPT-5.1 por defeito é nenhum, que não executa raciocínio. Os valores de raciocínio suportados para gpt-5.1 são nenhum, baixo, médio e alto. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. Todos os modelos anteriores ao gpt-5.1 usam por defeito o esforço de raciocínio médio e não suportam nenhum. O modelo gpt-5-pro tem por defeito (e só suporta) um esforço de raciocínio elevado.
Type	cadeia (de caracteres)
Valores	`none` `minimal` `low` `medium` `high`

OpenAI.ReasoningItemParam

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 turnos subsequentes de uma conversa se você estiver gerenciando manualmente o estado da conversa.

Nome	Tipo	Description	Obrigatório
encrypted_content	cadeia (de caracteres)	O conteúdo encriptado do item de raciocínio - preenchido quando uma resposta é fornecida gerado com `reasoning.encrypted_content` no parâmetro `include`.	Não
resumo	matriz	Fundamentação do conteúdo do texto.	Yes
tipo	enumeração	Valores possíveis: `reasoning`	Yes

OpenAI.ReasoningItemResource

Nome	Tipo	Description	Obrigatório
encrypted_content	cadeia (de caracteres)	O conteúdo encriptado do item de raciocínio - preenchido quando uma resposta é fornecida gerado com `reasoning.encrypted_content` no parâmetro `include`.	Não
resumo	matriz	Fundamentação do conteúdo do texto.	Yes
tipo	enumeração	Valores possíveis: `reasoning`	Yes

OpenAI.ReasoningItemSummaryPart

Discriminador para a Parte de Resumo de Item de Raciocínio da OpenAI

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

Valor do tipo	Schema
`summary_text`	OpenAI.ReasoningItemSummaryTextPart

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	OpenAI.ReasoningItemSummaryPartType		Yes

OpenAI.ReasoningItemSummaryPartType

Propriedade	valor
Type	cadeia (de caracteres)
Valores	`summary_text`

OpenAI.ReasoningItemSummaryTextPart

Nome	Tipo	Description	Obrigatório	Predefinido
enviar SMS	cadeia (de caracteres)		Yes
tipo	enumeração	Valores possíveis: `summary_text`	Yes

OpenAI.Response

Nome	Tipo	Description	Obrigatório	Predefinido
agente	objecto		Não
└─ nome	cadeia (de caracteres)	O nome do agente.	Não
└─ tipo	enumeração	Valores possíveis: `agent_id`	Não
└─ versão	cadeia (de caracteres)	O identificador de versão do agente.	Não
em segundo plano	Booleano	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas de fundo.	Não	Falso
conversa	objecto		Yes
└─ ID	cadeia (de caracteres)		Não
criado_em	número inteiro	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Yes
erro	objecto	Um objeto de erro retornado quando o modelo não consegue gerar uma resposta.	Yes
└─ código	OpenAI.ResponseErrorCode	O código de erro para a resposta.	Não
└─ mensagem	cadeia (de caracteres)	Uma descrição do erro legível por humanos.	Não
id	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Yes
incomplete_details	objecto	Detalhes sobre o motivo pelo qual a resposta está incompleta.	Yes
└─ Justificação	enumeração	A razão pela qual a resposta está incompleta. Valores possíveis: `max_output_tokens`, `content_filter`	Não
instructions	cadeia de caracteres ou matriz		Yes
max_output_tokens	número inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
max_tool_calls	número inteiro	O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
modelo	cadeia (de caracteres)	O desdobramento do modelo a ser usado para a criação desta resposta.	Não
objecto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Yes
output	matriz	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Yes
output_text	cadeia (de caracteres)	Propriedade de conveniência exclusiva para SDK que contém a saída agregada de texto de todos os `output_text` itens na `output` matriz, se algum estiver presente. Suportado nos SDKs Python e JavaScript.	Não
chamadas_de_ferramentas_em_paralelo	Booleano	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Yes	Verdade
previous_response_id	cadeia (de caracteres)	O ID único da resposta anterior dada ao modelo. Utilize esta opção para Crie conversas em vários turnos. Saiba mais sobre Gerir o estado de conversa.	Não
avisar	objecto	Referência a um modelo de prompt e as suas variáveis. Mais informações.	Não
└─ ID	cadeia (de caracteres)	O identificador exclusivo do modelo de prompt a ser usado.	Não
└─ variáveis	OpenAI.ResponsePromptVariables	Mapa opcional de valores para substituir variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros. Tipos de entrada de resposta, como imagens ou arquivos.	Não
└─ versão	cadeia (de caracteres)	Versão opcional do modelo de prompt.	Não
reasoning	objecto	Apenas modelos da série O Opções de configuração para modelos de raciocínio.	Não
└─ esforço	OpenAI.ReasoningEffort	Restringe o esforço no raciocínio para modelos de raciocínio. Os valores atualmente suportados são nenhum, mínimo, baixo, médio e alto. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta. O GPT-5.1 por defeito é nenhum, que não executa raciocínio. Os valores de raciocínio suportados para gpt-5.1 são nenhum, baixo, médio e alto. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. Todos os modelos anteriores ao gpt-5.1 usam por defeito o esforço de raciocínio médio e não suportam nenhum. O modelo gpt-5-pro tem por defeito (e só suporta) um esforço de raciocínio elevado.	Não
└─ gerar_resumo	enumeração	Preterido: use `summary` em vez disso. Um resumo do raciocínio realizado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo. Um de `auto`, `concise`ou `detailed`. Valores possíveis: `auto`, `concise`, `detailed`	Não
└─ Resumo	enumeração	Um resumo do raciocínio realizado pelo modelo. Isto pode ser útil para depurar e compreender o processo de raciocínio do modelo. Um de `auto`, `concise`ou `detailed`. Valores possíveis: `auto`, `concise`, `detailed`	Não
nível_de_serviço	objecto	Especifica o tipo de processamento usado para atender à solicitação. * Se definido como 'auto', então o pedido será processado no nível de serviço configurado nas definições do Projeto. A menos que configurado de outra forma, o projeto usará 'default'. * Se definido como 'default', o pedido será processado com o standard preços e desempenho para o modelo selecionado. * Se definido para 'flex' ou 'prioridade', então o pedido será processado com o serviço correspondente de nível. Entre em contato com o departamento de vendas para saber mais sobre o processamento prioritário. * Quando não está definido, o comportamento padrão é 'auto'. Quando o `service_tier` parâmetro é definido, o corpo de resposta incluirá o `service_tier` valor baseado no modo de processamento efetivamente utilizado para servir o pedido. Este valor de resposta pode ser diferente do valor definido no parâmetro.	Não
estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	Não
structured_inputs	objecto	As entradas estruturadas para a resposta que podem participar na substituição de modelos de prompt ou em ligações de argumentos de ferramenta.	Não
temperatura	número	Qual a temperatura de amostragem a utilizar, entre 0 e 2. Valores mais altos como 0,8 tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente, recomendamos alterar isto ou `top_p`, mas não ambos.	Yes
enviar SMS	objecto	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Ver Entradas e saídas de texto e Saídas Estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
tool_choice	objecto	Controla qual (se houver) ferramenta é 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 fazer uma chamada. mais ferramentas. `required` significa que o modelo deve chamar uma ou mais ferramentas.	Não
└─ tipo	OpenAI.ToolChoiceObjectType	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas integradas.	Não
Ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. As duas categorias de ferramentas que você pode fornecer ao modelo são: * Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. * Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame seu próprio código. Saiba mais sobre função a chamar.	Não
top_logprobs	número inteiro	Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis de serem retornados em cada posição de token, cada um com uma probabilidade em log associada.	Não
top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com probabilidade top_p massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade são considerados. Geralmente, recomendamos alterar isto ou `temperature`, mas não ambos.	Yes
truncation	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: Se o contexto desta resposta e das anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará o resposta para se ajustar à janela de contexto, descartando itens de entrada. no meio da conversa. - `disabled` (padrão): se uma resposta do modelo exceder a janela de contexto tamanho para um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
utilizador	cadeia (de caracteres)	Saiba mais sobre as melhores práticas de segurança.	Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Emitido quando um trecho de código parcial é transmitido pelo interpretador de código.

Nome	Tipo	Description	Obrigatório
delta	cadeia (de caracteres)	O trecho de código parcial a ser transmitido pelo interpretador de código.	Yes
item_id	cadeia (de caracteres)	O identificador exclusivo do item de chamada da ferramenta de interpretação de código.	Yes
output_index	número inteiro	O índice do item de saída na resposta para a qual o código está sendo transmitido.	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 trecho de código é finalizado pelo interpretador de código.

Nome	Tipo	Description	Obrigatório
código	cadeia (de caracteres)	A saída final do trecho de código pelo interpretador de código.	Yes
item_id	cadeia (de caracteres)	O identificador exclusivo do item de chamada da ferramenta de interpretação de código.	Yes
output_index	número inteiro	O índice do item de saída na resposta para a qual o código é finalizado.	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 (de caracteres)	O identificador exclusivo do item de chamada da ferramenta de interpretação de código.	Yes
output_index	número inteiro	O índice do item de saída na resposta para a qual a chamada do interpretador de código é concluída.	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 (de caracteres)	O identificador exclusivo do item de chamada da ferramenta de interpretação de código.	Yes
output_index	número inteiro	O índice do item de saída na resposta para a qual a chamada do interpretador de código está em andamento.	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 trecho de código.

Nome	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O identificador exclusivo do item de chamada da ferramenta de interpretação de código.	Yes
output_index	número inteiro	O índice do item de saída na resposta para a qual o interpretador de código está interpretando código.	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 está completa.

Nome	Tipo	Description	Obrigatório	Predefinido
response	objecto		Yes
└─ agente	ID do agente	O agente usado para esta resposta	Não
└─ Antecedentes	Booleano	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas de fundo.	Não	Falso
└─ Conversa	objecto		Não
└─ ID	cadeia (de caracteres)		Não
└─ created_at	número inteiro	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo não consegue gerar uma resposta.	Não
└─ ID	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Não
└─ detalhes_incompletos	objecto	Detalhes sobre o motivo pelo qual a resposta está incompleta.	Não
└─ Justificação	enumeração	A razão pela qual a resposta está incompleta. Valores possíveis: `max_output_tokens`, `content_filter`	Não
└─ instruções	cadeia de caracteres ou matriz	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao utilizar juntamente com `previous_response_id`, as instruções de uma etapa anterior a resposta não será transferida para a resposta seguinte. Isso simplifica para substituir mensagens do sistema (ou mensagens de desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (limite máximo de tokens de saída)	número inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
└─ número_máximo_de_chamadas_da_ferramenta	número inteiro	O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ modelo	cadeia (de caracteres)	O desdobramento do modelo a ser usado para a criação desta resposta.	Não
└─ objeto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Não
└─ saída	matriz	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Não
└─ texto_de_saida	cadeia (de caracteres)	Propriedade de conveniência exclusiva para SDK que contém a saída agregada de texto de todos os `output_text` itens na `output` matriz, se algum estiver presente. Suportado nos SDKs Python e JavaScript.	Não
└─ chamadas_de_ferramentas_em_paralelo	Booleano	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia (de caracteres)	O ID único da resposta anterior dada ao modelo. Utilize esta opção para Crie conversas em vários turnos. Saiba mais sobre Gerir o estado de conversa.	Não
└─ Prompt	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis. Mais informações.	Não
└─ raciocínio	OpenAI.Reasoning	Apenas modelos da série O Opções de configuração para modelos de raciocínio.	Não
└─ service_tier	OpenAI.ServiceTier	Nota: service_tier não se aplica ao Azure OpenAI.	Não
└─ estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	Não
└─ structured_inputs	objecto	As entradas estruturadas para a resposta que podem participar na substituição de modelos de prompt ou em ligações de argumentos de ferramenta.	Não
└─ temperatura	número	Qual a temperatura de amostragem a utilizar, entre 0 e 2. Valores mais altos como 0,8 tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente, recomendamos alterar isto ou `top_p`, mas não ambos.	Não
└─ texto	objecto	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Ver Entradas e saídas de texto e Saídas Estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject	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.	Não
└─ Ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. As duas categorias de ferramentas que você pode fornecer ao modelo são: * Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. * Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame seu próprio código. Saiba mais sobre função a chamar.	Não
└─ top_logprobs	número inteiro	Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis de serem retornados em cada posição de token, cada um com uma probabilidade em log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com probabilidade top_p massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade são considerados. Geralmente, recomendamos alterar isto ou `temperature`, mas não ambos.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: Se o contexto desta resposta e das anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará o resposta para se ajustar à janela de contexto, descartando itens de entrada. no meio da conversa. - `disabled` (padrão): se uma resposta do modelo exceder a janela de contexto tamanho para um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
└─ utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ utilizador	cadeia (de caracteres)	Saiba mais sobre as melhores práticas de segurança.	Não
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	número inteiro	O índice da parte de conteúdo que foi adicionada.	Yes
item_id	cadeia (de caracteres)	A ID do item de saída ao qual a parte de conteúdo foi adicionada.	Yes
output_index	número inteiro	O índice do item de saída ao qual a parte de conteúdo foi adicionada.	Yes
part	objecto		Yes
└─ tipo	OpenAI.ItemContentType	Conteúdos multimodais de entrada e saída.	Não
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	número inteiro	O índice do conteúdo da parte que está concluída.	Yes
item_id	cadeia (de caracteres)	A ID do item de saída ao qual a parte de conteúdo foi adicionada.	Yes
output_index	número inteiro	O índice do item de saída ao qual a parte de conteúdo foi adicionada.	Yes
part	objecto		Yes
└─ tipo	OpenAI.ItemContentType	Conteúdos multimodais de entrada e saída.	Não
tipo	enumeração	O tipo de evento. Sempre `response.content_part.done`. Valores possíveis: `response.content_part.done`	Yes

OpenAI.ResponseCreatedEvent

Um evento que é emitido quando uma resposta é criada.

Nome	Tipo	Description	Obrigatório	Predefinido
response	objecto		Yes
└─ agente	ID do agente	O agente usado para esta resposta	Não
└─ Antecedentes	Booleano	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas de fundo.	Não	Falso
└─ Conversa	objecto		Não
└─ ID	cadeia (de caracteres)		Não
└─ created_at	número inteiro	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo não consegue gerar uma resposta.	Não
└─ ID	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Não
└─ detalhes_incompletos	objecto	Detalhes sobre o motivo pelo qual a resposta está incompleta.	Não
└─ Justificação	enumeração	A razão pela qual a resposta está incompleta. Valores possíveis: `max_output_tokens`, `content_filter`	Não
└─ instruções	cadeia de caracteres ou matriz	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao utilizar juntamente com `previous_response_id`, as instruções de uma etapa anterior a resposta não será transferida para a resposta seguinte. Isso simplifica para substituir mensagens do sistema (ou mensagens de desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (limite máximo de tokens de saída)	número inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
└─ número_máximo_de_chamadas_da_ferramenta	número inteiro	O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ modelo	cadeia (de caracteres)	O desdobramento do modelo a ser usado para a criação desta resposta.	Não
└─ objeto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Não
└─ saída	matriz	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Não
└─ texto_de_saida	cadeia (de caracteres)	Propriedade de conveniência exclusiva para SDK que contém a saída agregada de texto de todos os `output_text` itens na `output` matriz, se algum estiver presente. Suportado nos SDKs Python e JavaScript.	Não
└─ chamadas_de_ferramentas_em_paralelo	Booleano	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia (de caracteres)	O ID único da resposta anterior dada ao modelo. Utilize esta opção para Crie conversas em vários turnos. Saiba mais sobre Gerir o estado de conversa.	Não
└─ Prompt	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis. Mais informações.	Não
└─ raciocínio	OpenAI.Reasoning	Apenas modelos da série O Opções de configuração para modelos de raciocínio.	Não
└─ service_tier	OpenAI.ServiceTier	Nota: service_tier não se aplica ao Azure OpenAI.	Não
└─ estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	Não
└─ structured_inputs	objecto	As entradas estruturadas para a resposta que podem participar na substituição de modelos de prompt ou em ligações de argumentos de ferramenta.	Não
└─ temperatura	número	Qual a temperatura de amostragem a utilizar, entre 0 e 2. Valores mais altos como 0,8 tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente, recomendamos alterar isto ou `top_p`, mas não ambos.	Não
└─ texto	objecto	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Ver Entradas e saídas de texto e Saídas Estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject	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.	Não
└─ Ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. As duas categorias de ferramentas que você pode fornecer ao modelo são: * Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. * Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame seu próprio código. Saiba mais sobre função a chamar.	Não
└─ top_logprobs	número inteiro	Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis de serem retornados em cada posição de token, cada um com uma probabilidade em log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com probabilidade top_p massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade são considerados. Geralmente, recomendamos alterar isto ou `temperature`, mas não ambos.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: Se o contexto desta resposta e das anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará o resposta para se ajustar à janela de contexto, descartando itens de entrada. no meio da conversa. - `disabled` (padrão): se uma resposta do modelo exceder a janela de contexto tamanho para um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
└─ utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ utilizador	cadeia (de caracteres)	Saiba mais sobre as melhores práticas de segurança.	Não
tipo	enumeração	O tipo de evento. Sempre `response.created`. Valores possíveis: `response.created`	Yes

OpenAI.ResponseError

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

Nome	Tipo	Description	Obrigatório	Predefinido
código	OpenAI.ResponseErrorCode	O código de erro para a resposta.	Yes
mensagem	cadeia (de caracteres)	Uma descrição do erro legível por humanos.	Yes

OpenAI.ResponseErrorCode

O código de erro para a resposta.

Propriedade	valor
Descrição	O código de erro para a resposta.
Type	cadeia (de caracteres)
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
código	cadeia (de caracteres)	O código de erro.	Yes
mensagem	cadeia (de caracteres)	A mensagem de erro.	Yes
param	cadeia (de caracteres)	O parâmetro de erro.	Yes
tipo	enumeração	O tipo de evento. Sempre `error`. Valores possíveis: `error`	Yes

OpenAI.ResponseFailedEvent

Um evento que é emitido quando uma resposta falha.

Nome	Tipo	Description	Obrigatório	Predefinido
response	objecto		Yes
└─ agente	ID do agente	O agente usado para esta resposta	Não
└─ Antecedentes	Booleano	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas de fundo.	Não	Falso
└─ Conversa	objecto		Não
└─ ID	cadeia (de caracteres)		Não
└─ created_at	número inteiro	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo não consegue gerar uma resposta.	Não
└─ ID	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Não
└─ detalhes_incompletos	objecto	Detalhes sobre o motivo pelo qual a resposta está incompleta.	Não
└─ Justificação	enumeração	A razão pela qual a resposta está incompleta. Valores possíveis: `max_output_tokens`, `content_filter`	Não
└─ instruções	cadeia de caracteres ou matriz	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao utilizar juntamente com `previous_response_id`, as instruções de uma etapa anterior a resposta não será transferida para a resposta seguinte. Isso simplifica para substituir mensagens do sistema (ou mensagens de desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (limite máximo de tokens de saída)	número inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
└─ número_máximo_de_chamadas_da_ferramenta	número inteiro	O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ modelo	cadeia (de caracteres)	O desdobramento do modelo a ser usado para a criação desta resposta.	Não
└─ objeto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Não
└─ saída	matriz	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Não
└─ texto_de_saida	cadeia (de caracteres)	Propriedade de conveniência exclusiva para SDK que contém a saída agregada de texto de todos os `output_text` itens na `output` matriz, se algum estiver presente. Suportado nos SDKs Python e JavaScript.	Não
└─ chamadas_de_ferramentas_em_paralelo	Booleano	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia (de caracteres)	O ID único da resposta anterior dada ao modelo. Utilize esta opção para Crie conversas em vários turnos. Saiba mais sobre Gerir o estado de conversa.	Não
└─ Prompt	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis. Mais informações.	Não
└─ raciocínio	OpenAI.Reasoning	Apenas modelos da série O Opções de configuração para modelos de raciocínio.	Não
└─ service_tier	OpenAI.ServiceTier	Nota: service_tier não se aplica ao Azure OpenAI.	Não
└─ estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	Não
└─ structured_inputs	objecto	As entradas estruturadas para a resposta que podem participar na substituição de modelos de prompt ou em ligações de argumentos de ferramenta.	Não
└─ temperatura	número	Qual a temperatura de amostragem a utilizar, entre 0 e 2. Valores mais altos como 0,8 tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente, recomendamos alterar isto ou `top_p`, mas não ambos.	Não
└─ texto	objecto	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Ver Entradas e saídas de texto e Saídas Estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject	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.	Não
└─ Ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. As duas categorias de ferramentas que você pode fornecer ao modelo são: * Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. * Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame seu próprio código. Saiba mais sobre função a chamar.	Não
└─ top_logprobs	número inteiro	Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis de serem retornados em cada posição de token, cada um com uma probabilidade em log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com probabilidade top_p massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade são considerados. Geralmente, recomendamos alterar isto ou `temperature`, mas não ambos.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: Se o contexto desta resposta e das anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará o resposta para se ajustar à janela de contexto, descartando itens de entrada. no meio da conversa. - `disabled` (padrão): se uma resposta do modelo exceder a janela de contexto tamanho para um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
└─ utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ utilizador	cadeia (de caracteres)	Saiba mais sobre as melhores práticas de segurança.	Não
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 (de caracteres)	O ID do item de saída para o qual a chamada de pesquisa de arquivo é iniciada.	Yes
output_index	número inteiro	O índice do item de saída em que é iniciada a chamada de pesquisa no arquivo.	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 (de caracteres)	O ID do item de saída para o qual a chamada de pesquisa de arquivo é iniciada.	Yes
output_index	número inteiro	O índice do item de saída em que é iniciada a chamada de pesquisa no arquivo.	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á sendo pesquisada no momento.

Nome	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O ID do item de saída para o qual a chamada de pesquisa de arquivo é iniciada.	Yes
output_index	número inteiro	O índice do item de saída que a chamada de pesquisa de arquivo está pesquisando.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.file_search_call.searching`. Valores possíveis: `response.file_search_call.searching`	Yes

OpenAI.ResponseFormat

Discriminador para OpenAI.ResponseFormat

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

Valor do tipo	Schema
`json_object`	OpenAI.ResponseFormatJsonObject
`json_schema`	OpenAI.ResponseFormatJsonSchema

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	Valores possíveis: `text`, `json_object`, `json_schema`	Yes

OpenAI.ResponseFormatJsonObject

Formato de resposta de objeto JSON. Um método mais antigo de gerar respostas JSON. O uso json_schema é recomendado para modelos que o suportam. Observe que o modelo não gerará JSON sem uma mensagem do sistema ou do usuário instruindo-o a fazê-lo.

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

OpenAI.ResponseFormatJsonSchema

O esquema para o formato de resposta, descrito como um objeto de esquema JSON. Aprenda aqui a construir esquemas JSON. Formato de resposta do esquema JSON. Usado para gerar respostas JSON estruturadas. Saiba mais sobre Saídas Estruturadas.

Nome	Tipo	Description	Obrigatório	Predefinido
esquema_json	objecto	Opções de configuração de Saídas Estruturadas, incluindo um Esquema JSON.	Yes
└─ Descrição	cadeia (de caracteres)	Uma descrição da finalidade do formato de resposta utilizada pelo modelo para Determine como responder no formato.	Não
└─ nome	cadeia (de caracteres)	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.	Não
└─ esquema	objecto		Não
└─ rigoroso	Booleano	Se a adesão estrita ao esquema deve ser habilitada ao gerar a saída. Se definido como true, o modelo sempre seguirá o esquema exato definido no campo `schema`. Somente um subconjunto do esquema JSON é suportado quando `strict` é `true`. Para saber mais, leia os Outputs estruturados guia.	Não	Falso
tipo	enumeração	O tipo de formato de resposta que está sendo definido. Sempre `json_schema`. Valores possíveis: `json_schema`	Yes

OpenAI.ResponseFormatText

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

Nome	Tipo	Description	Obrigatório	Predefinido
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 parcial de argumentos de chamada de função.

Nome	Tipo	Description	Obrigatório
delta	cadeia (de caracteres)	Os argumentos delta de chamada de função que são adicionados.	Yes
item_id	cadeia (de caracteres)	A ID do item de saída ao qual o delta de argumentos de chamada de função é adicionado.	Yes
output_index	número inteiro	O índice do item de saída ao qual é somado o delta dos argumentos de chamada de função.	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 (de caracteres)	Os argumentos de chamada de função.	Yes
item_id	cadeia (de caracteres)	O identificador do item.	Yes
output_index	número inteiro	O índice do item de saída.	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 (de caracteres)	O identificador exclusivo do item de geração de imagem que está sendo processado.	Yes
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	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 (de caracteres)	O identificador exclusivo do item de geração de imagem que está sendo processado.	Yes
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
tipo	enumeração	O tipo de evento. Sempre 'response.image_generation_call.gerando'. 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 (de caracteres)	O identificador exclusivo do item de geração de imagem que está sendo processado.	Yes
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
tipo	enumeração	O tipo de evento. Sempre 'response.image_generation_call.in_progress'. 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 (de caracteres)	O identificador exclusivo do item de geração de imagem que está sendo processado.	Yes
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
partial_image_b64	cadeia (de caracteres)	Dados de imagem parciais codificados em Base64, adequados para renderização como uma imagem.	Yes
partial_image_index	número inteiro	índice baseado em 0 para a imagem parcial (backend é baseado em 1, mas este é baseado em 0 para o utilizador).	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	Predefinido
response	objecto		Yes
└─ agente	ID do agente	O agente usado para esta resposta	Não
└─ Antecedentes	Booleano	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas de fundo.	Não	Falso
└─ Conversa	objecto		Não
└─ ID	cadeia (de caracteres)		Não
└─ created_at	número inteiro	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo não consegue gerar uma resposta.	Não
└─ ID	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Não
└─ detalhes_incompletos	objecto	Detalhes sobre o motivo pelo qual a resposta está incompleta.	Não
└─ Justificação	enumeração	A razão pela qual a resposta está incompleta. Valores possíveis: `max_output_tokens`, `content_filter`	Não
└─ instruções	cadeia de caracteres ou matriz	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao utilizar juntamente com `previous_response_id`, as instruções de uma etapa anterior a resposta não será transferida para a resposta seguinte. Isso simplifica para substituir mensagens do sistema (ou mensagens de desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (limite máximo de tokens de saída)	número inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
└─ número_máximo_de_chamadas_da_ferramenta	número inteiro	O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ modelo	cadeia (de caracteres)	O desdobramento do modelo a ser usado para a criação desta resposta.	Não
└─ objeto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Não
└─ saída	matriz	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Não
└─ texto_de_saida	cadeia (de caracteres)	Propriedade de conveniência exclusiva para SDK que contém a saída agregada de texto de todos os `output_text` itens na `output` matriz, se algum estiver presente. Suportado nos SDKs Python e JavaScript.	Não
└─ chamadas_de_ferramentas_em_paralelo	Booleano	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia (de caracteres)	O ID único da resposta anterior dada ao modelo. Utilize esta opção para Crie conversas em vários turnos. Saiba mais sobre Gerir o estado de conversa.	Não
└─ Prompt	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis. Mais informações.	Não
└─ raciocínio	OpenAI.Reasoning	Apenas modelos da série O Opções de configuração para modelos de raciocínio.	Não
└─ service_tier	OpenAI.ServiceTier	Nota: service_tier não se aplica ao Azure OpenAI.	Não
└─ estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	Não
└─ structured_inputs	objecto	As entradas estruturadas para a resposta que podem participar na substituição de modelos de prompt ou em ligações de argumentos de ferramenta.	Não
└─ temperatura	número	Qual a temperatura de amostragem a utilizar, entre 0 e 2. Valores mais altos como 0,8 tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente, recomendamos alterar isto ou `top_p`, mas não ambos.	Não
└─ texto	objecto	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Ver Entradas e saídas de texto e Saídas Estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject	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.	Não
└─ Ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. As duas categorias de ferramentas que você pode fornecer ao modelo são: * Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. * Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame seu próprio código. Saiba mais sobre função a chamar.	Não
└─ top_logprobs	número inteiro	Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis de serem retornados em cada posição de token, cada um com uma probabilidade em log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com probabilidade top_p massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade são considerados. Geralmente, recomendamos alterar isto ou `temperature`, mas não ambos.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: Se o contexto desta resposta e das anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará o resposta para se ajustar à janela de contexto, descartando itens de entrada. no meio da conversa. - `disabled` (padrão): se uma resposta do modelo exceder a janela de contexto tamanho para um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
└─ utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ utilizador	cadeia (de caracteres)	Saiba mais sobre as melhores práticas de segurança.	Não
tipo	enumeração	O tipo de evento. Sempre `response.in_progress`. Valores possíveis: `response.in_progress`	Yes

OpenAI.ResponseIncompleteEvent

Um evento que é emitido quando uma resposta termina como incompleta.

Nome	Tipo	Description	Obrigatório	Predefinido
response	objecto		Yes
└─ agente	ID do agente	O agente usado para esta resposta	Não
└─ Antecedentes	Booleano	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas de fundo.	Não	Falso
└─ Conversa	objecto		Não
└─ ID	cadeia (de caracteres)		Não
└─ created_at	número inteiro	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo não consegue gerar uma resposta.	Não
└─ ID	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Não
└─ detalhes_incompletos	objecto	Detalhes sobre o motivo pelo qual a resposta está incompleta.	Não
└─ Justificação	enumeração	A razão pela qual a resposta está incompleta. Valores possíveis: `max_output_tokens`, `content_filter`	Não
└─ instruções	cadeia de caracteres ou matriz	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao utilizar juntamente com `previous_response_id`, as instruções de uma etapa anterior a resposta não será transferida para a resposta seguinte. Isso simplifica para substituir mensagens do sistema (ou mensagens de desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (limite máximo de tokens de saída)	número inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
└─ número_máximo_de_chamadas_da_ferramenta	número inteiro	O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ modelo	cadeia (de caracteres)	O desdobramento do modelo a ser usado para a criação desta resposta.	Não
└─ objeto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Não
└─ saída	matriz	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Não
└─ texto_de_saida	cadeia (de caracteres)	Propriedade de conveniência exclusiva para SDK que contém a saída agregada de texto de todos os `output_text` itens na `output` matriz, se algum estiver presente. Suportado nos SDKs Python e JavaScript.	Não
└─ chamadas_de_ferramentas_em_paralelo	Booleano	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia (de caracteres)	O ID único da resposta anterior dada ao modelo. Utilize esta opção para Crie conversas em vários turnos. Saiba mais sobre Gerir o estado de conversa.	Não
└─ Prompt	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis. Mais informações.	Não
└─ raciocínio	OpenAI.Reasoning	Apenas modelos da série O Opções de configuração para modelos de raciocínio.	Não
└─ service_tier	OpenAI.ServiceTier	Nota: service_tier não se aplica ao Azure OpenAI.	Não
└─ estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	Não
└─ structured_inputs	objecto	As entradas estruturadas para a resposta que podem participar na substituição de modelos de prompt ou em ligações de argumentos de ferramenta.	Não
└─ temperatura	número	Qual a temperatura de amostragem a utilizar, entre 0 e 2. Valores mais altos como 0,8 tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente, recomendamos alterar isto ou `top_p`, mas não ambos.	Não
└─ texto	objecto	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Ver Entradas e saídas de texto e Saídas Estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject	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.	Não
└─ Ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. As duas categorias de ferramentas que você pode fornecer ao modelo são: * Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. * Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame seu próprio código. Saiba mais sobre função a chamar.	Não
└─ top_logprobs	número inteiro	Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis de serem retornados em cada posição de token, cada um com uma probabilidade em log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com probabilidade top_p massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade são considerados. Geralmente, recomendamos alterar isto ou `temperature`, mas não ambos.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: Se o contexto desta resposta e das anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará o resposta para se ajustar à janela de contexto, descartando itens de entrada. no meio da conversa. - `disabled` (padrão): se uma resposta do modelo exceder a janela de contexto tamanho para um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
└─ utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ utilizador	cadeia (de caracteres)	Saiba mais sobre as melhores práticas de segurança.	Não
tipo	enumeração	O tipo de evento. Sempre `response.incomplete`. Valores possíveis: `response.incomplete`	Yes

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		A atualização parcial dos argumentos para a chamada da ferramenta MCP.	Yes
item_id	cadeia (de caracteres)	O identificador exclusivo do item de chamada da ferramenta MCP que está a ser processado.	Yes
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	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 para uma chamada de ferramenta MCP são finalizados.

Nome	Tipo	Description	Obrigatório
arguments		Os argumentos finais para a invocação da ferramenta MCP.	Yes
item_id	cadeia (de caracteres)	O identificador exclusivo do item de chamada da ferramenta MCP que está a ser processado.	Yes
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call.arguments_done'. Valores possíveis: `response.mcp_call.arguments_done`	Yes

OpenAI.ResponseMCPCallCompletedEvent

Emitido quando uma chamada de ferramenta MCP foi concluída com êxito.

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call.completed'. Valores possíveis: `response.mcp_call.completed`	Yes

OpenAI.ResponseMCPCallFailedEvent

Emitido quando uma chamada de ferramenta MCP falhou.

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call.failed'. 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 (de caracteres)	O identificador exclusivo do item de chamada da ferramenta MCP que está a ser processado.	Yes
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
tipo	enumeração	O tipo de evento. 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	Predefinido
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	Predefinido
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_list_tools.failed'. 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	Predefinido
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	objecto	Item de conteúdo usado para gerar uma resposta.	Yes
└─ created_by	Criadopor	A informação sobre o criador do artigo	Não
└─ ID	cadeia (de caracteres)		Não
└─ tipo	OpenAI.ItemType		Não
output_index	número inteiro	O índice do item de saída que foi adicionado.	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	objecto	Item de conteúdo usado para gerar uma resposta.	Yes
└─ created_by	Criadopor	A informação sobre o criador do artigo	Não
└─ ID	cadeia (de caracteres)		Não
└─ tipo	OpenAI.ItemType		Não
output_index	número inteiro	O índice do item de saída que foi marcado como concluído.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.output_item.done`. Valores possíveis: `response.output_item.done`	Yes

OpenAI.ResponsePromptVariables

Mapa opcional de valores para substituir variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros tipos de entrada de resposta, como imagens ou arquivos.

Tipo: objeto

OpenAI.ResponseQueuedEvent

Emitido quando uma resposta está na fila e aguardando para ser processada.

Nome	Tipo	Description	Obrigatório	Predefinido
response	objecto		Yes
└─ agente	ID do agente	O agente usado para esta resposta	Não
└─ Antecedentes	Booleano	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas de fundo.	Não	Falso
└─ Conversa	objecto		Não
└─ ID	cadeia (de caracteres)		Não
└─ created_at	número inteiro	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo não consegue gerar uma resposta.	Não
└─ ID	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Não
└─ detalhes_incompletos	objecto	Detalhes sobre o motivo pelo qual a resposta está incompleta.	Não
└─ Justificação	enumeração	A razão pela qual a resposta está incompleta. Valores possíveis: `max_output_tokens`, `content_filter`	Não
└─ instruções	cadeia de caracteres ou matriz	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao utilizar juntamente com `previous_response_id`, as instruções de uma etapa anterior a resposta não será transferida para a resposta seguinte. Isso simplifica para substituir mensagens do sistema (ou mensagens de desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (limite máximo de tokens de saída)	número inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
└─ número_máximo_de_chamadas_da_ferramenta	número inteiro	O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ modelo	cadeia (de caracteres)	O desdobramento do modelo a ser usado para a criação desta resposta.	Não
└─ objeto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Não
└─ saída	matriz	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Não
└─ texto_de_saida	cadeia (de caracteres)	Propriedade de conveniência exclusiva para SDK que contém a saída agregada de texto de todos os `output_text` itens na `output` matriz, se algum estiver presente. Suportado nos SDKs Python e JavaScript.	Não
└─ chamadas_de_ferramentas_em_paralelo	Booleano	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia (de caracteres)	O ID único da resposta anterior dada ao modelo. Utilize esta opção para Crie conversas em vários turnos. Saiba mais sobre Gerir o estado de conversa.	Não
└─ Prompt	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis. Mais informações.	Não
└─ raciocínio	OpenAI.Reasoning	Apenas modelos da série O Opções de configuração para modelos de raciocínio.	Não
└─ service_tier	OpenAI.ServiceTier	Nota: service_tier não se aplica ao Azure OpenAI.	Não
└─ estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	Não
└─ structured_inputs	objecto	As entradas estruturadas para a resposta que podem participar na substituição de modelos de prompt ou em ligações de argumentos de ferramenta.	Não
└─ temperatura	número	Qual a temperatura de amostragem a utilizar, entre 0 e 2. Valores mais altos como 0,8 tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente, recomendamos alterar isto ou `top_p`, mas não ambos.	Não
└─ texto	objecto	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Ver Entradas e saídas de texto e Saídas Estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject	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.	Não
└─ Ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. As duas categorias de ferramentas que você pode fornecer ao modelo são: * Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. * Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame seu próprio código. Saiba mais sobre função a chamar.	Não
└─ top_logprobs	número inteiro	Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis de serem retornados em cada posição de token, cada um com uma probabilidade em log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com probabilidade top_p massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade são considerados. Geralmente, recomendamos alterar isto ou `temperature`, mas não ambos.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: Se o contexto desta resposta e das anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará o resposta para se ajustar à janela de contexto, descartando itens de entrada. no meio da conversa. - `disabled` (padrão): se uma resposta do modelo exceder a janela de contexto tamanho para um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
└─ utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ utilizador	cadeia (de caracteres)	Saiba mais sobre as melhores práticas de segurança.	Não
tipo	enumeração	O tipo de evento. Sempre 'response.queued'. Valores possíveis: `response.queued`	Yes

OpenAI.ResponseReasoningDeltaEvent

Emitido quando há um delta (atualização parcial) no conteúdo do raciocínio.

Nome	Tipo	Description	Obrigatório
content_index	número inteiro	O índice da parte de conteúdo de raciocínio dentro do item de saída.	Yes
delta		A atualização parcial do conteúdo do raciocínio.	Yes
item_id	cadeia (de caracteres)	O identificador exclusivo do item para o qual a justificação está a ser atualizada.	Yes
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
tipo	enumeração	O tipo de evento. Sempre 'response.reasoning.delta'. Valores possíveis: `response.reasoning.delta`	Yes

OpenAI.ResponseReasoningDoneEvent

Emitido quando o conteúdo de raciocínio é finalizado para um item.

Nome	Tipo	Description	Obrigatório
content_index	número inteiro	O índice da parte de conteúdo de raciocínio dentro do item de saída.	Yes
item_id	cadeia (de caracteres)	O identificador exclusivo do item para o qual o raciocínio é finalizado.	Yes
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
enviar SMS	cadeia (de caracteres)	O texto de raciocínio finalizado.	Yes
tipo	enumeração	O tipo de evento. Sempre 'response.reasoning.done'. Valores possíveis: `response.reasoning.done`	Yes

OpenAI.ResponseReasoningSummaryDeltaEvent

Emitido quando há um delta (atualização parcial) no conteúdo do resumo de raciocínio.

Nome	Tipo	Description	Obrigatório
delta		A atualização parcial do conteúdo do resumo de fundamentação.	Yes
item_id	cadeia (de caracteres)	O identificador exclusivo do item para o qual o resumo de raciocínio está sendo atualizado.	Yes
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
summary_index	número inteiro	O índice da parte de resumo dentro do item de saída.	Yes
tipo	enumeração	O tipo de evento. Sempre 'response.reasoning_summary.delta'. Valores possíveis: `response.reasoning_summary.delta`	Yes

OpenAI.ResponseReasoningSummaryDoneEvent

Emitido quando o conteúdo do resumo de raciocínio é finalizado para um item.

Nome	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O identificador exclusivo do item para o qual o resumo de raciocínio é finalizado.	Yes
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
summary_index	número inteiro	O índice da parte de resumo dentro do item de saída.	Yes
enviar SMS	cadeia (de caracteres)	O texto resumido do raciocínio finalizado.	Yes
tipo	enumeração	O tipo de evento. Sempre 'response.reasoning_summary.done'. Valores possíveis: `response.reasoning_summary.done`	Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

Emitido quando é adicionada uma nova parte do resumo do raciocínio.

Nome	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	A ID do item ao qual esta parte de resumo está associada.	Yes
output_index	número inteiro	O índice do item de saída ao qual esta parte de resumo está associada.	Yes
part	objecto		Yes
└─ tipo	OpenAI.ReasoningItemSummaryPartType		Não
summary_index	número inteiro	O índice da parte sumária dentro da exposição de motivos.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_part.added`. Valores possíveis: `response.reasoning_summary_part.added`	Yes

OpenAI.ResponseReasoningSummaryPartDoneEvent

Emitido quando uma parte sumária de raciocínio é concluída.

Nome	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	A ID do item ao qual esta parte de resumo está associada.	Yes
output_index	número inteiro	O índice do item de saída ao qual esta parte de resumo está associada.	Yes
part	objecto		Yes
└─ tipo	OpenAI.ReasoningItemSummaryPartType		Não
summary_index	número inteiro	O índice da parte sumária dentro da exposição de motivos.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_part.done`. Valores possíveis: `response.reasoning_summary_part.done`	Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

É emitido quando um delta é adicionado a um texto de resumo de raciocínio.

Nome	Tipo	Description	Obrigatório
delta	cadeia (de caracteres)	O texto delta que foi adicionado ao resumo.	Yes
item_id	cadeia (de caracteres)	A ID do item ao qual este delta de texto de resumo está associado.	Yes
output_index	número inteiro	O índice do item de saída ao qual este delta de texto de resumo está associado.	Yes
summary_index	número inteiro	O índice da parte sumária dentro da exposição de motivos.	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 (de caracteres)	A ID do item ao qual este texto de resumo está associado.	Yes
output_index	número inteiro	O índice do item de saída ao qual este texto de resumo está associado.	Yes
summary_index	número inteiro	O índice da parte sumária dentro da exposição de motivos.	Yes
enviar SMS	cadeia (de caracteres)	Texto integral da exposição de motivos completa.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_text.done`. Valores possíveis: `response.reasoning_summary_text.done`	Yes

OpenAI.ResponseRefusalDeltaEvent

Emitido quando há um texto de recusa parcial.

Nome	Tipo	Description	Obrigatório
content_index	número inteiro	O índice da parte de conteúdo à qual o texto de recusa é adicionado.	Yes
delta	cadeia (de caracteres)	O texto de recusa que é adicionado.	Yes
item_id	cadeia (de caracteres)	A ID do item de saída ao qual o texto de recusa é adicionado.	Yes
output_index	número inteiro	O índice do item de saída ao qual o texto de recusa é adicionado.	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	número inteiro	O índice da parte do conteúdo onde o texto de recusa é finalizado.	Yes
item_id	cadeia (de caracteres)	A ID do item de saída em que o texto de recusa é finalizado.	Yes
output_index	número inteiro	O índice do item de saída em que o texto de recusa é concluído.	Yes
refusal	cadeia (de caracteres)	O texto de recusa finalizado.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.refusal.done`. Valores possíveis: `response.refusal.done`	Yes

OpenAI.ResponseStreamEvent

Discriminador para OpenAI.ResponseStreamEvent

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

Valor do tipo	Schema
`response.completed`	OpenAI.ResponseCompletedEvent
`response.content_part.added`	OpenAI.ResponseContentPartAddedEvent
`response.content_part.done`	OpenAI.ResponseContentPartDoneEvent
`response.created`	OpenAI.ResponseCreatedEvent
`error`	OpenAI.ResponseErrorEvent
`response.file_search_call.completed`	OpenAI.ResponseFileSearchCallCompletedEvent
`response.file_search_call.in_progress`	OpenAI.ResponseFileSearchCallInProgressEvent
`response.file_search_call.searching`	OpenAI.ResponseFileSearchCallSearchingEvent
`response.function_call_arguments.delta`	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
`response.function_call_arguments.done`	OpenAI.ResponseFunctionCallArgumentsDoneEvent
`response.in_progress`	OpenAI.ResponseInProgressEvent
`response.failed`	OpenAI.ResponseFailedEvent
`response.incomplete`	OpenAI.ResponseIncompleteEvent
`response.output_item.added`	OpenAI.ResponseOutputItemAddedEvent
`response.output_item.done`	OpenAI.ResponseOutputItemDoneEvent
`response.refusal.delta`	OpenAI.ResponseRefusalDeltaEvent
`response.refusal.done`	OpenAI.ResponseRefusalDoneEvent
`response.output_text.delta`	OpenAI.ResponseTextDeltaEvent
`response.output_text.done`	OpenAI.ResponseTextDoneEvent
`response.reasoning_summary_part.added`	OpenAI.ResponseReasoningSummaryPartAddedEvent
`response.reasoning_summary_part.done`	OpenAI.ResponseReasoningSummaryPartDoneEvent
`response.reasoning_summary_text.delta`	OpenAI.ResponseReasoningSummaryTextDeltaEvent
`response.reasoning_summary_text.done`	OpenAI.ResponseReasoningSummaryTextDoneEvent
`response.web_search_call.completed`	OpenAI.ResponseWebSearchCallCompletedEvent
`response.web_search_call.in_progress`	OpenAI.ResponseWebSearchCallInProgressEvent
`response.web_search_call.searching`	OpenAI.ResponseWebSearchCallSearchingEvent
`response.image_generation_call.completed`	OpenAI.ResponseImageGenCallCompletedEvent
`response.image_generation_call.generating`	OpenAI.ResponseImageGenCallGeneratingEvent
`response.image_generation_call.in_progress`	OpenAI.ResponseImageGenCallInProgressEvent
`response.image_generation_call.partial_image`	OpenAI.ResponseImageGenCallPartialImageEvent
`response.mcp_call.arguments_delta`	OpenAI.ResponseMCPCallArgumentsDeltaEvent
`response.mcp_call.arguments_done`	OpenAI.ResponseMCPCallArgumentsDoneEvent
`response.mcp_call.completed`	OpenAI.ResponseMCPCallCompletedEvent
`response.mcp_call.failed`	OpenAI.ResponseMCPCallFailedEvent
`response.mcp_call.in_progress`	OpenAI.ResponseMCPCallInProgressEvent
`response.mcp_list_tools.completed`	OpenAI.ResponseMCPListToolsCompletedEvent
`response.mcp_list_tools.failed`	OpenAI.ResponseMCPListToolsFailedEvent
`response.mcp_list_tools.in_progress`	OpenAI.ResponseMCPListToolsInProgressEvent
`response.queued`	OpenAI.ResponseQueuedEvent
`response.reasoning.delta`	OpenAI.ResponseReasoningDeltaEvent
`response.reasoning.done`	OpenAI.ResponseReasoningDoneEvent
`response.reasoning_summary.delta`	OpenAI.ResponseReasoningSummaryDeltaEvent
`response.reasoning_summary.done`	OpenAI.ResponseReasoningSummaryDoneEvent
`response.code_interpreter_call_code.delta`	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
`response.code_interpreter_call_code.done`	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
`response.code_interpreter_call.completed`	OpenAI.ResponseCodeInterpreterCallCompletedEvent
`response.code_interpreter_call.in_progress`	OpenAI.ResponseCodeInterpreterCallInProgressEvent
`response.code_interpreter_call.interpreting`	OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Nome	Tipo	Description	Obrigatório	Predefinido
sequence_number	número inteiro	O número de série para este evento.	Yes
tipo	OpenAI.ResponseStreamEventType		Yes

OpenAI.ResponseStreamEventType

Propriedade valor

Type cadeia (de caracteres)

Valores response.audio.delta
response.audio.done
response.audio_transcript.delta
response.audio_transcript.done
response.code_interpreter_call_code.delta
response.code_interpreter_call_code.done
response.code_interpreter_call.completed
response.code_interpreter_call.in_progress
response.code_interpreter_call.interpreting
response.completed
response.content_part.added
response.content_part.done
response.created
error
response.file_search_call.completed
response.file_search_call.in_progress
response.file_search_call.searching
response.function_call_arguments.delta
response.function_call_arguments.done
response.in_progress
response.failed
response.incomplete
response.output_item.added
response.output_item.done
response.refusal.delta
response.refusal.done
response.output_text.annotation.added
response.output_text.delta
response.output_text.done
response.reasoning_summary_part.added
response.reasoning_summary_part.done
response.reasoning_summary_text.delta
response.reasoning_summary_text.done
response.web_search_call.completed
response.web_search_call.in_progress
response.web_search_call.searching
response.image_generation_call.completed
response.image_generation_call.generating
response.image_generation_call.in_progress
response.image_generation_call.partial_image
response.mcp_call.arguments_delta
response.mcp_call.arguments_done
response.mcp_call.completed
response.mcp_call.failed
response.mcp_call.in_progress
response.mcp_list_tools.completed
response.mcp_list_tools.failed
response.mcp_list_tools.in_progress
response.queued
response.reasoning.delta
response.reasoning.done
response.reasoning_summary.delta
response.reasoning_summary.done

OpenAI.ResponseTextDeltaEvent

Emitido quando há um delta de texto adicional.

Nome	Tipo	Description	Obrigatório
content_index	número inteiro	O índice da parte de conteúdo à qual foi adicionado o delta de texto.	Yes
delta	cadeia (de caracteres)	O texto delta que foi adicionado.	Yes
item_id	cadeia (de caracteres)	A ID do item de saída ao qual o delta de texto foi adicionado.	Yes
output_index	número inteiro	O índice do item de saída ao qual o delta de texto foi adicionado.	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	número inteiro	O índice da parte do conteúdo em que o texto é finalizado.	Yes
item_id	cadeia (de caracteres)	O ID do item de saída onde o conteúdo de texto foi finalizado.	Yes
output_index	número inteiro	O índice do item de saída em que o conteúdo do texto é finalizado.	Yes
enviar SMS	cadeia (de caracteres)	Conteúdo do texto que foi finalizado.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.output_text.done`. Valores possíveis: `response.output_text.done`	Yes

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

Discriminador para Configuração do Formato de Texto de Resposta do OpenAI

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

Valor do tipo	Schema
`text`	OpenAI.ResponseTextFormatConfigurationText
`json_object`	OpenAI.ResponseTextFormatConfigurationJsonObject
`json_schema`	OpenAI.ResponseTextFormatConfigurationJsonSchema

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	OpenAI.TipoDeConfiguraçãoDeFormatoDeTextoDeResposta	Um objeto que especifica o formato que o modelo deve produzir. A configuração `{ "type": "json_schema" }` permite saídas estruturadas, o que garante que o modelo corresponderá 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: Definir para `{ "type": "json_object" }` ativa o modo JSON mais antigo, que garante que a mensagem que o modelo gera é JSON válida. Usando `json_schema` é preferível para modelos que o suportem.	Yes

OpenAI.ResponseTextFormatConfigurationJsonObject

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	Valores possíveis: `json_object`	Yes

OpenAI.ResponseTextFormatConfigurationJsonSchema (esquema de configuração de formato de texto)

Formato de resposta do esquema JSON. Usado para gerar respostas JSON estruturadas. Saiba mais sobre Saídas Estruturadas.

Nome	Tipo	Description	Obrigatório	Predefinido
descrição	cadeia (de caracteres)	Uma descrição da finalidade do formato de resposta utilizada pelo modelo para Determine como responder no formato.	Não
nome	cadeia (de caracteres)	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	objecto		Yes
rigoroso	Booleano	Se a adesão estrita ao esquema deve ser habilitada ao gerar a saída. Se definido como true, o modelo sempre seguirá o esquema exato definido no campo `schema`. Somente um subconjunto do esquema JSON é suportado quando `strict` é `true`. Para saber mais, leia os Outputs estruturados guia.	Não	Falso
tipo	enumeração	O tipo de formato de resposta que está sendo definido. Sempre `json_schema`. Valores possíveis: `json_schema`	Yes

Configuração do Formato do Texto de Resposta do OpenAI

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	Valores possíveis: `text`	Yes

OpenAI.ResponseTextFormatConfigurationType

Um objeto que especifica o formato que o modelo deve produzir.

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

O formato padrão é { "type": "text" } sem opções adicionais.

Não recomendado para gpt-4o e modelos mais recentes:

Configurar para { "type": "json_object" } ativa o modo JSON antigo, o que garante que a mensagem gerada pelo modelo seja JSON válido. O uso json_schema é preferível para modelos que o suportam.

Propriedade	valor
Descrição	Um objeto que especifica o formato que o modelo deve produzir.

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

O formato padrão é { "type": "text" } sem opções adicionais.

Não recomendado para gpt-4o e modelos mais recentes:

OpenAI.ResponseUsage

Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento de tokens de saída e o total de tokens usados.

Nome	Tipo	Description	Obrigatório
input_tokens	número inteiro	O número de tokens de entrada.	Yes
input_tokens_details	objecto	Um detalhamento detalhado dos tokens de entrada.	Yes
└─ tokens em cache	número inteiro	O número de tokens que foram recuperados do cache. Saiba mais sobre o cache de prompts.	Não
output_tokens	número inteiro	O número de tokens de saída.	Yes
output_tokens_details	objecto	Um detalhamento detalhado dos tokens de saída.	Yes
└─ tokens de raciocínio	número inteiro	O número de tokens de raciocínio.	Não
total_tokens	número inteiro	O número total de tokens usados.	Yes

OpenAI.ResponseWebSearchCallCompletedEvent

Nota: web_search ainda não está disponível através do Azure OpenAI.

Nome	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	ID exclusivo para o item de saída associado à chamada de pesquisa na Web.	Yes
output_index	número inteiro	O índice do item de saída ao qual a chamada de pesquisa na Web está associada.	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

Nota: web_search ainda não está disponível através do Azure OpenAI.

Nome	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	ID exclusivo para o item de saída associado à chamada de pesquisa na Web.	Yes
output_index	número inteiro	O índice do item de saída ao qual a chamada de pesquisa na Web está associada.	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

Nota: web_search ainda não está disponível através do Azure OpenAI.

Nome	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	ID exclusivo para o item de saída associado à chamada de pesquisa na Web.	Yes
output_index	número inteiro	O índice do item de saída ao qual a chamada de pesquisa na Web está associada.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.web_search_call.searching`. Valores possíveis: `response.web_search_call.searching`	Yes

OpenAI.ResponsesAssistantMessageItemParam

Um item de parâmetro de mensagem com a assistant função.

Nome	Tipo	Description	Obrigatório	Predefinido
conteúdo	cadeia de caracteres ou matriz		Yes
função	enumeração	O papel da mensagem, que é sempre `assistant`. Valores possíveis: `assistant`	Yes

OpenAI.ResponsesAssistantMessageItemResource

Um recurso de mensagem com a função assistant.

Nome	Tipo	Description	Obrigatório	Predefinido
conteúdo	matriz	O conteúdo associado à mensagem.	Yes
função	enumeração	O papel da mensagem, que é sempre `assistant`. Valores possíveis: `assistant`	Yes

OpenAI.ResponsesDeveloperMessageItemParam

Um item de parâmetro de mensagem com a developer função.

Nome	Tipo	Description	Obrigatório	Predefinido
conteúdo	cadeia de caracteres ou matriz		Yes
função	enumeração	O papel da mensagem, que é sempre `developer`. Valores possíveis: `developer`	Yes

OpenAI.ResponsesDeveloperMessageItemResource

Um recurso de mensagem com a função developer.

Nome	Tipo	Description	Obrigatório	Predefinido
conteúdo	matriz	O conteúdo associado à mensagem.	Yes
função	enumeração	O papel da mensagem, que é sempre `developer`. Valores possíveis: `developer`	Yes

OpenAI.ResponsesMessageItemParam

Um item de mensagem de resposta, representando uma função e conteúdo, conforme fornecido como parâmetros de solicitação do cliente.

Discriminador para OpenAI.ResponsesMessageItemParam

Este componente usa a propriedade role para discriminar entre diferentes tipos:

Valor do tipo	Schema
`user`	OpenAI.ResponsesUserMessageItemParam
`system`	OpenAI.ResponsesSystemMessageItemParam
`developer`	OpenAI.ResponsesDeveloperMessageItemParam
`assistant`	OpenAI.ResponsesAssistantMessageItemParam

Nome	Tipo	Description	Obrigatório	Predefinido
função	objecto	A coleção de funções válidas para itens de mensagem de resposta.	Yes
tipo	enumeração	O tipo do item de respostas, que é sempre 'mensagem'. Valores possíveis: `message`	Yes

OpenAI.ResponsesMessageItemResource

Um item de recurso de mensagem de resposta, representando uma função e conteúdo, conforme fornecido nas respostas do serviço.

Discriminador para OpenAI.ResponsesMessageItemResource

Este componente usa a propriedade role para discriminar entre diferentes tipos:

Valor do tipo	Schema
`user`	OpenAI.ResponsesUserMessageItemResource
`system`	OpenAI.ResponsesSystemMessageItemResource
`developer`	OpenAI.ResponsesDeveloperMessageItemResource
`assistant`	OpenAI.ResponsesAssistantMessageItemResource

Nome	Tipo	Description	Obrigatório
função	objecto	A coleção de funções válidas para itens de mensagem de resposta.	Yes
estado	enumeração	O estado do item. Um dos `in_progress`, `completed`, ou `incomplete`. É preenchido quando os itens são retornados via API. Valores possíveis: `in_progress`, `completed`, `incomplete`	Yes
tipo	enumeração	O tipo do item de respostas, que é sempre 'mensagem'. Valores possíveis: `message`	Yes

OpenAI.ResponsesMessageRole

A coleção de funções válidas para itens de mensagem de resposta.

Propriedade	valor
Descrição	A coleção de funções válidas para itens de mensagem de resposta.
Type	cadeia (de caracteres)
Valores	`system` `developer` `user` `assistant`

OpenAI.ResponsesSystemMessageItemParam

Um item de parâmetro de mensagem com a system função.

Nome	Tipo	Description	Obrigatório	Predefinido
conteúdo	cadeia de caracteres ou matriz		Yes
função	enumeração	O papel da mensagem, que é sempre `system`. Valores possíveis: `system`	Yes

OpenAI.ResponsesSystemMessageItemResource

Um recurso de mensagem com a função system.

Nome	Tipo	Description	Obrigatório	Predefinido
conteúdo	matriz	O conteúdo associado à mensagem.	Yes
função	enumeração	O papel da mensagem, que é sempre `system`. Valores possíveis: `system`	Yes

OpenAI.ResponsesUserMessageItemParam

Um item de parâmetro de mensagem com a user função.

Nome	Tipo	Description	Obrigatório	Predefinido
conteúdo	cadeia de caracteres ou matriz		Yes
função	enumeração	O papel da mensagem, que é sempre `user`. Valores possíveis: `user`	Yes

OpenAI.ResponsesUserMessageItemResource

Um recurso de mensagem com a função user.

Nome	Tipo	Description	Obrigatório	Predefinido
conteúdo	matriz	O conteúdo associado à mensagem.	Yes
função	enumeração	O papel da mensagem, que é sempre `user`. Valores possíveis: `user`	Yes

OpenAI.ServiceTier

Especifica o tipo de processamento usado para atender à solicitação.

Se definido como 'auto', a solicitação será processada com a camada de serviço configurada nas configurações do projeto. A menos que configurado de outra forma, o projeto usará 'default'.
Se definido como 'padrão', a solicitação será processada com o preço e o desempenho padrão para o modelo selecionado.
Se definido como 'flex' ou 'priority', a solicitação será processada com a camada de serviço correspondente. Entre em contato com o departamento de vendas para saber mais sobre o processamento prioritário.
Quando não está definido, o comportamento padrão é 'auto'.

Quando o service_tier parâmetro é definido, o corpo da resposta incluirá o service_tier valor com base no modo de processamento realmente usado para atender à solicitação. Esse valor de resposta pode ser diferente do valor definido no parâmetro.

Propriedade	valor
Descrição	Especifica o tipo de processamento usado para atender à solicitação. * Se definido como 'auto', então o pedido será processado no nível de serviço configurado nas definições do Projeto. A menos que configurado de outra forma, o projeto usará 'default'. * Se definido como 'default', o pedido será processado com o standard preços e desempenho para o modelo selecionado. * Se definido para 'flex' ou 'prioridade', então o pedido será processado com o serviço correspondente de nível. Entre em contato com o departamento de vendas para saber mais sobre o processamento prioritário. * Quando não está definido, o comportamento padrão é 'auto'. Quando o `service_tier` parâmetro é definido, o corpo de resposta incluirá o `service_tier` valor baseado no modo de processamento efetivamente utilizado para servir o pedido. Este valor de resposta pode ser diferente do valor definido no parâmetro.
Type	cadeia (de caracteres)
Valores	`auto` `default` `flex` `scale` `priority`

OpenAI.TextResponseFormatConfiguration

Um objeto que especifica o formato que o modelo deve produzir.

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

O formato padrão é { "type": "text" } sem opções adicionais.

Não recomendado para gpt-4o e modelos mais recentes:*

Discriminador para OpenAI.TextResponseFormatConfiguration

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

Valor do tipo	Schema

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	cadeia (de caracteres)		Yes

OpenAI.Tool

Discriminador para OpenAI.Tool

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

Valor do tipo	Schema
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search_preview`	OpenAI.WebSearchPreviewTool
`code_interpreter`	OpenAI.CodeInterpreterTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellTool
`mcp`	OpenAI.MCPTool
`bing_grounding`	BingGroundingAgentTool
`fabric_dataagent_preview`	MicrosoftFabricAgentTool
`sharepoint_grounding_preview`	SharepointAgentTool
`azure_ai_search`	AzureAISearchAgentTool
`openapi`	OpenApiAgentTool
`bing_custom_search_preview`	BingCustomSearchAgentTool
`browser_automation_preview`	BrowserAutomationAgentTool
`azure_function`	AzureFunctionAgentTool
`capture_structured_outputs`	CaptureStructuredOutputsTool
`a2a_preview`	A2ATool
`memory_search`	MemorySearchTool

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	OpenAI.ToolType	Uma ferramenta que pode ser usada para gerar uma resposta.	Yes

OpenAI.ToolChoiceObject

Classificador para OpenAI.ToolChoiceObject

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

Valor do tipo	Schema
`file_search`	OpenAI.ToolChoiceObjectFileSearch
`computer_use_preview`	OpenAI.ToolChoiceObjectComputer
`web_search_preview`	OpenAI.ToolChoiceObjectWebSearch
`image_generation`	OpenAI.ToolChoiceObjectImageGen
`code_interpreter`	OpenAI.ToolChoiceObjectCodeInterpreter
`function`	OpenAI.ToolChoiceObjectFunction
`mcp`	OpenAI.ToolChoiceObjectMCP

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	OpenAI.ToolChoiceObjectType	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas integradas.	Yes

OpenAI.ToolChoiceObjectCodeInterpreter

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

OpenAI.ToolChoiceObjectComputer

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

OpenAI.ToolChoiceObjectFileSearch

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

OpenAI.ToolChoiceObjectFunction

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

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

OpenAI.ToolChoiceObjectImageGen

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

OpenAI.ToolChoiceObjectMCP

Use esta 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)	O nome da ferramenta a ser chamada no servidor.	Não
rótulo de servidor	cadeia (de caracteres)	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.ToolChoiceObjectType

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

Propriedade	valor
Descrição	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta.
Saiba mais sobre ferramentas integradas.
Type	cadeia (de caracteres)
Valores	`file_search` `function` `computer_use_preview` `web_search_preview` `image_generation` `code_interpreter` `mcp`

OpenAI.ToolChoiceObjectWebSearch

Nota: web_search ainda não está disponível através do Azure OpenAI.

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

OpenAI.ToolChoiceOptions

Controla qual (se houver) ferramenta é 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.

Propriedade	valor
Descrição	Controla qual (se houver) ferramenta é 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 fazer uma chamada. mais ferramentas. `required` significa que o modelo deve chamar uma ou mais ferramentas.
Type	cadeia (de caracteres)
Valores	`none` `auto` `required`

OpenAI.ToolType

Uma ferramenta que pode ser usada para gerar uma resposta.

Propriedade	valor
Descrição	Uma ferramenta que pode ser usada para gerar uma resposta.
Type	cadeia (de caracteres)
Valores	`file_search` `function` `computer_use_preview` `web_search_preview` `mcp` `code_interpreter` `image_generation` `local_shell` `bing_grounding` `browser_automation_preview` `fabric_dataagent_preview` `sharepoint_grounding_preview` `azure_ai_search` `openapi` `bing_custom_search_preview` `capture_structured_outputs` `a2a_preview` `azure_function` `memory_search`

OpenAI.TopLogProb

A probabilidade máxima do log de um token.

Nome	Tipo	Obrigatório
bytes	matriz	Yes
logprob	número	Yes
token	cadeia (de caracteres)	Yes

OpenAI.UpdateConversationRequest

Atualizar uma conversa

Nome	Tipo	Description	Obrigatório	Predefinido
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

OpenAI.VectorStoreFileAttributes

Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos via API ou o painel. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres, booleanos ou números.

Tipo: objeto

OpenAI.WebSearchAction

Discriminador para OpenAI.WebSearchAction

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

Valor do tipo	Schema
`find`	OpenAI.WebSearchActionPesquisar
`open_page`	OpenAI.WebSearchActionOpenPage
`search`	OpenAI.WebSearchActionSearch

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	OpenAI.WebSearchActionType		Yes

OpenAI.WebSearchActionLocalizar

Tipo de ação "localizar": procura um padrão dentro de uma página carregada.

Nome	Tipo	Description	Obrigatório
padrão	cadeia (de caracteres)	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`	Yes
url	cadeia (de caracteres)	A URL da página onde se procurou o padrão.	Yes

OpenAI.WebSearchActionOpenPage

Tipo de ação "open_page" - Abre um URL específico dos resultados da pesquisa.

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	O tipo de ação. Valores possíveis: `open_page`	Yes
url	cadeia (de caracteres)	O URL aberto pelo modelo.	Yes

OpenAI.WebSearchActionSearch

Tipo de ação "pesquisar" - Executa uma consulta de pesquisa na Web.

Nome	Tipo	Description	Obrigatório
consulta	cadeia (de caracteres)	A consulta de pesquisa.	Yes
Fontes	matriz	As fontes utilizadas na pesquisa.	Não
tipo	enumeração	O tipo de ação. Valores possíveis: `search`	Yes

OpenAI.WebSearchActionSearchSources

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	enumeração	Valores possíveis: `url`	Yes
url	cadeia (de caracteres)		Yes

OpenAI.WebSearchActionType

Propriedade	valor
Type	cadeia (de caracteres)
Valores	`search` `open_page` `find`

OpenAI.WebSearchPreviewTool

Nota: web_search ainda não está disponível através do Azure OpenAI.

Nome	Tipo	Description	Obrigatório
tamanho_do_contexto_de_pesquisa	enumeração	Orientação de alto nível para a quantidade de espaço na janela de contexto a ser usada para a pesquisa. Um de `low`, `medium`ou `high`. `medium` é o padrão. Valores possíveis: `low`, `medium`, `high`	Não
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_utilizador	objecto		Não
└─ tipo	OpenAI.LocationType		Não

OpenAI.WebSearchToolCallItemParam

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	objecto		Yes
└─ tipo	OpenAI.WebSearchActionType		Não
tipo	enumeração	Valores possíveis: `web_search_call`	Yes

OpenAI.WebSearchToolCallItemResource

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	objecto		Yes
└─ tipo	OpenAI.WebSearchActionType		Não
estado	enumeração	O status da chamada da ferramenta de pesquisa na web. Valores possíveis: `in_progress`, `searching`, `completed`, `failed`	Yes
tipo	enumeração	Valores possíveis: `web_search_call`	Yes

OpenAI.integer

Tipo: inteiro

Formato: int64

OpenAI.numeric

Tipo: número

Formato: duplo

OpenApiAgentTool

As informações de definição de entrada para uma ferramenta OpenAPI como usada para configurar um agente.

Nome	Tipo	Description	Obrigatório
OpenAPI	objecto	As informações de definição de entrada para uma função openapi.	Yes
└─ Auth	OpenApiAuthDetalhes	Abrir detalhes de autenticação da API	Não
└─ default_params	matriz	Lista de parâmetros de especificação OpenAPI que usarão padrões fornecidos pelo usuário	Não
└─ Descrição	cadeia (de caracteres)	Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função.	Não
└─ Funções	matriz	Lista de definições de função usadas pela ferramenta OpenApi	Não
└─ nome	cadeia (de caracteres)	O nome da função a ser chamada.	Não
└─ Especificação		A forma da função openapi, descrita como um objeto Schema JSON.	Não
tipo	enumeração	O tipo de objeto, que é sempre 'openapi'. Valores possíveis: `openapi`	Yes

OpenApiAnonymousAuthDetalhes

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

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

OpenApiAuthDetalhes

detalhes de autenticação para OpenApiFunctionDefinition

Discriminador para OpenApiAuthDetails

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

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

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	objecto	Tipo de autenticação para o ponto de extremidade OpenApi. Os tipos permitidos são: - Anónimo (sem necessidade de autenticação) - Ligação ao Projeto (requer project_connection_id para o endpoint, conforme configurado no Foundry) - Managed_Identity (requer público 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 Connection (requer project_connection_id para terminar, conforme configurado no Foundry)
Managed_Identity (requer audiência para autenticação baseada em identidade)

Propriedade	valor
Type	cadeia (de caracteres)
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	objecto	detalhes de autenticação para OpenApiFunctionDefinition	Yes
└─ tipo	OpenApiAuthType	O tipo de autenticação deve ser anónima/project_connection/managed_identity	Não
default_params	matriz	Lista de parâmetros de especificação OpenAPI que usarão padrões fornecidos pelo usuário	Não
descrição	cadeia (de caracteres)	Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função.	Não
functions	matriz	Lista de definições de função usadas pela ferramenta OpenApi	Não
nome	cadeia (de caracteres)	O nome da função a ser chamada.	Yes
spec		A forma da função openapi, descrita como um objeto Schema JSON.	Yes

OpenApiManagedAuthDetails

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

Nome	Tipo	Description	Obrigatório
security_scheme	objecto	Esquema de segurança para autenticação OpenApi managed_identity	Yes
└─ público	cadeia (de caracteres)	Escopo de autenticação para managed_identity tipo de autenticação	Não
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 OpenApi managed_identity

Nome	Tipo	Description	Obrigatório	Predefinido
audience	cadeia (de caracteres)	Escopo de autenticação para managed_identity tipo de autenticação	Yes

OpenApiProjectConnectionAuthDetails

Detalhes de segurança para autenticação de conexão de projeto OpenApi

Nome	Tipo	Description	Obrigatório
security_scheme	objecto	Esquema de segurança para autenticação OpenApi managed_identity	Yes
└─ project_connection_id	cadeia (de caracteres)	ID de conexão do projeto para o tipo de autenticação do Project Connection	Não
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 OpenApi managed_identity

Nome	Tipo	Description	Obrigatório	Predefinido
project_connection_id	cadeia (de caracteres)	ID de conexão do projeto para o tipo de autenticação do Project Connection	Yes

PagedConnection

Coleção paginada de itens de conexão

Nome	Tipo	Description	Obrigatório	Predefinido
Próximo Link	cadeia (de caracteres)	O link para a próxima página de itens	Não
valor	matriz	Os itens de conexão nesta página	Yes

PagedDatasetVersion

Coleção paginada de itens DatasetVersion

Nome	Tipo	Description	Obrigatório	Predefinido
Próximo Link	cadeia (de caracteres)	O link para a próxima página de itens	Não
valor	matriz	Os itens DatasetVersion nesta página	Yes

PagedDeployment

Coleção paginada de itens de implantação

Nome	Tipo	Description	Obrigatório	Predefinido
Próximo Link	cadeia (de caracteres)	O link para a próxima página de itens	Não
valor	matriz	Os itens de implantação nesta página	Yes

Regra de AvaliaçãoPaged

Coleção paginada de itens da EvaluationRule

Nome	Tipo	Description	Obrigatório	Predefinido
Próximo Link	cadeia (de caracteres)	O link para a próxima página de itens	Não
valor	matriz	Os itens da Regra de Avaliação nesta página	Yes

TaxonomiaAvaliaçãoPaged

Coleção paginada de itens da Taxonomia de Avaliação

Nome	Tipo	Description	Obrigatório	Predefinido
Próximo Link	cadeia (de caracteres)	O link para a próxima página de itens	Não
valor	matriz	Os itens da Taxonomia de Avaliação nesta página	Yes

PagedEvaluatorVersion

Coleção paginada de itens do EvaluatorVersion

Nome	Tipo	Description	Obrigatório	Predefinido
Próximo Link	cadeia (de caracteres)	O link para a próxima página de itens	Não
valor	matriz	Os itens da EvaluatorVersion nesta página	Yes

PagedIndex

Coleção paginada de itens de índice

Nome	Tipo	Description	Obrigatório	Predefinido
Próximo Link	cadeia (de caracteres)	O link para a próxima página de itens	Não
valor	matriz	Os itens de índice nesta página	Yes

PagedInsight

Coleção paginada de itens do Insight

Nome	Tipo	Description	Obrigatório	Predefinido
Próximo Link	cadeia (de caracteres)	O link para a próxima página de itens	Não
valor	matriz	Os itens de Insight nesta página	Yes

PagedRedTeam

Coleção paginada de itens RedTeam

Nome	Tipo	Description	Obrigatório	Predefinido
Próximo Link	cadeia (de caracteres)	O link para a próxima página de itens	Não
valor	matriz	Os itens RedTeam nesta página	Yes

PagedSchedule

Coleção paginada de itens Schedule

Nome	Tipo	Description	Obrigatório	Predefinido
Próximo Link	cadeia (de caracteres)	O link para a próxima página de itens	Não
valor	matriz	Os itens Agendar nesta página	Yes

PagedScheduleRun

Coleção paginada de itens ScheduleRun

Nome	Tipo	Description	Obrigatório	Predefinido
Próximo Link	cadeia (de caracteres)	O link para a próxima página de itens	Não
valor	matriz	Os itens ScheduleRun nesta página	Yes

PendingUploadRequest

Representa uma solicitação para um carregamento pendente.

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

PendingUploadResponse

Representa a resposta para uma solicitação de carregamento pendente

Nome	Tipo	Description	Obrigatório
blobReference	objecto	Detalhes de referência do Blob.	Yes
└─ blobUri	cadeia (de caracteres)	Caminho de URI de blob para o cliente carregar dados. Exemplo: `https://blob.windows.core.net/Container/Path`	Não
└─ Credencial	SasCredential	Informações de credenciais para acessar a conta de armazenamento.	Não
└─ storageAccountArmId	cadeia (de caracteres)	ID ARM da conta de armazenamento a ser usada.	Não
pendingUploadId	cadeia (de caracteres)	ID para este pedido de carregamento.	Yes
pendingUploadType	enumeração	BlobReference é o único tipo suportado Valores possíveis: `BlobReference`	Yes
versão	cadeia (de caracteres)	Versão do ativo a ser criado se o usuário não especificou a versão ao criar inicialmente o upload	Não

PromptAgentDefinição

A definição do agente de prompt

Nome	Tipo	Description	Obrigatório	Predefinido
instructions	cadeia (de caracteres)	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo.	Não
tipo	enumeração	Valores possíveis: `prompt`	Yes
modelo	cadeia (de caracteres)	A implantação do modelo a ser usada para esse agente.	Yes
reasoning	objecto	Apenas modelos da série O Opções de configuração para modelos de raciocínio.	Não
└─ esforço	OpenAI.ReasoningEffort	Restringe o esforço no raciocínio para modelos de raciocínio. Os valores atualmente suportados são nenhum, mínimo, baixo, médio e alto. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta. O GPT-5.1 por defeito é nenhum, que não executa raciocínio. Os valores de raciocínio suportados para gpt-5.1 são nenhum, baixo, médio e alto. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. Todos os modelos anteriores ao gpt-5.1 usam por defeito o esforço de raciocínio médio e não suportam nenhum. O modelo gpt-5-pro tem por defeito (e só suporta) um esforço de raciocínio elevado.	Não
└─ gerar_resumo	enumeração	Preterido: use `summary` em vez disso. Um resumo do raciocínio realizado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo. Um de `auto`, `concise`ou `detailed`. Valores possíveis: `auto`, `concise`, `detailed`	Não
└─ Resumo	enumeração	Um resumo do raciocínio realizado pelo modelo. Isto pode ser útil para depurar e compreender o processo de raciocínio do modelo. Um de `auto`, `concise`ou `detailed`. Valores possíveis: `auto`, `concise`, `detailed`	Não
structured_inputs	objecto	Conjunto de entradas estruturadas que podem participar de substituição de modelo de prompt ou vinculações de argumento de ferramenta.	Não
temperatura	número	Qual a temperatura de amostragem a utilizar, entre 0 e 2. Valores mais altos como 0,8 tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente, recomendamos alterar isto ou `top_p`, mas não ambos.	Não	1
enviar SMS	objecto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados.	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
Ferramentas	matriz	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.	Não
top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com probabilidade top_p massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade são considerados. Geralmente, recomendamos alterar isto ou `temperature`, mas não ambos.	Não	1

PromptBasedEvaluatorDefinition

Avaliador baseado em prompts

Nome	Tipo	Description	Obrigatório	Predefinido
prompt_text	cadeia (de caracteres)	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	Predefinido
protocolo	objecto		Yes
versão	cadeia (de caracteres)	A cadeia de caracteres de versão para o protocolo, por exemplo, 'v0.1.1'.	Yes

RaiConfig

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

Nome	Tipo	Description	Obrigatório	Predefinido
rai_policy_name	cadeia (de caracteres)	O nome da política RAI a ser aplicada.	Yes

RecurrenceSchedule

Modelo de cronograma de recorrência.

Discriminador para RecurrenceSchedule

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

Valor do tipo	Schema
`Hourly`	Horário de RecorrênciaHorário
`Daily`	DailyRecurrenceSchedule
`Weekly`	Horário de Recorrência Semanal
`Monthly`	Horário de Recorrência Mensal

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	objecto	Tipo de recorrência.	Yes

RecurrenceTrigger

Gatilho baseado em recorrência.

Nome	Tipo	Description	Obrigatório	Predefinido
endTime	cadeia (de caracteres)	Hora de término do cronograma de recorrência no formato ISO 8601.	Não
intervalo	número inteiro	Intervalo para o esquema de recorrência.	Yes
cronograma	objecto	Modelo de cronograma de recorrência.	Yes
└─ tipo	RecorrênciaTipo	Tipo de recorrência para o calendário de recorrências.	Não
startTime	cadeia (de caracteres)	Hora de início do cronograma de recorrência no formato ISO 8601.	Não
Fuso horário	cadeia (de caracteres)	Fuso horário para o cronograma de recorrência.	Não	UTC
tipo	enumeração	Tipo de gatilho. Valores possíveis: `Recurrence`	Yes

RecorrênciaTipo

Tipo de recorrência.

Propriedade	valor
Descrição	Tipo de recorrência.
Type	cadeia (de caracteres)
Valores	`Hourly` `Daily` `Weekly` `Monthly`

RedTeam

Detalhes da equipe vermelha.

Nome	Tipo	Description	Obrigatório	Predefinido
Cenário de aplicação	cadeia (de caracteres)	Cenário de aplicação para a operação da equipe vermelha, para gerar ataques específicos do cenário.	Não
Estratégias de ataque	matriz	Lista de estratégias de ataque ou listas aninhadas de estratégias de ataque.	Não
nome de exibição	cadeia (de caracteres)	Nome da equipe vermelha executada.	Não
id	cadeia (de caracteres)	Identificador da corrida da equipe vermelha.	Yes
numTurns	número inteiro	Número de rondas de simulação.	Não
propriedades	objecto	Propriedades da equipa vermelha. Ao contrário das tags, as propriedades são somente add-only. Uma vez adicionada, uma propriedade não pode ser removida.	Não
riscoCategorias	matriz	Lista de categorias de risco para gerar objetivos de ataque.	Não
simulationOnly	Booleano	Apenas simulação ou simulação + avaliação. Default false, se true a verificação produz conversa e não resultado da avaliação.	Não	Falso
estado	cadeia (de caracteres)	Estatuto da equipa vermelha. Ele é definido por serviço e é somente leitura.	Não
etiquetas	objecto	Tags do time vermelho. Ao contrário das propriedades, as tags são totalmente mutáveis.	Não
destino	objecto	Classe abstrata para configuração de destino.	Yes
└─ tipo	cadeia (de caracteres)	Tipo de configuração do modelo.	Não

RedTeamItemGenerationParams

Representa os parâmetros para a geração de itens da equipa vermelha.

Nome	Tipo	Description	Obrigatório
attack_strategies	matriz	A coleção de estratégias de ataque a utilizar.	Yes
num_turns	número inteiro	O número de turnos permitidos no jogo.	Yes
tipo	enumeração	O tipo de parâmetros de geração de itens, sempre `red_team`. Valores possíveis: `red_team`	Yes

RiscoCategoria

Categoria de risco para o objetivo de ataque.

Propriedade	valor
Descrição	Categoria de risco para o objetivo de ataque.
Type	cadeia (de caracteres)
Valores	`HateUnfairness` `Violence` `Sexual` `SelfHarm` `ProtectedMaterial` `CodeVulnerability` `UngroundedAttributes` `ProhibitedActions` `SensitiveDataLeakage` `TaskAdherence`

SASCredentiais

Definição de credenciais de Assinatura de Acesso Compartilhado (SAS)

Nome	Tipo	Description	Obrigatório	Predefinido
SAS	cadeia (de caracteres)	token de SAS	Não
tipo	enumeração	O tipo de credencial Valores possíveis: `SAS`	Yes

SampleType

O tipo de amostra utilizada na análise.

Propriedade	valor
Type	cadeia (de caracteres)
Valores	`EvaluationResultSample`

SasCredential

Definição de credenciais SAS

Nome	Tipo	Description	Obrigatório	Predefinido
sasUri	cadeia (de caracteres)	Uri SAS	Yes
tipo	enumeração	Tipo de credencial Valores possíveis: `SAS`	Yes

Schedule

Modelo de programação.

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	Descrição do horário.	Não
nome de exibição	cadeia (de caracteres)	Nome da agenda.	Não
ativado	Booleano	Status habilitado da agenda.	Yes
id	cadeia (de caracteres)	Identificador da agenda.	Yes
propriedades	objecto	Propriedades da programação. Ao contrário das tags, as propriedades são somente add-only. Uma vez adicionada, uma propriedade não pode ser removida.	Não
estadoDeProvisionamento	objecto	Agendar status de provisionamento.	Não
DadosDoSistema	objecto	Metadados do sistema para o recurso.	Yes
etiquetas	objecto	Tags da programação. Ao contrário das propriedades, as tags são totalmente mutáveis.	Não
tarefa	objecto	Agendar modelo de tarefa.	Yes
└─ Configuração	objecto	Configuração para a tarefa.	Não
└─ tipo	ScheduleTaskType	Tipo de tarefa.	Não
accionador	objecto	Modelo base para Trigger do cronograma.	Yes
└─ tipo	Tipo de Disparo	Tipo de gatilho.	Não

ScheduleProvisioningStatus

Agendar status de provisionamento.

Propriedade	valor
Descrição	Agendar status de provisionamento.
Type	cadeia (de caracteres)
Valores	`Creating` `Updating` `Deleting` `Succeeded` `Failed`

ScheduleRun

Agendar modelo de execução.

Nome	Tipo	Description	Obrigatório
erro	cadeia (de caracteres)	Informações de erro para a execução do agendamento.	Não
id	cadeia (de caracteres)	Identificador da execução da agenda.	Yes
propriedades	objecto	As propriedades da agenda são executadas.	Yes
scheduleId	cadeia (de caracteres)	Identificador da agenda.	Yes
sucesso	Booleano	Acione o status de sucesso da execução do cronograma.	Yes
Tempo de gatilho	cadeia (de caracteres)	Tempo de gatilho da execução do cronograma.	Não

AgendaTarefa

Agendar modelo de tarefa.

Discriminador para o ScheduleTask

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

Valor do tipo	Schema
`Evaluation`	TarefaAvaliaçãoAgendaTarefa
`Insight`	InsightScheduleTask

Nome	Tipo	Description	Obrigatório	Predefinido
configuração	objecto	Configuração para a tarefa.	Não
tipo	objecto	Tipo de tarefa.	Yes

ScheduleTaskType

Tipo de tarefa.

Propriedade	valor
Descrição	Tipo de tarefa.
Type	cadeia (de caracteres)
Valores	`Evaluation` `Insight`

SeedPromptsRedTeamItemGenerationParams

Representa os parâmetros para a geração de itens da equipa vermelha com prompts seed.

Nome	Tipo	Description	Obrigatório
attack_strategies	matriz	A coleção de estratégias de ataque a utilizar.	Yes
num_turns	número inteiro	O número de turnos permitidos no jogo.	Yes
origem	objecto		Yes
└─ conteúdo	matriz	O conteúdo do arquivo jsonl.	Não
└─ ID	cadeia (de caracteres)	O identificador do arquivo.	Não
└─ tipo	enumeração	O tipo de fonte jsonl. Sempre `file_id`. Valores possíveis: `file_id`	Não
tipo	enumeração	O tipo de parâmetros de geração de itens, sempre `red_team`. Valores possíveis: `red_team_seed_prompts`	Yes

SharepointAgentTool

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

Nome	Tipo	Description	Obrigatório
sharepoint_grounding_preview	objecto	Os parâmetros da ferramenta de aterramento do sharepoint.	Yes
└─ project_connections	matriz	As conexões do projeto anexadas a esta ferramenta. Pode haver um máximo de 1 ligação recurso associado à ferramenta.	Não
tipo	enumeração	O tipo de objeto, que é sempre 'sharepoint_grounding'. Valores possíveis: `sharepoint_grounding_preview`	Yes

Ferramentas de Aterramento do SharePoint

Os parâmetros da ferramenta de aterramento do sharepoint.

Nome	Tipo	Description	Obrigatório	Predefinido
project_connections	matriz	As conexões do projeto anexadas a esta ferramenta. Pode haver um máximo de 1 ligação recurso associado à ferramenta.	Não

Sku

Informações sobre Sku

Nome	Tipo	Description	Obrigatório
capacidade	número inteiro	Capacidade de Sku	Yes
family	cadeia (de caracteres)	Família Sku	Yes
nome	cadeia (de caracteres)	Nome Sku	Yes
tamanho	cadeia (de caracteres)	Tamanho do Sku	Yes
escalão	cadeia (de caracteres)	Nível de Sku	Yes

EstruturadInputDefinição

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

Nome	Tipo	Description	Obrigatório	Predefinido
default_value		O valor padrão para a entrada se nenhum valor de tempo de execução for fornecido.	Não
descrição	cadeia (de caracteres)	Uma descrição legível por humanos da entrada.	Não
required	Booleano	Se a propriedade input é necessária quando o agente é invocado.	Não	Falso
esquema		O esquema JSON para a entrada estruturada (opcional).	Não

StructuredOutputDefinition

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

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	Uma descrição da saída a emitir. Usado pelo modelo para determinar quando emitir a saída.	Yes
nome	cadeia (de caracteres)	O nome da saída estruturada.	Yes
esquema		O esquema JSON para a saída estruturada.	Yes
rigoroso	Booleano	Se a validação estrita deve ser imposta. Padrão `true`.	Yes

StructuredOutputsItemResource

Nome	Tipo	Description	Obrigatório	Predefinido
output		A saída estruturada captada durante a resposta.	Yes
tipo	enumeração	Valores possíveis: `structured_outputs`	Yes

Target

Classe base para alvos com suporte a discriminadores.

Discriminador por Alvo

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

Valor do tipo	Schema
`azure_ai_model`	AzureAIModelTarget
`azure_ai_agent`	AzureAIAgentTarget
`azure_ai_assistant`	AzureAIAssistantTarget

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	cadeia (de caracteres)	O tipo de alvo.	Yes

Finalizações de Alvos

Representa uma fonte de dados para a configuração de avaliação de conclusão baseada em alvos.

Nome	Tipo	Description	Obrigatório
mensagens_de_entrada	objecto		Não
└─ referência_do_item	cadeia (de caracteres)		Não
└─ tipo	enumeração	Valores possíveis: `item_reference`	Não
origem	objecto		Yes
└─ conteúdo	matriz	O conteúdo do arquivo jsonl.	Não
└─ ID	cadeia (de caracteres)	O identificador do arquivo.	Não
└─ tipo	enumeração	O tipo de fonte jsonl. Sempre `file_id`. Valores possíveis: `file_id`	Não
destino	objecto	Classe base para alvos com suporte a discriminadores.	Yes
└─ tipo	cadeia (de caracteres)	O tipo de alvo.	Não
tipo	enumeração	O tipo de fonte de dados, sempre `TargetCompletions`. Valores possíveis: `azure_ai_target_completions`	Yes

TargetConfig

Classe abstrata para configuração de destino.

Discriminador para o TargetConfig

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

Valor do tipo	Schema
`AzureOpenAIModel`	AzureOpenAIModelConfiguration

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	cadeia (de caracteres)	Tipo de configuração do modelo.	Yes

TargetUpdate

Classe base para alvos com suporte a discriminadores.

Discriminador para o TargetUpdate

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

Valor do tipo	Schema
`azure_ai_model`	AzureAIModelTargetUpdate
`azure_ai_assistant`	AzureAIAssistantTargetUpdate

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	cadeia (de caracteres)	O tipo de alvo.	Yes

TaxonomiaCategoria

Definição de categoria de taxonomia.

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	Descrição da categoria de taxonomia.	Não
id	cadeia (de caracteres)	Identificador exclusivo da categoria de taxonomia.	Yes
nome	cadeia (de caracteres)	Nome da categoria de taxonomia.	Yes
propriedades	objecto	Propriedades adicionais para a categoria de taxonomia.	Não
RiscoCategoria	objecto	Categoria de risco para o objetivo de ataque.	Yes
subCategorias	matriz	Lista de subcategorias de taxonomia.	Yes

TaxonomiaTRedItemItemGenerationParams

Representa os parâmetros para a geração de itens da equipa vermelha com prompts seed.

Nome	Tipo	Description	Obrigatório
attack_strategies	matriz	A coleção de estratégias de ataque a utilizar.	Yes
num_turns	número inteiro	O número de turnos permitidos no jogo.	Yes
origem	objecto		Yes
└─ conteúdo	matriz	O conteúdo do arquivo jsonl.	Não
└─ ID	cadeia (de caracteres)	O identificador do arquivo.	Não
└─ tipo	enumeração	O tipo de fonte jsonl. Sempre `file_id`. Valores possíveis: `file_id`	Não
tipo	enumeração	O tipo de parâmetros de geração de itens, sempre `red_team`. Valores possíveis: `red_team_taxonomy`	Yes

Subcategoria de Taxonomia

Definição de subcategoria de taxonomia.

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	Descrição da subcategoria de taxonomia.	Não
ativado	Booleano	Lista de itens de taxonomia nesta subcategoria.	Yes
id	cadeia (de caracteres)	Identificador único da subcategoria de taxonomia.	Yes
nome	cadeia (de caracteres)	Nome da subcategoria da taxonomia.	Yes
propriedades	objecto	Propriedades adicionais para a subcategoria de taxonomia.	Não

Descrição da Ferramenta

Descrição de uma ferramenta que pode ser usada por um agente.

Nome	Tipo	Description	Obrigatório	Predefinido
descrição	cadeia (de caracteres)	Uma breve descrição da finalidade da ferramenta.	Não
nome	cadeia (de caracteres)	O nome da ferramenta.	Não

ToolProjectConnection

Um recurso de conexão de projeto.

Nome	Tipo	Description	Obrigatório	Predefinido
project_connection_id	cadeia (de caracteres)	Uma conexão de projeto em um ToolProjectConnectionList anexado a esta ferramenta.	Yes

TracesEvalRunDataSource

Representa uma fonte de dados para execuções de avaliação que operam sobre trilhos de Agente armazenados em Application Insights.

Nome	Tipo	Description	Obrigatório	Predefinido
lookback_hours	número inteiro	Janela de retrospetiva (em horas) aplicada ao recuperar traços do Application Insights.	Não	168
trace_ids	matriz	Coleção de identificadores de rastreamento do Agente que devem ser avaliados.	Yes
tipo	enumeração	O tipo de fonte de dados, sempre `azure_ai_traces`. Valores possíveis: `azure_ai_traces`	Yes

TreatmentEffectType

Tipo de efeito do tratamento.

Propriedade	valor
Type	cadeia (de caracteres)
Valores	`TooFewSamples` `Inconclusive` `Changed` `Improved` `Degraded`

Acionador

Modelo base para Trigger do cronograma.

Discriminador por Trigger

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

Valor do tipo	Schema
`Cron`	CronTrigger
`Recurrence`	RecurrenceTrigger
`OneTime`	OneTimeTrigger

Nome	Tipo	Description	Obrigatório	Predefinido
tipo	objecto	Tipo de gatilho.	Yes

Tipo de gatilho

Tipo de gatilho.

Propriedade	valor
Descrição	Tipo de gatilho.
Type	cadeia (de caracteres)
Valores	`Cron` `Recurrence` `OneTime`

UpdateAgentFromManifestRequest

Nome	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	Uma descrição do agente legível por humanos.	Não
manifest_id	cadeia (de caracteres)	O ID do manifesto para importar a versão do agente.	Yes
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
parameter_values	objecto	As entradas para o manifesto resultarão num Agente totalmente materializado.	Yes

UpdateAgentRequest

Nome	Tipo	Description	Obrigatório
Definição	objecto		Yes
└─ amável	AgentKind		Não
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo de IA Responsável (RAI) e recursos de segurança.	Não
descrição	cadeia (de caracteres)	Uma descrição do agente legível por humanos.	Não
metadados	objecto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

UpdateEvalParametersBody

Nome	Tipo	Description	Obrigatório
metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informações adicionais sobre o objeto de forma estruturada formato e consulta de objetos via API ou painel de controlo. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia (de caracteres)		Não
propriedades	objecto	Conjunto de 16 pares chave-valor imutáveis que podem ser ligados a um objeto para armazenar informação adicional. As teclas são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

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	Predefinido
tipo	enumeração	O tipo do item de memória. Valores possíveis: `user_profile`	Yes

Horário de Recorrência Semanal

Esquema semanal de recorrência.

Nome	Tipo	Description	Obrigatório	Predefinido
daysOfWeek	matriz	Dias da semana para o esquema de recorrência.	Yes
tipo	enumeração	Tipo de recorrência semanal. Valores possíveis: `Weekly`	Yes

WorkflowAçãoSaídaItemRecurso

Nome	Tipo	Description	Obrigatório
action_id	cadeia (de caracteres)	Identificador único para a ação.	Yes
tipo	cadeia (de caracteres)	O tipo de ação CSDL (por exemplo, 'SetVariable', 'InvokeAzureAgent').	Yes
parent_action_id	cadeia (de caracteres)	ID da ação pai se esta for uma ação aninhada.	Não
previous_action_id	cadeia (de caracteres)	ID da ação anterior se esta ação seguir outra.	Não
estado	enumeração	Estado da ação (ex.: 'in_progress', 'concluído', 'falhado', 'cancelado'). Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`	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	Predefinido
tipo	enumeração	Valores possíveis: `workflow`	Yes
fluxo de trabalho	cadeia (de caracteres)	A definição CSDL YAML do fluxo de trabalho.	Não

número inteiro

Tipo: inteiro

Formato: int64

Feedback

Esta página foi útil?

Last updated on 2026-02-28

Partilhar via

Referência REST do Microsoft Foundry Project

Agentes - criar agente

Parâmetros de URI

Cabeçalho da solicitação

Órgão do Pedido

Respostas

Agentes - agentes de lista

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Agentes - arranja agente

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Agentes - agente de atualização

Parâmetros de URI

Cabeçalho da solicitação

Órgão do Pedido

Respostas

Agentes - agente de exclusão

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Agentes - atualizar agente a partir do manifesto

Parâmetros de URI

Cabeçalho da solicitação

Órgão do Pedido

Respostas

Agentes - listar agentes operações de contentores

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Agentes - get agent operação de contentor

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Agentes - criar a versão do agente

Parâmetros de URI

Cabeçalho da solicitação

Órgão do Pedido

Respostas

Agentes - versões de agentes listados

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Agentes - obter a versão de agente

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Agentes - eliminar a versão do agente

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Agentes - obter um contentor de agente

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Agentes - listar as operações de contentor da versão do agente

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Agentes - contentor de apagar agentes

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Agentes - contentor de agente inicial

Parâmetros de URI

Cabeçalho da solicitação

Órgão do Pedido

Respostas

Agentes - contentor de agente de paragem

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Agentes - contentor de agentes de atualização

Parâmetros de URI

Cabeçalho da solicitação

Órgão do Pedido

Respostas