Referência REST do Projeto do Microsoft Foundry

Versão da 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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
definição	objeto		Yes
└─ tipo	AgentKind		Não
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).	Não
descrição	cadeia	Uma descrição legível por humanos do agente.	Não
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia	O nome exclusivo que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve iniciar e terminar com caracteres alfanuméricos, - Pode conter hifens no meio - Não deve exceder 63 caracteres.	Yes

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agentes – listar agentes

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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
variante	consulta	Não		Filtrar agentes por tipo. Se não for fornecido, todos os agentes serão devolvidos.
limit	consulta	Não	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
ordem	consulta	Não	cadeia Valores possíveis: asc, desc	Classificar a ordem pelo carimbo de data/hora created_at dos objetos. asc para ordem crescente edesc para ordem decrescente.
after	consulta	Não	cadeia	Um cursor para uso na paginação. after é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A próxima chamada pode incluir o parâmetro after=obj_foo para buscar a próxima página da lista.
before	consulta	Não	cadeia	Um cursor para uso na paginação. before é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada seguinte pode incluir before=obj_foo para buscar a página anterior da lista.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	objeto	Os dados de resposta de uma lista solicitada de itens.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agentes – obter agente

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

Recupera o agente.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
agent_name	caminho	Yes	cadeia	O nome do agente a ser recuperado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agentes – atualizar agente

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

Atualiza o agente adicionando uma nova versão se houver alguma alteração na definição do agente. Se nenhuma alteração, retorna a versão existente do agente.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
agent_name	caminho	Yes	cadeia	O nome do agente a ser recuperado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
definição	objeto		Yes
└─ tipo	AgentKind		Não
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).	Não
descrição	cadeia	Uma descrição legível por humanos do agente.	Não
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agentes – excluir agente

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

Exclui um agente.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
agent_name	caminho	Yes	cadeia	O nome do agente a ser excluído.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agentes – atualizar o agente do manifesto

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
agent_name	caminho	Yes	cadeia	O nome do agente a ser atualizado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	Uma descrição legível por humanos do agente.	Não
manifest_id	cadeia	A ID do manifesto da qual importar a versão do agente.	Yes
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
parameter_values	objeto	As entradas para o manifesto que resultarão em um Agente totalmente materializado.	Yes

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

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

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

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

Parâmetros de URI

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

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	objeto	Os dados de resposta de uma lista solicitada de itens.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

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

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
agent_name	caminho	Yes	cadeia	O nome do agente.
operation_id	caminho	Yes	cadeia	A ID da operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agentes – criar 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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
agent_name	caminho	Yes	cadeia	O nome exclusivo que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve iniciar e terminar com caracteres alfanuméricos, - Pode conter hifens no meio - Não deve exceder 63 caracteres.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
definição	objeto		Yes
└─ tipo	AgentKind		Não
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).	Não
descrição	cadeia	Uma descrição legível por humanos do agente.	Não
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agentes – listar versões do agente

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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
agent_name	caminho	Yes	cadeia	O nome do agente para o qual recuperar versões.
limit	consulta	Não	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
ordem	consulta	Não	cadeia Valores possíveis: asc, desc	Classificar a ordem pelo carimbo de data/hora created_at dos objetos. asc para ordem crescente edesc para ordem decrescente.
after	consulta	Não	cadeia	Um cursor para uso na paginação. after é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A próxima chamada pode incluir o parâmetro after=obj_foo para buscar a próxima página da lista.
before	consulta	Não	cadeia	Um cursor para uso na paginação. before é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada seguinte pode incluir before=obj_foo para buscar a página anterior da lista.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	objeto	Os dados de resposta de uma lista solicitada de itens.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agentes – obter a versão do 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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
agent_name	caminho	Yes	cadeia	O nome do agente a ser recuperado.
agent_version	caminho	Yes	cadeia	A versão do agente a ser recuperada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agentes – excluir 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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
agent_name	caminho	Yes	cadeia	O nome do agente a ser excluído.
agent_version	caminho	Yes	cadeia	A versão do agente a ser excluída

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agentes – obter contêiner do agente

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
agent_name	caminho	Yes	cadeia	O nome do agente.
agent_version	caminho	Yes	cadeia	A versão do agente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

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

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

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

Parâmetros de URI

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

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	objeto	Os dados de resposta de uma lista solicitada de itens.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agentes – excluir contêiner do agente

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
agent_name	caminho	Yes	cadeia	O nome do agente.
agent_version	caminho	Yes	cadeia	A versão do agente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de status: 202

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agentes – iniciar contêiner do agente

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
agent_name	caminho	Yes	cadeia	O nome do agente.
agent_version	caminho	Yes	cadeia	A versão do agente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

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

Respostas

Código de status: 202

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agentes – interromper contêiner do agente

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
agent_name	caminho	Yes	cadeia	O nome do agente.
agent_version	caminho	Yes	cadeia	A versão do agente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de status: 202

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agentes – atualizar contêiner do agente

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
agent_name	caminho	Yes	cadeia	O nome do agente.
agent_version	caminho	Yes	cadeia	A versão do agente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

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

Respostas

Código de status: 202

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

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

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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
agent_name	caminho	Yes	cadeia	O nome exclusivo que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve iniciar e terminar com caracteres alfanuméricos, - Pode conter hifens no meio - Não deve exceder 63 caracteres.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	Uma descrição legível por humanos do agente.	Não
manifest_id	cadeia	A ID do manifesto da qual importar a versão do agente.	Yes
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
parameter_values	objeto	As entradas para o manifesto que resultarão em um Agente totalmente materializado.	Yes

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agentes – criar agente a partir do manifesto

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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	Uma descrição legível por humanos do agente.	Não
manifest_id	cadeia	A ID do manifesto da qual importar a versão do agente.	Yes
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia	O nome exclusivo que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve iniciar e terminar com caracteres alfanuméricos, - Pode conter hifens no meio - Não deve exceder 63 caracteres.	Yes
parameter_values	objeto	As entradas para o manifesto que resultarão em um Agente totalmente materializado.	Yes

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Conexõ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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
tipo de conexão	consulta	Não		Listar conexões desse tipo específico
defaultConnection	consulta	Não	boolean	Listar conexões que são conexões padrão
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Conexõ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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome amigável da conexão, fornecido pelo usuário.
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Conexõ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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome amigável da conexão, fornecido pelo usuário.
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Conjuntos de dados – listar 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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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 retornará o erro 404 Not Found se o DatasetVersion não existir.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A ID de versão específica do DatasetVersion a ser recuperada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Conjuntos de dados – excluir versão

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A versão do DatasetVersion a ser excluída.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de status: 204

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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 ou atualizar um DatasetVersion existente com a ID de versão fornecida

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A ID de versão específica do DatasetVersion a ser criado ou atualizado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	O texto de descrição do ativo.	Não
tags	objeto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não
tipo	objeto	Enumerar para determinar o tipo de dados.	Yes

Respostas

Código de Status: 200

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

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

Código de status: 201

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Conjuntos de dados – obter 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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A ID de versão específica do DatasetVersion a ser operado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AssetCredentialResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

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

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A ID de versão específica do DatasetVersion a ser operado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

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

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Implantações – lista

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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
modelPublisher	consulta	Não	cadeia	Editor de modelos para filtrar modelos por
modelName	consulta	Não	cadeia	Nome do modelo (o nome específico do editor) para filtrar modelos por
deploymentType	consulta	Não		Tipo de implantação para filtrar a lista por
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Implantações – obter

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

Obtém um modelo implantado.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	Nome da implantação
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	Implantação

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Regras de avaliação – lista

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

Liste todas as regras de avaliação.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
actionType	consulta	Não		Filtre pelo tipo de regra de avaliação.
nome_do_agente	consulta	Não	cadeia	Filtre pelo nome do agente.
enabled	consulta	Não	boolean	Filtre pelo status ativado.
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	PagedEvaluationRule

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
id	caminho	Yes	cadeia	Identificador exclusivo para a regra de avaliação.
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	EvaluationRule

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Regras de avaliação – excluir

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

Exclua uma regra de avaliação.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
id	caminho	Yes	cadeia	Identificador exclusivo para a regra de avaliação.
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de status: 204

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
id	caminho	Yes	cadeia	Identificador exclusivo para a regra de avaliação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
ação	objeto	Modelo de ação de avaliação.	Yes
└─ tipo	EvaluationRuleActionType	Tipo de ação de avaliação.	Não
descrição	cadeia	Descrição da regra de avaliação.	Não
nome de exibição	cadeia	Nome de exibição da regra de avaliação.	Não
enabled	boolean	Indica se a regra de avaliação está habilitada. O padrão é true.	Yes
eventType	objeto	Tipo do evento de regra de avaliação.	Yes
filtro	objeto	Modelo de filtro de avaliação.	Não
└─ agentName	cadeia	Filtre por nome do agente.	Não
id	cadeia	Identificador exclusivo para a regra de avaliação.	Yes
dados do sistema	objeto	Metadados do sistema para a regra de avaliação.	Yes

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	EvaluationRule

Código de status: 201

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	EvaluationRule

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
inputName	consulta	Não	cadeia	Filtre pelo nome da entrada de avaliação.
inputType	consulta	Não	cadeia	Filtre por tipo de entrada de taxonomia.
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	PagedEvaluationTaxonomy

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Taxonomias de avaliação – get

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

Obtenha uma avaliação executada por nome.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	EvaluationTaxonomy

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Taxonomias de avaliação – excluir

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

Exclua uma taxonomia de avaliação por nome.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de status: 204

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome da taxonomia de avaliação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	O texto de descrição do ativo.	Não
propriedades	objeto	Propriedades adicionais para a taxonomia de avaliação.	Não
tags	objeto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não
taxonomyCategories	matriz	Lista de categorias de taxonomia.	Não
taxonomyInput	objeto	Configuração de entrada para a taxonomia de avaliação.	Yes
└─ tipo	EvaluationTaxonomyInputType	Tipo de entrada da taxonomia de avaliação.	Não

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	EvaluationTaxonomy

Código de status: 201

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	EvaluationTaxonomy

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome da taxonomia de avaliação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	O texto de descrição do ativo.	Não
propriedades	objeto	Propriedades adicionais para a taxonomia de avaliação.	Não
tags	objeto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não
taxonomyCategories	matriz	Lista de categorias de taxonomia.	Não
taxonomyInput	objeto	Configuração de entrada para a taxonomia de avaliação.	Não
└─ tipo	EvaluationTaxonomyInputType	Tipo de entrada da taxonomia de avaliação.	Não

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	EvaluationTaxonomy

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Avaliadores – listar versões mais recentes

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

Liste a versão mais recente de cada avaliador

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
tipo	consulta	Não		Filtre os avaliadores por tipo. Valores possíveis: 'all', 'custom', 'builtin'.
limit	consulta	Não	inteiro	Um limite no número de objetos a serem retornados. "Limit" pode variar entre 1 e 100 e o padrão é 20.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Avaliadores – listar versões

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

Listar todas as versões do avaliador fornecido

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso
tipo	consulta	Não		Filtre os avaliadores por tipo. Valores possíveis: 'all', 'custom', 'builtin'.
limit	consulta	Não	inteiro	Um limite no número de objetos a serem retornados. "Limit" pode variar entre 1 e 100 e o padrão é 20.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Avaliadores – criar versão

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
categories	matriz	As categorias do avaliador	Yes
definição	objeto	Configuração do avaliador base com discriminador	Yes
└─ data_schema		O esquema JSON (rascunho 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 (Rascunho 2020-12) para os parâmetros de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	Não
└─ métricas	objeto	Lista de métricas de saída produzidas por este avaliador	Não
└─ tipo	EvaluatorDefinitionType	O tipo de definição do avaliador	Não
descrição	cadeia	O texto de descrição do ativo.	Não
display_name	cadeia	Nome de exibição para o avaliador. Ele ajuda a localizar o avaliador facilmente na Foundry. Não precisa ser único.	Não
evaluator_type	objeto	O tipo de avaliador	Yes
metadados	objeto	Metadados sobre o avaliador	Não
tags	objeto	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 um novo recurso foi criado como resultado.

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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 retornará o erro 404 Not Found se o EvaluatorVersion não existir.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A ID de versão específica do EvaluatorVersion a ser recuperado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Avaliadores – excluir 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 retornará 204 Sem Conteúdo se o EvaluatorVersion foi excluído com êxito ou se o EvaluatorVersion não existe.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A versão do EvaluatorVersion a ser excluída.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de status: 204

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Avaliadores – versão de atualização

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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A versão do EvaluatorVersion a ser atualizada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
categories	matriz	As categorias do avaliador	Não
descrição	cadeia	O texto de descrição do ativo.	Não
display_name	cadeia	Nome de exibição para o avaliador. Ele ajuda a localizar o avaliador facilmente na Foundry. Não precisa ser único.	Não
metadados	objeto	Metadados sobre o avaliador	Não
tags	objeto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Índices – listar 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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Índices – listar versões

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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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 retornará o erro 404 Not Found se o índice não existir.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A ID de versão específica do Índice a ser recuperada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	Index

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Índices – excluir 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 retornará 204 Sem Conteúdo se o Índice tiver sido excluído com êxito ou se o Índice não existir.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A versão do Índice a ser excluída.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de status: 204

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Índices – criar ou atualizar a versão

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do recurso
versão	caminho	Yes	cadeia	A ID de versão específica do Índice a ser criado ou atualizado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	O texto de descrição do ativo.	Não
tags	objeto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não
tipo	objeto		Yes

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	Index

Código de status: 201

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	Index

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
Repetibilidade-Request-ID	cabeçalho	Não	cadeia	Identificador exclusivo gerado pelo cliente para garantir a idempotência da solicitação. Use a mesma ID para novas tentativas para evitar avaliações duplicadas.
Repetibilidade-First-Sent	cabeçalho	Não	cadeia	Carimbo de data/hora que indica quando essa solicitação foi iniciada pela primeira vez. Usado em conjunto com repeatability-request-id para controle de idempotência.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nome de exibição	cadeia	Nome de exibição amigável para o insight.	Yes
id	cadeia	O identificador exclusivo do relatório de insights.	Yes
metadados	objeto	Metadados sobre os insights.	Yes
└─ concluído At	cadeia	O carimbo de data/hora em que os insights foram concluídos.	Não
└─ criadoAt	cadeia	O carimbo de data/hora em que os insights foram criados.	Não
solicitação	objeto	A solicitação do relatório de insights.	Yes
└─ tipo	InsightType	O tipo de solicitação.	Não
resultado	objeto	O resultado dos insights.	Não
└─ tipo	InsightType	O tipo de resultado de insights.	Não
estado	objeto	Enumeração que descreve os estados de operação permitidos.	Yes

Respostas

Código de status: 201

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	Perspicácia

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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 recentes primeiro).

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
tipo	consulta	Não		Filtre pelo tipo de análise.
evalId	consulta	Não	cadeia	Filtre pela ID de avaliação.
runId	consulta	Não	cadeia	Filtre pela ID da execução de avaliação.
nome_do_agente	consulta	Não	cadeia	Filtre pelo nome do agente.
includeCoordinates	consulta	Não	boolean	Se as coordenadas para visualização devem ser incluídas na resposta. O padrão é false.
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Insights – 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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
id	caminho	Yes	cadeia	O identificador exclusivo do relatório de insights.
includeCoordinates	consulta	Não	boolean	Se as coordenadas para visualização devem ser incluídas na resposta. O padrão é false.
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	Perspicácia

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Criar repositório 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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
definição	objeto	Definição de base para configurações de armazenamento de memória.	Yes
└─ tipo	MemoryStoreKind	O tipo de armazenamento de memória.	Não
descrição	cadeia	Uma descrição legível do armazenamento de memória.	Não
metadados	objeto	Metadados de valor-chave arbitrários a serem associados ao repositório de memória.	Não
nome	cadeia	O nome do repositório de memória.	Yes

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Listar repositórios 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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
limit	consulta	Não	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
ordem	consulta	Não	cadeia Valores possíveis: asc, desc	Classificar a ordem pelo carimbo de data/hora created_at dos objetos. asc para ordem crescente edesc para ordem decrescente.
after	consulta	Não	cadeia	Um cursor para uso na paginação. after é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A próxima chamada pode incluir o parâmetro after=obj_foo para buscar a próxima página da lista.
before	consulta	Não	cadeia	Um cursor para uso na paginação. before é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada seguinte pode incluir before=obj_foo para buscar a página anterior da lista.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	objeto	Os dados de resposta de uma lista solicitada de itens.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Atualizar o repositório 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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do repositório de memória a ser atualizado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	Uma descrição legível do armazenamento de memória.	Não
metadados	objeto	Metadados de valor-chave arbitrários a serem associados ao repositório de memória.	Não

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Obter repositório de 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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do repositório de memória a ser recuperado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Excluir repositório 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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do repositório de memória a ser excluído.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Obter 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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do repositório de memória.
update_id	caminho	Yes	cadeia	A ID da operação de atualização de memória.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Excluir memórias de escopo

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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do repositório de memória.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
escopo	cadeia	O namespace que agrupa e isola logicamente as memórias a serem excluídas, como uma ID de usuário.	Yes

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Pesquisar memórias

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do repositório de memória a ser pesquisado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

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

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	O nome do repositório de memória a ser atualizado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
items	matriz	Itens de conversa dos quais extrair memórias.	Não
previous_update_id	cadeia	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
escopo	cadeia	O namespace que agrupa e isola logicamente as memórias, como um ID do usuário.	Yes
update_delay	inteiro	Período de tempo limite antes de processar a atualização de memória em segundos. Se uma nova solicitação de atualização for recebida durante esse período, ela cancelará a solicitação atual e redefinirá o tempo limite. Defina como 0 para disparar imediatamente a atualização sem atrasos. O padrão é 300 (5 minutos).	Não	300

Respostas

Código de status: 202

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Criar conversa

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

Crie uma conversa.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
items	matriz	Itens iniciais para incluir o contexto da conversa. Você pode adicionar até 20 itens por vez.	Não
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Listar conversas

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

Retorna a lista de todas as conversas.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
limit	consulta	Não	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
ordem	consulta	Não	cadeia Valores possíveis: asc, desc	Classificar a ordem pelo carimbo de data/hora created_at dos objetos. asc para ordem crescente edesc para ordem decrescente.
after	consulta	Não	cadeia	Um cursor para uso na paginação. after é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A próxima chamada pode incluir o parâmetro after=obj_foo para buscar a próxima página da lista.
before	consulta	Não	cadeia	Um cursor para uso na paginação. before é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada seguinte pode incluir before=obj_foo para buscar a página anterior da lista.
agent_name	consulta	Não	cadeia	Filtre por nome do agente. Se fornecido, somente os itens associados ao agente especificado serão retornados.
agent_id	consulta	Não	cadeia	Filtrar por ID do agente no formato name:version. Se fornecido, somente os itens associados à ID do agente especificado serão retornados.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	objeto	Os dados de resposta de uma lista solicitada de itens.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Atualizar conversa

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

Atualize uma conversa.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
conversation_id	caminho	Yes	cadeia	A ID da conversa a ser atualizada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Obter conversa

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

Recupera uma conversa.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
conversation_id	caminho	Yes	cadeia	A ID da conversa a ser recuperada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Excluir conversa

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

Exclui uma conversa.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
conversation_id	caminho	Yes	cadeia	A ID da conversa a ser excluída.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.DeletedConversationResource

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Criar itens de conversa

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

Crie itens em uma conversa com a ID fornecida.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
conversation_id	caminho	Yes	cadeia	A ID da conversa na qual o item precisa ser criado.
incluir	consulta	Não	matriz	Campos adicionais a serem incluídos na resposta. Consulte o include parâmetro para listar itens de conversa para obter mais informações.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
items	matriz	Os itens a serem adicionados à conversa. Você pode adicionar até 20 itens por vez.	Yes

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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 a ID fornecida.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
conversation_id	caminho	Yes	cadeia	A ID da conversa na qual os itens precisam ser listados.
limit	consulta	Não	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
ordem	consulta	Não	cadeia Valores possíveis: asc, desc	Classificar a ordem pelo carimbo de data/hora created_at dos objetos. asc para ordem crescente edesc para ordem decrescente.
after	consulta	Não	cadeia	Um cursor para uso na paginação. after é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A próxima chamada pode incluir o parâmetro after=obj_foo para buscar a próxima página da lista.
before	consulta	Não	cadeia	Um cursor para uso na paginação. before é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada seguinte pode incluir before=obj_foo para buscar a página anterior da lista.
item_type	consulta	Não		Filtrar por tipo de item. Se fornecido, somente itens do tipo especificado serão retornados.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	objeto	Os dados de resposta de uma lista solicitada de itens.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Obter item 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 as IDs fornecidas.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
conversation_id	caminho	Yes	cadeia	A ID da conversa que contém o item.
item_id	caminho	Yes	cadeia	A ID do item de conversa a ser recuperado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Excluir item de conversa

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

Exclua um item de uma conversa com as IDs fornecidas.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
conversation_id	caminho	Yes	cadeia	A ID da conversa da qual o item precisa ser excluído.
item_id	caminho	Yes	cadeia	A ID do item de conversa a ser excluído.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Valores do OpenAI – listar valores

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
after	consulta	Não	cadeia	Identificador da última execução da solicitação de paginação anterior.
limit	consulta	Não		Número de execuções a serem recuperadas.
ordem	consulta	Não	cadeia Valores possíveis: asc, desc	Ordem de classificação das execuções por carimbo de data/hora. Use asc para ordem crescente ou desc para ordem decrescente. Usa asc como padrão.
ordenar_por	consulta	Não	cadeia Valores possíveis: created_at, updated_at	Os valores podem ser ordenados por hora de criação ou hora da última atualização. Utilização created_at para a hora de criação ou updated_at para a hora da última atualização.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	objeto	Os dados de resposta de uma lista solicitada de itens.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Valores do OpenAI – criar a avaliação

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
configuração_da_fonte_de_dados	objeto	Um objeto CustomDataSourceConfig que define o esquema da fonte de dados usada para as execuções de avaliação. Esse esquema é usado para definir a forma dos dados que serão: - Usado para definir seus critérios de teste e - Quais dados são necessários ao criar uma execução	Yes
├─ incluir_esquema_exemplo	boolean	Se a avaliação deve esperar que você preencha o namespace de exemplo (ou seja, gerando respostas a partir da sua fonte de dados)	Não
└─ esquema_de_item	objeto	O esquema json para cada linha na fonte de dados.	Não
└─ metadados	objeto	Filtros de metadados da fonte de dados de conclusões armazenadas.	Não
Cenário └─	enumeração	Cenário de esquema de dados. Valores possíveis: red_team, , responsestraces	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. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia	O nome da avaliação.	Não
propriedades	objeto	Conjunto de 16 pares chave-valor imutáveis que podem ser anexados a um objeto para armazenar informações adicionais. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
critérios_de_teste	matriz	Uma lista de avaliadores 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 referenciar a saída do modelo, use o namespace sample (ou seja, {{sample.output_text}}).	Yes

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Valores do OpenAI – excluir a avaliação

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
eval_id	caminho	Yes	cadeia	A ID da avaliação a ser excluída.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Avaliações do OpenAI – obter a avaliação

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
eval_id	caminho	Yes	cadeia	A ID da avaliação a ser recuperada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Avaliações do OpenAI – atualizar a avaliação

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
eval_id	caminho	Yes	cadeia	A ID da avaliação a ser atualizada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia		Não
propriedades	objeto	Conjunto de 16 pares chave-valor imutáveis que podem ser anexados a um objeto para armazenar informações adicionais. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Avaliações do OpenAI – execuções de lista

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
eval_id	caminho	Yes	cadeia	A ID da avaliação para a qual recuperar as execuções.
after	consulta	Não	cadeia	Identificador da última execução da solicitação de paginação anterior.
limit	consulta	Não		Número de execuções a serem recuperadas.
ordem	consulta	Não	cadeia Valores possíveis: asc, desc	Ordem de classificação das execuções por carimbo de data/hora. Use asc para ordem crescente ou desc para ordem decrescente. Usa asc como padrão.
status	consulta	Não	cadeia 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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	objeto	Os dados de resposta de uma lista solicitada de itens.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

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

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

Criar execução de avaliação

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
eval_id	caminho	Yes	cadeia	A ID da avaliação para a qual criar uma execução.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
fonte_de_dados	objeto	Um objeto JsonlRunDataSource com o qual especifica um arquivo JSONL que corresponde à avaliação	Yes
└─ mensagens_de_entrada	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate ou OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Usado durante a amostragem de um modelo. Determina a estrutura das mensagens passadas para o modelo. Pode ser uma referência a uma trajetória predefinida (ou seja, item.input_trajectory) ou a um modelo com referências variáveis ao item namespace.	Não
└─ item_generation_params	RedTeamItemGenerationParams	Os parâmetros para a geração de itens.	Não
└─ modelo	cadeia	O nome do modelo a ser usado para gerar conclusões (por exemplo, "o3-mini").	Não
└─ parâmetros_de_amostragem	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Não
└─ origem	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource ou OpenAI.EvalResponsesSource	Determina o que preenche o item namespace na fonte de dados dessa execução.	Não
└─ destino	Target (destino)	A configuração de destino para a avaliação.	Não
└─ tipo	cadeia	O tipo de fonte de dados discriminatório.	Não
metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia	O nome da execução.	Não
propriedades	objeto	Conjunto de 16 pares chave-valor imutáveis que podem ser anexados a um objeto para armazenar informações adicionais. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

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

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
eval_id	caminho	Yes	cadeia	A ID da avaliação da qual excluir a execução.
run_id	caminho	Yes	cadeia	A ID da execução a ser excluída.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

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

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
eval_id	caminho	Yes	cadeia	A ID da avaliação para a qual recuperar as execuções.
run_id	caminho	Yes	cadeia	A ID da execução a ser recuperada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

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

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
eval_id	caminho	Yes	cadeia	A ID da avaliação cuja execução você deseja cancelar.
run_id	caminho	Yes	cadeia	A ID da execução a ser cancelada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Valores do OpenAI – obter itens de saída de execução de avaliação

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
eval_id	caminho	Yes	cadeia
run_id	caminho	Yes	cadeia	A ID da execução para a qual recuperar itens de saída.
after	consulta	Não	cadeia	Identificador da última execução da solicitação de paginação anterior.
limit	consulta	Não		Número de execuções a serem recuperadas.
ordem	consulta	Não	cadeia Valores possíveis: asc, desc	Ordem de classificação das execuções por carimbo de data/hora. Use asc para ordem crescente ou desc para ordem decrescente. Usa asc como padrão.
status	consulta	Não	cadeia Valores possíveis: fail, pass	Filtrar itens de saída por status. Usar failed para filtrar por saída com falha itens ou pass para filtrar por itens de saída passados.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	objeto	Os dados de resposta de uma lista solicitada de itens.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Valores do OpenAI – obter o item de saída de execução de 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 Obter um item de saída de execução de avaliação por ID.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
eval_id	caminho	Yes	cadeia	A ID da avaliação para a qual recuperar as execuções.
run_id	caminho	Yes	cadeia	A ID da execução a ser recuperada.
output_item_id	caminho	Yes	cadeia	A ID do item de saída a ser recuperado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Criar um trabalho de ajuste fino

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 do trabalho enfileirado, incluindo o status do trabalho e o nome dos modelos ajustados após a conclusão.

Saiba mais sobre ajuste fino

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
hiperparâmetros	objeto	Os hiperparâmetros usados no trabalho de ajuste fino. Agora, esse valor foi preterido em favor de method, e deve ser passado sob o parâmetro method.	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 habilitar seu trabalho de ajuste fino.	Não
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
método	OpenAI.FineTuneMethod	O método usado no ajuste fino.	Não
modelo	cadeia de caracteres (veja os modelos válidos abaixo)	O nome do modelo a ser refinado. Você pode selecionar um dos modelos com suporte.	Yes
seed	inteiro	A semente controla a reprodutibilidade do trabalho. Passar os mesmos parâmetros iniciais e de trabalho deve produzir os mesmos resultados, mas pode diferir em casos raros. Se uma semente não for especificada, uma será gerada para você.	Não
sufixo	cadeia	Uma cadeia de caracteres de até 64 caracteres que será adicionada ao seu nome de modelo ajustado. Por exemplo, um suffix "custom-model-name" produz um nome de modelo como ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.	Não	Nenhum
arquivo_de_treinamento	cadeia	A ID de um arquivo carregado que contém os dados de treinamento. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Além disso, você deve carregar seu arquivo com a finalidade fine-tune. O conteúdo do arquivo deve diferir dependendo se o modelo usa o formato de chat, conclusões 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
arquivo_de_validação	cadeia	A ID de um arquivo carregado que contém os dados de validação. Se você fornecer esse arquivo, os dados serão usados para gerar validação métricas periódicas durante o ajuste fino. Essas métricas podem ser exibidas em o arquivo de resultados de ajuste fino. Os mesmos dados não devem estar presentes nos arquivos de treinamento e validação. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Você deve carregar seu arquivo com a finalidade fine-tune. Consulte o guia de ajuste fino para obter mais detalhes.	Não

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Listar trabalhos de ajuste fino paginado

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
after	consulta	Não	cadeia	Identificador do último trabalho da solicitação de paginação anterior.
limit	consulta	Não	inteiro	Número de trabalhos de ajuste fino a serem recuperados.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Recuperar trabalho de ajuste fino

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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Cancelar o trabalho de ajuste fino

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

Cancele imediatamente um trabalho de ajuste fino.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino a ser cancelado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

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

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino para o qual obter pontos de verificação.
after	consulta	Não	cadeia	Identificador da última ID do ponto de verificação da solicitação de paginação anterior.
limit	consulta	Não	inteiro	Número de pontos de verificação a serem recuperados.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Listar eventos de trabalho de ajuste fino

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino para o qual obter eventos.
after	consulta	Não	cadeia	Identificador do último evento da solicitação de paginação anterior.
limit	consulta	Não	inteiro	Número de eventos a serem recuperados.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Pausar o trabalho de ajuste fino

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino a ser pausado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Retomar o trabalho de ajuste fino

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

Retomar uma tarefa de ajuste fino pausada.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino a ser retomado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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 de modelo (resposta de streaming).

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Não	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
agente	AgentReference	O agente a ser usado para gerar a resposta.	Não
em segundo plano	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas em segundo plano.	Não	Falso
conversa	cadeia de caracteres ou objeto		Não
incluir	matriz	Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Atualmente os valores com suporte são: - code_interpreter_call.outputs: inclui as saídas da execução de código python nos itens de chamada de ferramenta de interpretador de código. - computer_call_output.output.image_url: inclua urls de imagem da saída da chamada do computador. - file_search_call.results: incluir os resultados da pesquisa de a chamada da ferramenta de pesquisa de arquivos. - message.input_image.image_url: inclua urls de imagem da mensagem de entrada. - message.output_text.logprobs: inclua os logprobs com mensagens de assistente. - reasoning.encrypted_content: inclui uma versão criptografada do raciocínio tokens em saídas de item de raciocínio. Isso permite que itens de raciocínio sejam usados em conversas de vários turnos ao usar a API de Respostas sem estado (como quando o parâmetro store é definido como false, ou quando uma organização é registrado no programa de retenção de dados zero).	Não
entrada	cadeia de caracteres ou matriz	Entradas de texto, imagem ou arquivo para o modelo, usadas para gerar uma resposta. Saiba mais: - Entradas e saídas de texto - Entradas de imagem - Entradas de arquivo - Gerenciando o estado da conversa - Chamada de função	Não
instructions	cadeia	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao usar junto com previous_response_id, as instruções de uma resposta A resposta não será transferida para a próxima resposta. Isso torna simples para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.	Não
max_output_tokens	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	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	Não
parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
previous_response_id	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. Saiba mais sobre gerenciando o estado da conversa.	Não
solicitação	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis. Saiba mais.	Não
reasoning	OpenAI.Reasoning	somente modelos da série o Opções de configuração para modelos de raciocínio.	Não
nível de serviço	OpenAI.ServiceTier	Observação: service_tier não é aplicável ao Azure OpenAI.	Não
armazenar	boolean	Se deseja armazenar a resposta do modelo gerado para recuperação posterior via API.	Não	Verdade
fluxo	boolean	Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente como ele é gerado usando eventos enviados pelo servidor. para obter mais informações.	Não	Falso
structured_inputs	objeto	As entradas estruturadas para a resposta que podem participar de substituição de modelo de prompt ou associações de argumento de ferramenta.	Não
temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou top_p, mas não as duas coisas.	Não	1
enviar SMS	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples 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 internas: ferramentas fornecidas pelo OpenAI que estendem o capacidades do modelo, como busca de arquivos - Chamadas de função (ferramentas personalizadas): funções definidas por você, permitindo que o modelo chame seu próprio código.	Não
top_logprobs	inteiro	Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada.	Não
top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa apenas os tokens que compõem os 10% superiores da massa de probabilidade%. são considerados. Geralmente recomendamos alterar isso ou temperature, mas não as duas coisas.	Não	1
truncation	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - auto: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - disabled (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: auto, disabled	Não
usuário	cadeia	Saiba mais sobre as práticas recomendadas de segurança.	Não

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/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	Tipo	Descrição
aplicativo/json	ApiErrorResponse

Listar respostas

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

Retorna a lista de todas as respostas.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
limit	consulta	Não	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
ordem	consulta	Não	cadeia Valores possíveis: asc, desc	Classificar a ordem pelo carimbo de data/hora created_at dos objetos. asc para ordem crescente edesc para ordem decrescente.
after	consulta	Não	cadeia	Um cursor para uso na paginação. after é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A próxima chamada pode incluir o parâmetro after=obj_foo para buscar a próxima página da lista.
before	consulta	Não	cadeia	Um cursor para uso na paginação. before é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada seguinte pode incluir before=obj_foo para buscar a página anterior da lista.
agent_name	consulta	Não	cadeia	Filtre por nome do agente. Se fornecido, somente os itens associados ao agente especificado serão retornados.
agent_id	consulta	Não	cadeia	Filtrar por ID do agente no formato name:version. Se fornecido, somente os itens associados à ID do agente especificado serão retornados.
conversation_id	consulta	Não	cadeia	Filtrar por ID da conversa. Se fornecido, somente as respostas associadas à conversa especificada serão retornadas.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	objeto	Os dados de resposta de uma lista solicitada de itens.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Obter resposta – obter fluxo de resposta

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

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

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Não	cadeia	A versão da API a ser usada para esta operação.
response_id	caminho	Yes	cadeia
include[]	consulta	Não	matriz
fluxo	consulta	Não	boolean
starting_after	consulta	Não	inteiro
aceitar	cabeçalho	Não	cadeia Valores possíveis: text/event-stream

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/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	Tipo	Descrição
aplicativo/json	ApiErrorResponse

Excluir resposta

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

Exclui uma resposta de modelo.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
response_id	caminho	Yes	cadeia	A ID da resposta a ser excluída.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
response_id	caminho	Yes	cadeia	A ID da resposta a ser cancelada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
response_id	caminho	Yes	cadeia
limit	consulta	Não	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
ordem	consulta	Não	cadeia Valores possíveis: asc, desc	Classificar a ordem pelo carimbo de data/hora created_at dos objetos. asc para ordem crescente edesc para ordem decrescente.
after	consulta	Não	cadeia	Um cursor para uso na paginação. after é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A próxima chamada pode incluir o parâmetro after=obj_foo para buscar a próxima página da lista.
before	consulta	Não	cadeia	Um cursor para uso na paginação. before é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada seguinte pode incluir before=obj_foo para buscar a página anterior da lista.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	objeto	Os dados de resposta de uma lista solicitada de itens.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/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	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Redteams - get

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

Obtenha uma equipe vermelha pelo nome.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
nome	caminho	Yes	cadeia	Identificador da corrida da equipe vermelha.
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Redteams – criar

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

Cria uma execução de equipe vermelha.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
applicationScenario	cadeia	Cenário de aplicação para a operação red team, para gerar ataques específicos do cenário.	Não
attackStrategies	matriz	Lista de estratégias de ataque ou listas aninhadas de estratégias de ataque.	Não
nome de exibição	cadeia	Nome da corrida da equipe vermelha.	Não
id	cadeia	Identificador da corrida da equipe vermelha.	Yes
numTurns	inteiro	Número de rodadas de simulação.	Não
propriedades	objeto	Propriedades da equipe vermelha. Ao contrário das marcas, as propriedades são somente suplementos. Depois de adicionada, uma propriedade não pode ser removida.	Não
riskCategories	matriz	Lista de categorias de risco para gerar objetivos de ataque.	Não
simulationOnly	boolean	Simulação apenas ou Simulação + Avaliação. Padrão false, se verdadeiro, a verificação gera a conversa, não o resultado da avaliação.	Não	Falso
status	cadeia	Status da equipe vermelha. Ele é definido pelo serviço e é somente leitura.	Não
tags	objeto	Tags da equipe vermelha. Ao contrário das propriedades, as marcas são totalmente mutáveis.	Não
destino	objeto	Classe abstrata para configuração de destino.	Yes
└─ tipo	cadeia	Tipo de configuração do modelo.	Não

Respostas

Código de status: 201

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agendas – lista

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

Liste todas as agendas.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agendamentos – excluir

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

Exclua uma agenda.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
id	caminho	Yes	cadeia	Identificador da programação.
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de status: 204

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agendas – obter

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

Obtenha um cronograma por id.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
id	caminho	Yes	cadeia	Identificador da programação.
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agendamentos – criar ou atualizar

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

Crie ou atualize um agendamento por id.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
id	caminho	Yes	cadeia	Identificador da programação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	Descrição do agendamento.	Não
nome de exibição	cadeia	Nome da agenda.	Não
enabled	boolean	Status habilitado do agendamento.	Yes
id	cadeia	Identificador da programação.	Yes
propriedades	objeto	Propriedades da tabela. Ao contrário das marcas, as propriedades são somente suplementos. Depois de adicionada, uma propriedade não pode ser removida.	Não
status de provisionamento	objeto	Agende o status de provisionamento.	Não
dados do sistema	objeto	Metadados do sistema para o recurso.	Yes
tags	objeto	Tags de agendamento. Ao contrário das propriedades, as marcas são totalmente mutáveis.	Não
tarefa	objeto	Modelo de tarefa de agendamento.	Yes
Configuração do └─	objeto	Configuração para a tarefa.	Não
└─ tipo	ScheduleTaskType	Tipo da tarefa.	Não
disparador	objeto	Modelo base para Trigger do agendamento.	Yes
└─ tipo	Tipo de gatilho	Tipo do gatilho.	Não

Respostas

Código de Status: 200

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

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

Código de status: 201

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agendas – listar execuções

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

Liste todas as execuções de agendamento.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
id	caminho	Yes	cadeia	Identificador da programação.
x-ms-client-request-id	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	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Agendamentos – obter execução

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

Obtenha um agendamento executado por id.

Parâmetros de URI

Nome	In	Obrigatório	Tipo	DESCRIÇÃO
ponto de extremidade	caminho	Yes	cadeia url	Ponto de extremidade do Projeto de Fundação no formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se você tiver apenas um Projeto em seu Hub de Fundação ou para direcionar o Projeto padrão em seu Hub, use o formulário https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
versão da API	consulta	Yes	cadeia	A versão da API a ser usada para esta operação.
scheduleId	caminho	Yes	cadeia	Identificador da programação.
runId	caminho	Yes	cadeia	Identificador da execução do agendamento.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	DESCRIÇÃO
Authorization	Verdade	cadeia	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 escopo: https://ai.azure.com/.default

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

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

Componentes

A2ATool

Um agente que implementa o protocolo A2A.

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

AISearchIndexResource

Um recurso de índice de pesquisa de IA.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
filtro	cadeia	String de filtro para o recurso de pesquisa. Saiba mais aqui.	Não
index_asset_id	cadeia	ID do ativo de índice para o recurso de pesquisa.	Não
nome_do_indice	cadeia	O nome de um índice em um IndexResource anexado a esse agente.	Não
project_connection_id	cadeia	Uma ID de conexão de índice em um IndexResource anexado a esse agente.	Não
tipo_de_consulta	objeto	Tipos de consulta disponíveis para a ferramenta Azure AI Search.	Não
top_k	inteiro	Número de documentos a serem recuperados da pesquisa e presentes no modelo.	Não

AgentClusterInsightResult

Insights da análise de cluster de agentes.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
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	DESCRIÇÃO	Obrigatório	Padrão
nome_do_agente	cadeia	Identificador do agente.	Yes
modelConfiguration	objeto	Configuração do modelo usado na geração de insights.	Não
└─ modelDeploymentName	cadeia	A implantação do modelo a ser avaliada. Aceita o nome da implantação sozinho ou com o nome da conexão como {connectionName}/<modelDeploymentName>.	Não
tipo	enumeração	O tipo de solicitação. Valores possíveis: AgentClusterInsight	Yes

AgentContainerObject

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
criado_em	cadeia	A hora de criação do contêiner.	Yes
error_message	cadeia	A mensagem de erro se o contêiner não funcionar, se houver.	Não
max_replicas	inteiro	O número máximo de réplicas para o contêiner. O padrão é UTF-1.	Não
min_replicas	inteiro	O número mínimo de réplicas para o contêiner. O padrão é UTF-1.	Não
objeto	enumeração	O tipo de objeto, que é sempre 'agent.container'. Valores possíveis: agent.container	Yes
status	objeto	Status do contêiner de uma versão específica de um agente.	Yes
updated_at	cadeia	A hora da última atualização do contêiner.	Yes

AgentContainerOperationError

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

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

AgentContainerOperationObject

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
agent_id	cadeia	A ID do agente.	Yes
agent_version_id	cadeia	A ID da versão do agente.	Yes
contêiner	objeto	Os detalhes do contêiner de uma versão específica de um agente.	Não
└─ created_at	cadeia	A hora de criação do contêiner.	Não
└─ error_message	cadeia	A mensagem de erro se o contêiner não funcionar, se houver.	Não
└─ max_replicas	inteiro	O número máximo de réplicas para o contêiner. O padrão é UTF-1.	Não
└─ min_replicas	inteiro	O número mínimo de réplicas para o contêiner. O padrão é UTF-1.	Não
└─ objeto	enumeração	O tipo de objeto, que é sempre 'agent.container'. Valores possíveis: agent.container	Não
└─ estado	AgentContainerStatus	O status do contêiner de uma versão específica de um agente.	Não
└─ updated_at	cadeia	A hora da última atualização do contêiner.	Não
erro	objeto	Os detalhes do erro da operação de contêiner, se houver.	Não
└─ código	cadeia	O código de erro da operação de contêiner, se houver.	Não
Mensagem └─	cadeia	A mensagem de erro da operação de contêiner, se houver.	Não
└─ tipo	cadeia	O tipo de erro da operação de contêiner, se houver.	Não
id	cadeia	A ID da operação de contêiner. Essa ID é um identificador exclusivo em todo o sistema.	Yes
status	objeto	Status da operação de contêiner para uma versão específica de um agente.	Yes

AgentContainerOperationStatus

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

Propriedade	Valor
Descrição	Status da operação de contêiner para uma versão específica de um agente.
Tipo	cadeia
Valores	NotStarted InProgress Succeeded Failed

AgentContainerStatus

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

Propriedade	Valor
Descrição	Status do contêiner de uma versão específica de um agente.
Tipo	cadeia
Valores	Starting Running Stopping Stopped Failed Deleting Deleted Updating

AgentDefinition

Discriminador para AgentDefinition

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

Valor do tipo	Schema
workflow	WorkflowAgentDefinition
hosted	HostedAgentDefinition
container_app	ContainerAppAgentDefinition
prompt	PromptAgentDefinition

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

AgentId

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nome	cadeia	O nome do agente.	Yes
tipo	enumeração	Valores possíveis: agent_id	Yes
versão	cadeia	O identificador de versão do agente.	Yes

AgentKind

Propriedade	Valor
Tipo	cadeia
Valores	prompt hosted container_app workflow

AgentObject

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
id	cadeia	O identificador exclusivo do agente.	Yes
nome	cadeia	O nome do agente.	Yes
objeto	enumeração	O tipo de objeto, que é sempre 'agente'. Valores possíveis: agent	Yes
versions	objeto	A versão mais recente do agente.	Yes
└─ mais recente	AgentVersionObject		Não

AgentProtocol

Propriedade	Valor
Tipo	cadeia
Valores	activity_protocol responses

Referência do agente

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nome	cadeia	O nome do agente.	Yes
tipo	enumeração	Valores possíveis: agent_reference	Yes
versão	cadeia	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	DESCRIÇÃO	Obrigatório	Padrão
riskCategories	matriz	Lista de categorias de risco a serem avaliadas.	Yes
destino	objeto	Representa um destino que especifica um agente de IA do Azure.	Yes
└─ nome	cadeia	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	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

AgentTaxonomyInputUpdate

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
riskCategories	matriz	Lista de categorias de risco a serem avaliadas.	Não
destino	objeto	Representa um destino que especifica um agente de IA do Azure.	Não
└─ nome	cadeia	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	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	DESCRIÇÃO	Obrigatório	Padrão
criado_em	inteiro	O carimbo de data/hora do Unix (segundos) quando o agente foi criado.	Yes
definição	AgentDefinition		Yes
descrição	cadeia	Uma descrição legível por humanos do agente.	Não
id	cadeia	O identificador exclusivo da versão do agente.	Yes
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
nome	cadeia	O nome do agente. O nome pode ser usado para recuperar/atualizar/excluir o agente.	Yes
objeto	enumeração	O tipo de objeto, que é sempre 'agent.version'. Valores possíveis: agent.version	Yes
versão	cadeia	O identificador de versão do agente. Os agentes são imutáveis e cada atualização cria uma nova versão, mantendo o mesmo nome.	Yes

AgenticIdentityCredentials

Definição de credencial de identidade agêntica

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	O tipo de credencial Valores possíveis: AgenticIdentityToken	Yes

ApiErrorResponse

Resposta de erro para falhas de API.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
erro	OpenAI.Error		Yes

ApiKeyCredentials

Definição de credencial de chave de API

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
chave	cadeia	Chave de API	Não
tipo	enumeração	O tipo de credencial Valores possíveis: ApiKey	Yes

AssetCredentialResponse

Representa uma referência a um blob para consumo

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

ID do Ativo

Identificador de um ativo salvo.

Tipo: string

AttackStrategy

Estratégias para ataques.

Propriedade	Valor
Descrição	Estratégias para ataques.
Tipo	cadeia
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	DESCRIÇÃO	Obrigatório	Padrão
codificar	cadeia	Um de um conjunto definido pelo servidor de códigos de erro.	Yes
details	matriz	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.	Não
innererror	objeto	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	Um de um conjunto definido pelo servidor de códigos de erro.	Não
└─ innererror	Azure.Core.Foundations.InnerError	Erro interno.	Não
mensagem	cadeia	Uma representação do erro em formato legível por humanos.	Yes
destino	cadeia	O destino do erro.	Não

Azure.Core.Foundations.ErrorResponse

Uma resposta que contém detalhes do erro.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
erro	objeto	O objeto de erro.	Yes
└─ código	cadeia	Um de um conjunto definido pelo servidor de códigos de erro.	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	Uma representação do erro em formato legível por humanos.	Não
└─ destino	cadeia	O destino 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	DESCRIÇÃO	Obrigatório	Padrão
codificar	cadeia	Um de um conjunto definido pelo servidor de códigos de erro.	Não
innererror	objeto	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	Um de um conjunto definido pelo servidor de códigos de erro.	Não
└─ innererror	Azure.Core.Foundations.InnerError	Erro interno.	Não

Azure.Core.Foundations.OperationState

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

Propriedade	Valor
Tipo	cadeia
Valores	NotStarted Running Succeeded Failed Canceled

Azure.Core.uuid

Identificador Universalmente Exclusivo

Tipo: string

Formato: uuid

AzureAIAgentTarget

Representa um destino que especifica um agente de IA do Azure.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nome	cadeia	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	A versão do agente de IA do Azure.	Não

AzureAIAgentTargetUpdate

Representa um destino que especifica um agente de IA do Azure.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nome	cadeia	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	A versão do agente de IA do Azure.	Não

AzureAIAssistantTarget

Representa um destino que especifica um ponto de extremidade do Assistente de IA do Azure (Agente V1), incluindo sua ID.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
id	cadeia	O identificador exclusivo do Assistente de IA do Azure.	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 destino que especifica um ponto de extremidade do Assistente de IA do Azure (Agente V1), incluindo sua ID.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
id	cadeia	O identificador exclusivo do Assistente de IA do Azure.	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

Definição do Avaliador de IA do Azure para avaliadores de fundimento.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
data_mapping	objeto	O modelo a ser usado para a avaliação. Deve dar suporte a saídas estruturadas.	Não
evaluator_name	cadeia	O nome do avaliador.	Yes
evaluator_version	cadeia	A versão do avaliador.	Não
initialization_parameters	objeto	Os parâmetros de inicialização para a avaliação. Deve dar suporte a saídas estruturadas.	Não
nome	cadeia	O nome do avaliador.	Yes
tipo	enumeração	O tipo de objeto, que é sempre label_model. Valores possíveis: azure_ai_evaluator	Yes

AzureAIModelTarget

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
modelo	cadeia	O identificador exclusivo do modelo de IA do Azure.	Não
sampling_params	objeto	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 (máximo de tokens de conclusão)	inteiro	O número máximo de tokens permitidos na conclusão.	Não
└─ semente	inteiro	A semente aleatória para 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úcleo.	Não
tipo	enumeração	O tipo de alvo, sempre azure_ai_model. Valores possíveis: azure_ai_model	Yes

AzureAIModelTargetUpdate

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
modelo	cadeia	O identificador exclusivo do modelo de IA do Azure.	Não
sampling_params	objeto	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 (máximo de tokens de conclusão)	inteiro	O número máximo de tokens permitidos na conclusão.	Não
└─ semente	inteiro	A semente aleatória para 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úcleo.	Não
tipo	enumeração	O tipo de alvo, sempre azure_ai_model. Valores possíveis: azure_ai_model	Não

AzureAIRedTeam

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
item_generation_params	objeto	Representa os parâmetros para a geração de item de equipe vermelha.	Yes
└─ attack_strategies	matriz	A coleção de estratégias de ataque a serem usadas.	Não
└─ num_turns	inteiro	O número de turnos permitido no jogo.	Não
└─ tipo	enumeração	O tipo de parâmetros de geração de item, sempre red_team. Valores possíveis: red_team	Não
destino	objeto	Classe base para destinos com suporte a discriminadores.	Yes
└─ tipo	cadeia	O tipo de destino.	Não
tipo	enumeração	O tipo de fonte de dados. Sempre azure_ai_red_team. Valores possíveis: azure_ai_red_team	Yes

AzureAIResponses

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
event_configuration_id	cadeia	O nome da configuração do evento associado a essa execução de avaliação.	Yes
item_generation_params	objeto	Representa os parâmetros para a geração contínua de itens de avaliação.	Yes
└─ data_mapping	objeto	Mapeamento de campos de origem para response_id campo, necessário para recuperar o histórico de chat.	Não
└─ max_num_turns	inteiro	O número máximo de turnos do histórico de chat a ser avaliado.	Não
└─ origem	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource	A origem da qual o conteúdo JSONL é lido.	Não
└─ tipo	enumeração	O tipo de parâmetros de geração de item, sempre ResponseRetrieval. Valores possíveis: response_retrieval	Não
max_runs_hourly	inteiro	Número máximo de execuções de avaliação permitidas por hora.	Yes
tipo	enumeração	O tipo de fonte de dados, always 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, conforme usado para configurar um agente.

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

Índice de Busca do AzureAI

Definição de índice do Azure AI Search

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Tipo de índice Valores possíveis: AzureSearch	Yes

AzureAISearchIndexUpdate

Definição de índice do Azure AI Search

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
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.
Tipo	cadeia
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	DESCRIÇÃO	Obrigatório	Padrão
Índices	matriz	Os índices anexados a este agente. Pode haver um índice máximo de 1 recurso anexado ao agente.	Yes

AzureAISource

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
cenário	enumeração	Cenário de esquema de dados. Valores possíveis: red_team, , responsestraces	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	DESCRIÇÃO	Obrigatório	Padrão
azure_function	objeto	A definição da função do Azure.	Yes
Função └─	objeto	A definição da função do azure e seus parâmetros.	Não
└─ descrição	cadeia	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	O nome da função a ser chamada.	Não
└─ parâmetros		Os parâmetros aceitos pelas funções, 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 ela.	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	DESCRIÇÃO	Obrigatório	Padrão
storage_queue	objeto	A estrutura para manter o nome da fila de armazenamento e o URI.	Yes
└─ queue_name	cadeia	O nome de uma fila de armazenamento de funções do Azure.	Não
└─ queue_service_endpoint	cadeia	URI para o serviço Fila de Armazenamento do Azure, permitindo que você manipule uma fila.	Não
tipo	enumeração	O tipo de associação, que é sempre "storage_queue". Valores possíveis: storage_queue	Yes

AzureFunctionDefinition

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
função	objeto	A definição da função do azure e seus parâmetros.	Yes
└─ descrição	cadeia	Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função.	Não
└─ nome	cadeia	O nome da função a ser chamada.	Não
└─ parâmetros		Os parâmetros aceitos pelas funções, descritos como um objeto de esquema JSON.	Não
input_binding	objeto	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 associação, que é sempre "storage_queue". Valores possíveis: storage_queue	Não
output_binding	objeto	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 associaçã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	DESCRIÇÃO	Obrigatório	Padrão
queue_name	cadeia	O nome de uma fila de armazenamento de funções do Azure.	Yes
queue_service_endpoint	cadeia	URI para o serviço Fila de Armazenamento do Azure, permitindo que você manipule uma fila.	Yes

AzureOpenAIModelConfiguration

Configuração do modelo OpenAI do Azure. A versão da API seria selecionada pelo serviço para consultar o modelo.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
modelDeploymentName	cadeia	Nome de implantação para o modelo AOAI. Exemplo: gpt-4o se em AIServices ou baseado em connection_name/deployment_name conexão (por exemplo, my-aoai-connection/gpt-4o).	Yes
tipo	enumeração	Valores possíveis: AzureOpenAIModel	Yes

BaseCredentials

Uma classe base para credenciais de conexão

Discriminatório para BaseCredentials

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

Valor do tipo	Schema
ApiKey	ApiKeyCredentials
AAD	EntraIDCredentials
CustomKeys	CustomCredential
SAS	SASCredentials
None	NoAuthenticationCredentials
AgenticIdentityToken	AgenticIdentityCredentials

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	objeto	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	DESCRIÇÃO	Obrigatório	Padrão
bing_custom_search_preview	objeto	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 conexão recurso anexado à ferramenta.	Não
tipo	enumeração	O tipo de objeto, que é sempre 'bing_custom_search'. Valores possíveis: bing_custom_search_preview	Yes

BingCustomSearchConfiguration

Uma configuração de pesquisa personalizada do bing.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
count	inteiro	O número de resultados da pesquisa a serem retornados na resposta da API do bing	Não
freshness	cadeia	Filtre os resultados da pesquisa por um intervalo de tempo específico. Veja os valores aceitos aqui.	Não
instance_name	cadeia	Nome da instância de configuração personalizada fornecida à configuração.	Yes
mercado	cadeia	O mercado de onde vêm os resultados.	Não
project_connection_id	cadeia	ID de conexão do projeto para aterramento com pesquisa do Bing	Yes
set_lang	cadeia	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	DESCRIÇÃO	Obrigatório	Padrão
search_configurations	matriz	As conexões do projeto anexadas a esta ferramenta. Pode haver um máximo de 1 conexão recurso anexado à 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	DESCRIÇÃO	Obrigatório	Padrão
bing_grounding	objeto	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 recurso de configuração de pesquisa anexado à ferramenta.	Não
tipo	enumeração	O tipo de objeto, que é sempre 'bing_grounding'. Valores possíveis: bing_grounding	Yes

BingGroundingSearchConfiguration

Configuração de pesquisa para aterramento do Bing

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
count	inteiro	O número de resultados da pesquisa a serem retornados na resposta da API do bing	Não
freshness	cadeia	Filtre os resultados da pesquisa por um intervalo de tempo específico. Veja os valores aceitos aqui.	Não
mercado	cadeia	O mercado de onde vêm os resultados.	Não
project_connection_id	cadeia	ID de conexão do projeto para aterramento com pesquisa do Bing	Yes
set_lang	cadeia	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	DESCRIÇÃO	Obrigatório	Padrão
search_configurations	matriz	As configurações de pesquisa anexadas a esta ferramenta. Pode haver um máximo de 1 recurso de configuração de pesquisa anexado à ferramenta.	Yes

BlobReference

Detalhes de referência de blob.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
blobUri	cadeia	Caminho do URI do blob para o cliente carregar dados. Exemplo: https://blob.windows.core.net/Container/Path	Yes
credencial	objeto	Definição de credencial SAS	Yes
└─ sasUri	cadeia	Uri SAS	Não
└─ tipo	enumeração	Tipo de credencial Valores possíveis: SAS	Não
storageAccountArmId	cadeia	ID do 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	DESCRIÇÃO	Obrigatório	Padrão
browser_automation_preview	objeto	Definição de parâmetros de entrada para a Ferramenta de Automação do Navegador.	Yes
└─ conexão	BrowserAutomationToolConnectionParameters	Os parâmetros de conexão do projeto associados à Ferramenta de automação do navegador.	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 Ferramenta de Automação do Navegador.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
project_connection_id	cadeia	A ID da conexão do projeto com o recurso do Azure Playwright.	Yes

BrowserAutomationToolParameters

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
conexão	objeto	Definição de parâmetros de entrada para a conexão usada pela Ferramenta de Automação do Navegador.	Yes
└─ project_connection_id	cadeia	A ID da conexão do projeto com o recurso do Azure Playwright.	Não

CaptureStructuredOutputsTool

Uma ferramenta para capturar saídas estruturadas

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
saídas	objeto	Uma saída estruturada que pode ser produzida pelo agente.	Yes
└─ descrição	cadeia	Uma descrição da saída a ser emitida. Usado pelo modelo para determinar quando emitir a saída.	Não
└─ nome	cadeia	O nome da saída estruturada.	Não
└─ esquema		O esquema JSON para a saída estruturada.	Não
└─ rigoroso	boolean	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	DESCRIÇÃO	Obrigatório	Padrão
size	inteiro	Tamanho do elemento do gráfico.	Yes
x	inteiro	Coordenada do eixo X.	Yes
y	inteiro	Coordenada do eixo Y.	Yes

ChatSummaryMemoryItem

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
variante	enumeração	O tipo de item de memória. Valores possíveis: chat_summary	Yes

ClusterInsightResult

Insights da análise de cluster.

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

CodeBasedEvaluatorDefinition

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
code_text	cadeia	Texto de código embutido para o avaliador	Yes
tipo	enumeração	Valores possíveis: code	Yes

Conexão

Resposta da lista e operações get connections

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
credenciais	objeto	Uma classe base para credenciais de conexão	Yes
└─ tipo	CredentialType	O tipo de credencial usado pela conexão	Não
id	cadeia	Um identificador exclusivo para a conexão, gerado pelo serviço	Yes
isDefault	boolean	Se a conexão está marcada como a conexão padrão de seu tipo	Yes
metadados	objeto	Metadados da conexão	Yes
nome	cadeia	O nome amigável da conexão, fornecido pelo usuário.	Yes
destino	cadeia	A URL de conexão a ser usada para este serviço	Yes
tipo	objeto	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
Tipo	cadeia
Valores	AzureOpenAI AzureBlob AzureStorageAccount CognitiveSearch CosmosDB ApiKey AppConfig AppInsights CustomKeys RemoteTool

ContainerAppAgentDefinition

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
container_app_resource_id	cadeia	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	O sufixo a ser aplicado ao subdomínio do aplicativo ao enviar entrada para o agente. Pode ser um rótulo (por exemplo, '---current'), uma revisão específica (por exemplo, '--0000001') ou vazio para usar o endpoint padrão para o aplicativo de contêiner.	Yes
variante	enumeração	Valores possíveis: container_app	Yes

ContinuousEvalItemGenerationParams

Representa os parâmetros para a geração contínua de itens de avaliação.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
data_mapping	objeto	Mapeamento de campos de origem para response_id campo, necessário para recuperar o histórico de chat.	Yes
max_num_turns	inteiro	O número máximo de turnos do histórico de chat a ser avaliado.	Yes
fonte	objeto		Yes
└─ conteúdo	matriz	O conteúdo do arquivo jsonl.	Não
└─ id	cadeia	O identificador do arquivo.	Não
└─ tipo	enumeraçã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 item, sempre ResponseRetrieval. Valores possíveis: response_retrieval	Yes

ContinuousEvaluationRuleAction

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

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

Índice CosmosDB

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Tipo de índice Valores possíveis: CosmosDBNoSqlVectorStore	Yes

CosmosDBIndexUpdate

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Tipo de índice Valores possíveis: CosmosDBNoSqlVectorStore	Yes

CreateAgentFromManifestRequest

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	Uma descrição legível por humanos do agente.	Não
manifest_id	cadeia	A ID do manifesto da qual importar a versão do agente.	Yes
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia	O nome exclusivo que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve iniciar e terminar com caracteres alfanuméricos, - Pode conter hifens no meio - Não deve exceder 63 caracteres.	Yes
parameter_values	objeto	As entradas para o manifesto que resultarão em um Agente totalmente materializado.	Yes

CreateAgentRequest

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
definição	objeto		Yes
└─ tipo	AgentKind		Não
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).	Não
descrição	cadeia	Uma descrição legível por humanos do agente.	Não
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia	O nome exclusivo que identifica o agente. O nome pode ser usado para recuperar/atualizar/excluir o agente. - Deve iniciar e terminar com caracteres alfanuméricos, - Pode conter hifens no meio - Não deve exceder 63 caracteres.	Yes

CreateAgentVersionFromManifestRequest

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	Uma descrição legível por humanos do agente.	Não
manifest_id	cadeia	A ID do manifesto da qual importar a versão do agente.	Yes
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
parameter_values	objeto	As entradas para o manifesto que resultarão em um Agente totalmente materializado.	Yes

CreateAgentVersionRequest

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
definição	objeto		Yes
└─ tipo	AgentKind		Não
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).	Não
descrição	cadeia	Uma descrição legível por humanos do agente.	Não
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

CriarSolicitacaoDeAvaliacao

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
configuração_da_fonte_de_dados	objeto	Um objeto CustomDataSourceConfig que define o esquema da fonte de dados usada para as execuções de avaliação. Esse esquema é usado para definir a forma dos dados que serão: - Usado para definir seus critérios de teste e - Quais dados são necessários ao criar uma execução	Yes
├─ incluir_esquema_exemplo	boolean	Se a avaliação deve esperar que você preencha o namespace de exemplo (ou seja, gerando respostas a partir da sua fonte de dados)	Não
└─ esquema_de_item	objeto	O esquema json para cada linha na fonte de dados.	Não
└─ metadados	objeto	Filtros de metadados da fonte de dados de conclusões armazenadas.	Não
Cenário └─	enumeração	Cenário de esquema de dados. Valores possíveis: red_team, , responsestraces	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. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia	O nome da avaliação.	Não
propriedades	objeto	Conjunto de 16 pares chave-valor imutáveis que podem ser anexados a um objeto para armazenar informações adicionais. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
critérios_de_teste	matriz	Uma lista de avaliadores 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 referenciar a saída do modelo, use o namespace sample (ou seja, {{sample.output_text}}).	Yes

CreateEvalRunRequest

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
fonte_de_dados	objeto	Um objeto JsonlRunDataSource com o qual especifica um arquivo JSONL que corresponde à avaliação	Yes
└─ mensagens_de_entrada	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate ou OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Usado durante a amostragem de um modelo. Determina a estrutura das mensagens passadas para o modelo. Pode ser uma referência a uma trajetória predefinida (ou seja, item.input_trajectory) ou a um modelo com referências variáveis ao item namespace.	Não
└─ item_generation_params	RedTeamItemGenerationParams	Os parâmetros para a geração de itens.	Não
└─ modelo	cadeia	O nome do modelo a ser usado para gerar conclusões (por exemplo, "o3-mini").	Não
└─ parâmetros_de_amostragem	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Não
└─ origem	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource ou OpenAI.EvalResponsesSource	Determina o que preenche o item namespace na fonte de dados dessa execução.	Não
└─ destino	Target (destino)	A configuração de destino para a avaliação.	Não
└─ tipo	cadeia	O tipo de fonte de dados discriminatório.	Não
metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia	O nome da execução.	Não
propriedades	objeto	Conjunto de 16 pares chave-valor imutáveis que podem ser anexados a um objeto para armazenar informações adicionais. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

CreatedBy

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
agente	objeto		Não
└─ nome	cadeia	O nome do agente.	Não
└─ tipo	enumeração	Valores possíveis: agent_id	Não
└─ versão	cadeia	O identificador de versão do agente.	Não
response_id	cadeia	A resposta na qual o item é criado.	Não

CredentialType

O tipo de credencial usado pela conexão

Propriedade	Valor
Descrição	O tipo de credencial usado pela conexão
Tipo	cadeia
Valores	ApiKey AAD SAS CustomKeys None AgenticIdentityToken

CronTrigger

Gatilho baseado em cron.

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

CustomCredential

Definição de credencial personalizada

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	O tipo de credencial Valores possíveis: CustomKeys	Yes

DailyRecurrenceSchedule

Cronograma diário de recorrência.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
horas	matriz	Horas para o cronograma de recorrência.	Yes
tipo	enumeração	Tipo de recorrência diária. Valores possíveis: Daily	Yes

DatasetType

Enumerar para determinar o tipo de dados.

Propriedade	Valor
Descrição	Enumerar para determinar o tipo de dados.
Tipo	cadeia
Valores	uri_file uri_folder

DatasetVersion

Definição de DatasetVersion

Discriminador para DatasetVersion

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

Valor do tipo	Schema
uri_file	FileDatasetVersion
uri_folder	FolderDatasetVersion

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nome da conexão	cadeia	O nome da conexão da Conta de Armazenamento do Azure. Obrigatório se startPendingUploadVersion não tiver sido chamado antes de criar o conjunto de dados	Não
dataUri	cadeia	URI dos dados (exemplo)	Yes
id	cadeia	ID do ativo, um identificador exclusivo para o ativo	Não
isReference	boolean	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 true, os dados subjacentes não serão excluídos quando a versão do conjunto de dados for excluída	Não
nome	cadeia	O nome do recurso	Yes
tipo	objeto	Enumerar para determinar o tipo de dados.	Yes
versão	cadeia	A versão do recurso	Yes

DatasetVersionUpdate

Definição de DatasetVersion

Discriminador para DatasetVersionUpdate

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

Valor do tipo	Schema
uri_file	FileDatasetVersionUpdate
uri_folder	FolderDatasetVersionUpdate

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	O texto de descrição do ativo.	Não
tags	objeto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não
tipo	objeto	Enumerar para determinar o tipo de dados.	Yes

DiaDaSemana

Dias da semana para cronograma de recorrência.

Propriedade	Valor
Descrição	Dias da semana para cronograma de recorrência.
Tipo	cadeia
Valores	Sunday Monday Tuesday Wednesday Thursday Friday Saturday

DeleteAgentResponse

Um objeto de agente excluído

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
excluído	boolean	Se o agente foi excluído com êxito.	Yes
nome	cadeia	O nome do agente.	Yes
objeto	enumeração	O tipo de objeto. Sempre 'agent.deleted'. Valores possíveis: agent.deleted	Yes

DeleteAgentVersionResponse

Um objeto de versão do agente excluído

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

DeleteEvalResponse

Um objeto de avaliação excluído

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

DeleteEvalRunResponse

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

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

DeleteMemoryStoreResponse

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

DeleteResponseResult

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

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

Implantação

Definição de implantação de modelo

Discriminatório para implantação

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

Valor do tipo	Schema
ModelDeployment	ModelDeployment

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nome	cadeia	Nome da implantação	Yes
tipo	objeto		Yes

DeploymentType

Propriedade	Valor
Tipo	cadeia
Valores	ModelDeployment

EntraIDCredentials

Definição de credencial de ID do Entra

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	O tipo de credencial Valores possíveis: AAD	Yes

Eval

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

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
criado_em	objeto		Yes
created_by	cadeia	o nome da pessoa que criou a execução.	Não
configuração_da_fonte_de_dados	objeto	Um objeto CustomDataSourceConfig que define o esquema da fonte de dados usada para as execuções de avaliação. Esse esquema é usado para definir a forma dos dados que serão: - Usado para definir seus critérios de teste e - Quais dados são necessários ao criar uma execução	Yes
├─ incluir_esquema_exemplo	boolean	Se a avaliação deve esperar que você preencha o namespace de exemplo (ou seja, gerando respostas a partir da sua fonte de dados)	Não
└─ esquema_de_item	objeto	O esquema json para cada linha na fonte de dados.	Não
└─ metadados	objeto	Filtros de metadados da fonte de dados de conclusões armazenadas.	Não
Cenário └─	enumeração	Cenário de esquema de dados. Valores possíveis: red_team, , responsestraces	Não
└─ tipo	enumeração	O tipo de objeto, que é sempre label_model. Valores possíveis: azure_ai_source	Não
id	cadeia	Identificador exclusivo para a avaliação.	Yes
metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
modified_at	objeto		Não
nome	cadeia	O nome da avaliação.	Yes
objeto	enumeração	O tipo de objeto. Valores possíveis: eval	Yes
propriedades	objeto	Conjunto de 16 pares chave-valor imutáveis que podem ser anexados a um objeto para armazenar informações adicionais. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
critérios_de_teste	matriz	Uma lista de critérios de teste.	Yes

EvalCompareReport

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
Comparações	matriz	Os resultados da comparação para cada tratamento são executados em relação à linha de base.	Yes
método	cadeia	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	DESCRIÇÃO	Obrigatório	Padrão
nome	cadeia	Nome do cheque	Yes
passado	boolean	indica se a verificação foi aprovada ou reprovada	Yes
pontuação	número	pontuação	Yes
tipo	cadeia	Tipo de cheque	Yes

EvalRun

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
criado_em	objeto		Yes
created_by	cadeia	o nome da pessoa que criou a execução.	Não
fonte_de_dados	objeto	Um objeto JsonlRunDataSource com o qual especifica um arquivo JSONL que corresponde à avaliação	Yes
└─ mensagens_de_entrada	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate ou OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Usado durante a amostragem de um modelo. Determina a estrutura das mensagens passadas para o modelo. Pode ser uma referência a uma trajetória predefinida (ou seja, item.input_trajectory) ou a um modelo com referências variáveis ao item namespace.	Não
└─ item_generation_params	RedTeamItemGenerationParams	Os parâmetros para a geração de itens.	Não
└─ modelo	cadeia	O nome do modelo a ser usado para gerar conclusões (por exemplo, "o3-mini").	Não
└─ parâmetros_de_amostragem	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Não
└─ origem	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource ou OpenAI.EvalResponsesSource	Determina o que preenche o item namespace na fonte de dados dessa execução.	Não
└─ destino	Target (destino)	A configuração de destino para a avaliação.	Não
└─ tipo	cadeia	O tipo de fonte de dados discriminatório.	Não
erro	OpenAI.EvalApiError	Um objeto que representa uma resposta de erro da API de Eval.	Yes
eval_id	cadeia	O identificador da avaliação associada.	Yes
id	cadeia	Identificador exclusivo para a execução da avaliação.	Yes
metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
modelo	cadeia	O modelo que é avaliado, se aplicável.	Yes
modified_at	objeto		Não
nome	cadeia	O nome da execução da avaliação.	Yes
objeto	enumeração	O tipo do objeto. Sempre "eval.run". Valores possíveis: eval.run	Yes
per_model_usage	matriz	Estatísticas de uso para cada modelo durante a execução da avaliação.	Yes
resultados_por_critério_de_teste	matriz	Resultados por critérios de teste aplicados durante a execução da avaliação.	Yes
propriedades	objeto	Conjunto de 16 pares chave-valor imutáveis que podem ser anexados a um objeto para armazenar informações adicionais. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
report_url	cadeia	A URL para o relatório da execução da avaliação no painel da interface do usuário.	Yes
contagem_de_resultados	objeto		Yes
└─ erro	OpenAI.integer		Não
└─ falha	OpenAI.integer		Não
└─ aprovado	OpenAI.integer		Não
└─ Total	OpenAI.integer		Não
status	cadeia	O status da execução da avaliação.	Yes

EvalRunDataSource

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

Discriminador para EvalRunDataSource

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

Valor do tipo	Schema
azure_ai_traces	TracesEvalRunDataSource
azure_ai_responses	AzureAIResponses
azure_ai_target_completions	TargetCompletions

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	cadeia	O tipo de fonte de dados discriminatório.	Yes

EvalRunOutputItem

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

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

EvalRunOutputItemResult

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

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

EvalRunResultCompareItem

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
deltaEstimate	número	Diferença estimada entre o tratamento e a linha de base.	Yes
pValue	número	Valor de p para o efeito do tratamento.	Yes
treatmentEffect	objeto	Tipo de efeito de tratamento.	Yes
treatmentRunId	cadeia	O tratamento executado ID.	Yes
treatmentRunSummary	objeto	Estatísticas resumidas de uma métrica em uma execução de avaliação.	Yes
└─ média	número	Valor médio da métrica na execução de avaliação.	Não
└─ runId	cadeia	A ID da execução de avaliação.	Não
└─ Contagem de Amostras	inteiro	Número de amostras na execução de avaliação.	Não
└─ Desvio padrão	número	Desvio padrão da métrica na execução da avaliação.	Não

EvalRunResultComparison

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
baselineRunSummary	objeto	Estatísticas resumidas de uma métrica em uma execução de avaliação.	Yes
└─ média	número	Valor médio da métrica na execução de avaliação.	Não
└─ runId	cadeia	A ID da execução de avaliação.	Não
└─ Contagem de Amostras	inteiro	Número de amostras na execução de avaliação.	Não
└─ Desvio padrão	número	Desvio padrão da métrica na execução da avaliação.	Não
compareItems	matriz	Lista de resultados de comparação para cada execução de tratamento.	Yes
Avaliador	cadeia	Nome do avaliador para este critério de teste.	Yes
métrica	cadeia	Métrica sendo avaliada.	Yes
testingCriteria	cadeia	Nome dos critérios de ensaio.	Yes

EvalRunResultSummary

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
média	número	Valor médio da métrica na execução de avaliação.	Yes
runId	cadeia	A ID da execução de avaliação.	Yes
sampleCount	inteiro	Número de amostras na execução de avaliação.	Yes
standardDeviation	número	Desvio padrão da métrica na execução da avaliação.	Yes

EvaluationComparisonRequest

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

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

EvaluationResultSample

Uma amostra do resultado da avaliação.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
evaluationResult	objeto	Resultado da avaliação.	Yes
└─ nome	cadeia	Nome do cheque	Não
└─ aprovado	boolean	indica se a verificação foi aprovada ou reprovada	Não
└─ pontuação	número	pontuação	Não
└─ tipo	cadeia	Tipo de cheque	Não
tipo	enumeração	Tipo de amostra de resultado da análise Valores possíveis: EvaluationResultSample	Yes

Regra de avaliação

Modelo de regra de avaliação.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
ação	objeto	Modelo de ação de avaliação.	Yes
└─ tipo	EvaluationRuleActionType	Tipo de ação de avaliação.	Não
descrição	cadeia	Descrição da regra de avaliação.	Não
nome de exibição	cadeia	Nome de exibição da regra de avaliação.	Não
enabled	boolean	Indica se a regra de avaliação está habilitada. O padrão é true.	Yes
eventType	objeto	Tipo do evento de regra de avaliação.	Yes
filtro	objeto	Modelo de filtro de avaliação.	Não
└─ agentName	cadeia	Filtre por nome do agente.	Não
id	cadeia	Identificador exclusivo para a regra de avaliação.	Yes
dados do sistema	objeto	Metadados do sistema para a regra de avaliação.	Yes

EvaluationRuleAction

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

Discriminador para EvaluationRuleAction

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

Valor do tipo	Schema
continuousEvaluation	ContinuousEvaluationRuleAction
humanEvaluation	HumanEvaluationRuleAction

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	objeto	Tipo de ação de avaliação.	Yes

EvaluationRuleActionType

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

Propriedade	Valor
Descrição	Tipo de ação de avaliação.
Tipo	cadeia
Valores	continuousEvaluation humanEvaluation

EvaluationRuleEventType

Tipo do evento de regra de avaliação.

Propriedade	Valor
Descrição	Tipo do evento de regra de avaliação.
Tipo	cadeia
Valores	responseCompleted manual

EvaluationRuleFilter

Modelo de filtro de avaliação.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nome_do_agente	cadeia	Filtre por nome do agente.	Yes

EvaluationRunClusterInsightResult

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

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

EvaluationRunClusterInsightsRequest

Insights sobre o conjunto de resultados da avaliação

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
evalId	cadeia	ID de avaliação para os insights.	Yes
modelConfiguration	objeto	Configuração do modelo usado na geração de insights.	Não
└─ modelDeploymentName	cadeia	A implantação do modelo a ser avaliada. Aceita o nome da implantação sozinho ou com o nome da conexão como {connectionName}/<modelDeploymentName>.	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

EvaluationScheduleTask

Tarefa de avaliação para o cronograma.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
evalId	cadeia	Identificador do grupo de avaliação.	Yes
evalRun	objeto	A carga útil da execução de avaliação.	Yes
tipo	enumeração	Valores possíveis: Evaluation	Yes

EvaluationTaxonomy

Definição de taxonomia de avaliação

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
id	cadeia	ID do ativo, um identificador exclusivo para o ativo	Não
nome	cadeia	O nome do recurso	Yes
propriedades	objeto	Propriedades adicionais para a taxonomia de avaliação.	Não
taxonomyCategories	matriz	Lista de categorias de taxonomia.	Não
taxonomyInput	objeto	Configuração de entrada para a taxonomia de avaliação.	Yes
└─ tipo	EvaluationTaxonomyInputType	Tipo de entrada da taxonomia de avaliação.	Não
versão	cadeia	A versão do recurso	Yes

EvaluationTaxonomyCreateOrUpdate

Definição de taxonomia de avaliação

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	O texto de descrição do ativo.	Não
propriedades	objeto	Propriedades adicionais para a taxonomia de avaliação.	Não
tags	objeto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não
taxonomyCategories	matriz	Lista de categorias de taxonomia.	Não
taxonomyInput	objeto	Configuração de entrada para a taxonomia de avaliação.	Yes
└─ tipo	EvaluationTaxonomyInputType	Tipo de entrada da taxonomia de avaliação.	Não

EvaluationTaxonomyInput

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

Discriminador para EvaluationTaxonomyInput

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

Valor do tipo	Schema
agent	AgentTaxonomyInput

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	objeto	Tipo de entrada da taxonomia de avaliação.	Yes

EvaluationTaxonomyInputType

Tipo de entrada da taxonomia de avaliação.

Propriedade	Valor
Descrição	Tipo de entrada da taxonomia de avaliação.
Tipo	cadeia
Valores	agent policy

EvaluationTaxonomyInputUpdate

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

Discriminador para EvaluationTaxonomyInputUpdate

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

Valor do tipo	Schema
agent	AgentTaxonomyInputUpdate

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	objeto	Tipo de entrada da taxonomia de avaliação.	Yes

EvaluationTaxonomyUpdate

Definição de taxonomia de avaliação

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	O texto de descrição do ativo.	Não
propriedades	objeto	Propriedades adicionais para a taxonomia de avaliação.	Não
tags	objeto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não
taxonomyCategories	matriz	Lista de categorias de taxonomia.	Não
taxonomyInput	objeto	Configuração de entrada para a taxonomia de avaliação.	Não
└─ tipo	EvaluationTaxonomyInputType	Tipo de entrada da taxonomia de avaliação.	Não

EvaluatorCategory

A categoria do avaliador

Propriedade	Valor
Descrição	A categoria do avaliador
Tipo	cadeia
Valores	quality safety agents

EvaluatorDefinition

Configuração do avaliador base com discriminador

Discriminador para EvaluatorDefinition

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

Valor do tipo	Schema
code	CodeBasedEvaluatorDefinition
prompt	PromptBasedEvaluatorDefinition

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
data_schema		O esquema JSON (rascunho 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 (Rascunho 2020-12) para os parâmetros de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	Não
métricas	objeto	Lista de métricas de saída produzidas por este avaliador	Não
tipo	objeto	O tipo de definição do avaliador	Yes

EvaluatorDefinitionType

O tipo de definição do avaliador

Propriedade	Valor
Descrição	O tipo de definição do avaliador
Tipo	cadeia
Valores	prompt code prompt_and_code service openai_graders

EvaluatorMetric

Métrica do avaliador

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
desirable_direction	objeto	A direção da métrica que indica se um valor mais alto é melhor, um valor mais baixo é melhor ou neutro	Não
is_primary	boolean	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 seja vinculado.	Não
min_value	número	Valor mínimo para a métrica	Não
tipo	objeto	O tipo de avaliador	Não

EvaluatorMetricDirection

A direção da métrica que indica se um valor mais alto é melhor, um valor mais baixo é melhor ou neutro

Propriedade	Valor
Descrição	A direção da métrica que indica se um valor mais alto é melhor, um valor mais baixo é melhor ou neutro
Tipo	cadeia
Valores	increase decrease neutral

EvaluatorMetricType

O tipo de avaliador

Propriedade	Valor
Descrição	O tipo de avaliador
Tipo	cadeia
Valores	ordinal continuous boolean

EvaluatorType

O tipo de avaliador

Propriedade	Valor
Descrição	O tipo de avaliador
Tipo	cadeia
Valores	builtin custom

EvaluatorVersion

Definição de avaliador

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
categories	matriz	As categorias do avaliador	Yes
criado_em	inteiro	Data/hora de criação do avaliador	Yes
created_by	cadeia	Criador do avaliador	Yes
definição	objeto	Configuração do avaliador base com discriminador	Yes
└─ data_schema		O esquema JSON (rascunho 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 (Rascunho 2020-12) para os parâmetros de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	Não
└─ métricas	objeto	Lista de métricas de saída produzidas por este avaliador	Não
└─ tipo	EvaluatorDefinitionType	O tipo de definição do avaliador	Não
display_name	cadeia	Nome de exibição para o avaliador. Ele ajuda a localizar o avaliador facilmente na Foundry. Não precisa ser único.	Não
evaluator_type	objeto	O tipo de avaliador	Yes
id	cadeia	ID do ativo, um identificador exclusivo para o ativo	Não
metadados	objeto	Metadados sobre o avaliador	Não
modified_at	inteiro	Data/hora da última modificação do avaliador	Yes
nome	cadeia	O nome do recurso	Yes
versão	cadeia	A versão do recurso	Yes

EvaluatorVersionCreate

Definição de avaliador

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
categories	matriz	As categorias do avaliador	Yes
definição	objeto	Configuração do avaliador base com discriminador	Yes
└─ data_schema		O esquema JSON (rascunho 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 (Rascunho 2020-12) para os parâmetros de entrada do avaliador. Isso inclui parâmetros como tipo, propriedades, obrigatório.	Não
└─ métricas	objeto	Lista de métricas de saída produzidas por este avaliador	Não
└─ tipo	EvaluatorDefinitionType	O tipo de definição do avaliador	Não
descrição	cadeia	O texto de descrição do ativo.	Não
display_name	cadeia	Nome de exibição para o avaliador. Ele ajuda a localizar o avaliador facilmente na Foundry. Não precisa ser único.	Não
evaluator_type	objeto	O tipo de avaliador	Yes
metadados	objeto	Metadados sobre o avaliador	Não
tags	objeto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não

EvaluatorVersionUpdate

Definição de avaliador

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
categories	matriz	As categorias do avaliador	Não
descrição	cadeia	O texto de descrição do ativo.	Não
display_name	cadeia	Nome de exibição para o avaliador. Ele ajuda a localizar o avaliador facilmente na Foundry. Não precisa ser único.	Não
metadados	objeto	Metadados sobre o avaliador	Não
tags	objeto	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	DESCRIÇÃO	Obrigatório	Padrão
project_connections	matriz	As conexões do projeto anexadas a esta ferramenta. Pode haver um máximo de 1 conexão recurso anexado à ferramenta.	Não

FileDatasetVersion

Definição de FileDatasetVersion

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Tipo de conjunto de dados Valores possíveis: uri_file	Yes

FileDatasetVersionUpdate

Definição de FileDatasetVersion

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Tipo de conjunto de dados Valores possíveis: uri_file	Yes

FolderDatasetVersion

Definição de FileDatasetVersion

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Tipo de conjunto de dados Valores possíveis: uri_folder	Yes

FolderDatasetVersionUpdate

Definição de FileDatasetVersion

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Tipo de conjunto de dados Valores possíveis: uri_folder	Yes

HostedAgentDefinition

A definição do agente hospedado.

Discriminador para HostedAgentDefinition

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

Valor do tipo	Schema
hosted	ImageBasedHostedAgentDefinition

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
container_protocol_versions	matriz	Os protocolos que o agente suporta para comunicação de entrada dos contêineres.	Yes
cpu	cadeia	A configuração da CPU para o agente hospedado.	Yes
environment_variables	objeto	Variáveis de ambiente a serem definidas no contêiner do agente hospedado.	Não
variante	enumeração	Valores possíveis: hosted	Yes
memória	cadeia	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

HourlyRecurrenceSchedule

Cronograma de recorrência por hora.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: Hourly	Yes

HumanEvaluationRuleAction

Ação de regra de avaliação para avaliação humana.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
id do modelo	objeto	Identificador de um ativo salvo.	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	DESCRIÇÃO	Obrigatório	Padrão
imagem	cadeia	A imagem do agente hospedado.	Yes
variante	enumeração	Valores possíveis: hosted	Yes

Index

Definição de recurso de índice

Discriminador para Índice

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

Valor do tipo	Schema
AzureSearch	AzureAISearchIndex
ManagedAzureSearch	ManagedAzureAISearchIndex
CosmosDBNoSqlVectorStore	CosmosDBIndex

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
id	cadeia	ID do ativo, um identificador exclusivo para o ativo	Não
nome	cadeia	O nome do recurso	Yes
tipo	objeto		Yes
versão	cadeia	A versão do recurso	Yes

IndexType

Propriedade	Valor
Tipo	cadeia
Valores	AzureSearch CosmosDBNoSqlVectorStore ManagedAzureSearch

IndexUpdate

Definição de recurso de índice

Discriminatório para IndexUpdate

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

Valor do tipo	Schema
AzureSearch	AzureAISearchIndexUpdate
ManagedAzureSearch	ManagedAzureAISearchIndexUpdate
CosmosDBNoSqlVectorStore	CosmosDBIndexUpdate

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	O texto de descrição do ativo.	Não
tags	objeto	Dicionário de tags. As tags podem ser adicionadas, removidas e atualizadas.	Não
tipo	objeto		Yes

Insight

O corpo da resposta para insights de cluster.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nome de exibição	cadeia	Nome de exibição amigável para o insight.	Yes
id	cadeia	O identificador exclusivo do relatório de insights.	Yes
metadados	objeto	Metadados sobre os insights.	Yes
└─ concluído At	cadeia	O carimbo de data/hora em que os insights foram concluídos.	Não
└─ criadoAt	cadeia	O carimbo de data/hora em que os insights foram criados.	Não
solicitação	objeto	A solicitação do relatório de insights.	Yes
└─ tipo	InsightType	O tipo de solicitação.	Não
resultado	objeto	O resultado dos insights.	Não
└─ tipo	InsightType	O tipo de resultado de insights.	Não
estado	objeto	Enumeração que descreve os estados de operação permitidos.	Yes

InsightCluster

Um conjunto de amostras de análise.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	Descrição do cluster de análise.	Yes
id	cadeia	A id do cluster de análise.	Yes
etiqueta	cadeia	Rótulo para o cluster	Yes
Amostras	matriz	Lista de amostras 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 houver subclusters.	Não
sugestão	cadeia	Sugestão para o cluster	Yes
suggestionTitle	cadeia	O título da sugestão para o cluster	Yes
weight	inteiro	O peso do cluster de análise. Isso indica o número de amostras no cluster.	Yes

InsightModelConfiguration

Configuração do modelo usado na geração de insights.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
modelDeploymentName	cadeia	A implantação do modelo a ser avaliada. Aceita o nome da implantação sozinho ou com o nome da conexão como {connectionName}/<modelDeploymentName>.	Yes

InsightRequest

A solicitação do relatório de insights.

Discriminador para InsightRequest

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

Valor do tipo	Schema
EvaluationRunClusterInsight	EvaluationRunClusterInsightsRequest
AgentClusterInsight	AgentClusterInsightsRequest
EvaluationComparison	EvaluationComparisonRequest

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	objeto	O pedido dos insights.	Yes

InsightResult

O resultado dos insights.

Discriminador para InsightResult

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

Valor do tipo	Schema
EvaluationComparison	EvalCompareReport
EvaluationRunClusterInsight	EvaluationRunClusterInsightResult
AgentClusterInsight	AgentClusterInsightResult

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	objeto	O pedido dos insights.	Yes

InsightSample

Uma amostra da análise.

Discriminador para InsightSample

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

Valor do tipo	Schema
EvaluationResultSample	EvaluationResultSample

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
correlationInfo	objeto	Informações sobre a correlação para a amostra de análise.	Yes
features	objeto	Recursos para ajudar na filtragem adicional de dados na experiência do usuário.	Yes
id	cadeia	O identificador exclusivo para a amostra de análise.	Yes
tipo	objeto	O tipo de amostra usada na análise.	Yes

InsightScheduleTask

Tarefa de insight para o agendamento.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
insight	objeto	O corpo da resposta para insights de cluster.	Yes
└─ displayName	cadeia	Nome de exibição amigável para o insight.	Não
└─ id	cadeia	O identificador exclusivo do relatório de insights.	Não
└─ metadados	InsightsMetadata	Metadados sobre o relatório de insights.	Não
└─ solicitação	InsightRequest	Solicitação para 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

InsightSummary

Resumo da análise do cluster de erros.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
método	cadeia	Método usado para agrupamento.	Yes
sampleCount	inteiro	Número total de amostras analisadas.	Yes
uniqueClusterCount	inteiro	Número total de clusters exclusivos.	Yes
uniqueSubclusterCount	inteiro	Número total de rótulos de subcluster exclusivos.	Yes
uso	objeto	Uso de token para análise de cluster	Yes
└─ inputTokenUsage	inteiro	Uso do token de entrada	Não
└─ outputTokenUsage	inteiro	Uso do token de saída	Não
└─ totalTokenUsage	inteiro	Uso total de token	Não

InsightType

O pedido dos insights.

Propriedade	Valor
Tipo	cadeia
Valores	EvaluationRunClusterInsight AgentClusterInsight EvaluationComparison

InsightsMetadata

Metadados sobre os insights.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
completedAt	cadeia	O carimbo de data/hora em que os insights foram concluídos.	Não
createdAt	cadeia	O carimbo de data/hora em que os insights foram criados.	Yes

ItemGenerationParams

Representa o conjunto de parâmetros usados para controlar as operações de geração de item.

Discriminador para ItemGenerationParams

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

Valor do tipo	Schema

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	cadeia	O tipo de parâmetros de geração de item a ser usado.	Yes

ManagedAzureAISearchIndex

Definição de índice de pesquisa de IA do Azure gerenciado

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
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	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Tipo de índice Valores possíveis: ManagedAzureSearch	Yes

MemoryItem

Um único item de memória armazenado no armazenamento de memória, contendo conteúdo e metadados.

Discriminador para MemoryItem

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

Valor do tipo	Schema
user_profile	UserProfileMemoryItem
chat_summary	ChatSummaryMemoryItem

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
conteúdo	cadeia	O conteúdo da memória.	Yes
variante	objeto	Tipo de item de memória.	Yes
memory_id	cadeia	A ID exclusiva do item de memória.	Yes
escopo	cadeia	O namespace que agrupa e isola logicamente as memórias, como um ID do usuário.	Yes
updated_at	inteiro	A hora da última atualização do item de memória.	Yes

MemoryItemKind

Tipo de item de memória.

Propriedade	Valor
Descrição	Tipo de item de memória.
Tipo	cadeia
Valores	user_profile chat_summary

MemoryOperation

Representa uma única operação de memória (criar, atualizar ou excluir) executada em um item de memória.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
variante	objeto	Tipo de operação de memória.	Yes
memory_item	objeto	Um único item de memória armazenado no armazenamento de memória, contendo conteúdo e metadados.	Yes
└─ conteúdo	cadeia	O conteúdo da memória.	Não
└─ tipo	MemoryItemKind	O tipo de item de memória.	Não
└─ memory_id	cadeia	A ID exclusiva do item de memória.	Não
└─ escopo	cadeia	O namespace que agrupa e isola logicamente as memórias, como um ID do usuário.	Não
└─ updated_at	inteiro	A hora da última 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.
Tipo	cadeia
Valores	create update delete

MemorySearchItem

Um item de memória recuperado da pesquisa de memória.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
memory_item	objeto	Um único item de memória armazenado no armazenamento de memória, contendo conteúdo e metadados.	Yes
└─ conteúdo	cadeia	O conteúdo da memória.	Não
└─ tipo	MemoryItemKind	O tipo de item de memória.	Não
└─ memory_id	cadeia	A ID exclusiva do item de memória.	Não
└─ escopo	cadeia	O namespace que agrupa e isola logicamente as memórias, como um ID do usuário.	Não
└─ updated_at	inteiro	A hora da última atualização do item de memória.	Não

MemorySearchOptions

Opções de pesquisa de memória.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
max_memories	inteiro	Número máximo de itens de memória a serem retornados.	Não

MemorySearchTool

Uma ferramenta para integrar memórias ao agente.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
memory_store_name	cadeia	O nome do repositório de memória a ser usado.	Yes
escopo	cadeia	O namespace usado para agrupar e isolar memórias, como um ID de usuário. Limita quais memórias podem ser recuperadas ou atualizadas. Use uma variável {{$userId}} especial para definir o escopo das memórias para o usuário conectado atual.	Yes
search_options	objeto	Opções de pesquisa de memória.	Não
└─ max_memories	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	inteiro	Tempo de espera antes de atualizar as memórias após inatividade (segundos). Padrão 300.	Não	300

MemorySearchToolCallItemParam

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
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	DESCRIÇÃO	Obrigatório	Padrão
results	matriz	Os resultados retornados da pesquisa de memória.	Não
status	enumeração	O status da chamada da ferramenta de pesquisa de memória. Uma opção entre in_progress, searching completed, incompleteou 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	DESCRIÇÃO	Obrigatório	Padrão
chat_model	cadeia	O nome ou identificador da implantação do modelo de conclusão de chat usado para processamento de memória.	Yes
embedding_model	cadeia	O nome ou identificador da implantação do modelo de inserção usado para processamento de memória.	Yes
variante	enumeração	O tipo de armazenamento de memória. Valores possíveis: default	Yes
Opções	objeto	Configurações padrão do armazenamento de memória.	Não
└─ chat_summary_enabled	boolean	Se a extração e o armazenamento do resumo do chat devem ser ativados. O padrão é true.	Não	Verdade
└─ user_profile_details	cadeia	Categorias ou tipos específicos de informações de perfil de usuário a serem extraídas e armazenadas.	Não
└─ user_profile_enabled	boolean	Se a extração e o armazenamento de perfil de usuário devem ser ativados. O padrão é true.	Não	Verdade

MemoryStoreDefaultOptions

Configurações padrão do armazenamento de memória.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
chat_summary_enabled	boolean	Se a extração e o armazenamento do resumo do chat devem ser ativados. O padrão é true.	Yes	Verdade
user_profile_details	cadeia	Categorias ou tipos específicos de informações de perfil de usuário a serem extraídas e armazenadas.	Não
user_profile_enabled	boolean	Se a extração e o armazenamento de perfil de usuário devem ser ativados. O padrão é true.	Yes	Verdade

MemoryStoreDefinition

Definição de base para configurações de armazenamento de memória.

Discriminador para MemoryStoreDefinition

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

Valor do tipo	Schema
default	MemoryStoreDefaultDefinition

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
variante	objeto	O tipo de implementação de armazenamento de memória a ser usada.	Yes

MemoryStoreDeleteScopeResponse

Resposta para excluir memórias de um escopo.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
excluído	boolean	Se a operação de exclusão foi bem-sucedida.	Yes
nome	cadeia	O nome do repositório de memória.	Yes
objeto	enumeração	O tipo de objeto. Sempre 'memory_store.scope.deleted'. Valores possíveis: memory_store.scope.deleted	Yes
escopo	cadeia	O escopo do qual as memórias foram excluídas.	Yes

MemoryStoreKind

O tipo de implementação de armazenamento de memória a ser usada.

Propriedade	Valor
Descrição	O tipo de implementação de armazenamento de memória a ser usada.
Tipo	cadeia
Valores	default

MemoryStoreObject

Um armazenamento de memória que pode armazenar e recuperar memórias do usuário.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
criado_em	inteiro	O carimbo de data/hora do Unix (segundos) quando o armazenamento de memória foi criado.	Yes
definição	objeto	Definição de base para configurações de armazenamento de memória.	Yes
└─ tipo	MemoryStoreKind	O tipo de armazenamento de memória.	Não
descrição	cadeia	Uma descrição legível do armazenamento de memória.	Não
id	cadeia	O identificador exclusivo do armazenamento de memória.	Yes
metadados	objeto	Metadados de valor-chave arbitrários a serem associados ao repositório de memória.	Não
nome	cadeia	O nome do repositório de memória.	Yes
objeto	enumeração	O tipo de objeto, que é sempre 'memory_store'. Valores possíveis: memory_store	Yes
updated_at	inteiro	O carimbo de data/hora 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	DESCRIÇÃO	Obrigatório	Padrão
embedding_tokens	inteiro	O número de tokens de inserção.	Yes
input_tokens	inteiro	O número de tokens de entrada.	Yes
input_tokens_details	objeto	Um detalhamento detalhado dos tokens de entrada.	Yes
└─ tokens em cache	inteiro	O número de tokens recuperados do cache. Mais informações sobre o cache de prompts.	Não
output_tokens	inteiro	O número de tokens de saída.	Yes
output_tokens_details	objeto	Um detalhamento detalhado dos tokens de saída.	Yes
└─ tokens_de_raciocínio	inteiro	O número de tokens de raciocínio.	Não
total_tokens	inteiro	O número total de tokens usados.	Yes

MemoryStoreSearchResponse

Resposta de pesquisa de memória.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
Memórias	matriz	Itens de memória relacionados encontrados durante a operação de pesquisa.	Yes
search_id	cadeia	A ID exclusiva dessa solicitação de pesquisa. Use esse valor como previous_search_id em solicitações subsequentes para executar pesquisas incrementais.	Yes
uso	objeto	Estatísticas de uso de uma operação de armazenamento de memória.	Yes
└─ embedding_tokens	inteiro	O número de tokens de inserção.	Não
└─ tokens de entrada	inteiro	O número de tokens de entrada.	Não
└─ detalhes_de_tokens_de_entrada	objeto	Um detalhamento detalhado dos tokens de entrada.	Não
└─ tokens em cache	inteiro	O número de tokens recuperados do cache. Mais informações sobre o cache de prompts.	Não
└─ tokens_de_saída	inteiro	O número de tokens de saída.	Não
└─ output_tokens_details	objeto	Um detalhamento detalhado dos tokens de saída.	Não
└─ tokens_de_raciocínio	inteiro	O número de tokens de raciocínio.	Não
└─ tokens_totais	inteiro	O número total de tokens usados.	Não

MemoryStoreUpdateCompletedResult

Resultado da atualização da memória.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
memory_operations	matriz	Uma lista de operações de memória individuais que foram executadas durante a atualização.	Yes
uso	objeto	Estatísticas de uso de uma operação de armazenamento de memória.	Yes
└─ embedding_tokens	inteiro	O número de tokens de inserção.	Não
└─ tokens de entrada	inteiro	O número de tokens de entrada.	Não
└─ detalhes_de_tokens_de_entrada	objeto	Um detalhamento detalhado dos tokens de entrada.	Não
└─ tokens em cache	inteiro	O número de tokens recuperados do cache. Mais informações sobre o cache de prompts.	Não
└─ tokens_de_saída	inteiro	O número de tokens de saída.	Não
└─ output_tokens_details	objeto	Um detalhamento detalhado dos tokens de saída.	Não
└─ tokens_de_raciocínio	inteiro	O número de tokens de raciocínio.	Não
└─ tokens_totais	inteiro	O número total de tokens usados.	Não

MemoryStoreUpdateResponse

Fornece o status de uma operação de atualização do repositório de memória.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
erro	objeto		Não
└─ Informação adicional	objeto		Não
└─ código	cadeia		Não
└─ debugInfo	objeto		Não
└─ detalhes	matriz		Não
Mensagem └─	cadeia		Não
└─ Param	cadeia		Não
└─ tipo	cadeia		Não
resultado	objeto	Resultado da atualização da 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
└─ uso	MemoryStoreOperationUsage	Estatísticas de uso associadas à operação de atualização de memória.	Não
status	objeto	Status de uma operação de atualização do repositório de memória.	Yes
superseded_by	cadeia	O update_id a operação foi substituído por quando o status é "substituído".	Não
update_id	cadeia	A ID exclusiva dessa solicitação de atualização. Use esse valor como previous_update_id em solicitações subsequentes para executar atualizações incrementais.	Yes

MemoryStoreUpdateStatus

Status de uma operação de atualização do repositório de memória.

Propriedade	Valor
Descrição	Status de uma operação de atualização do repositório de memória.
Tipo	cadeia
Valores	queued in_progress completed failed superseded

MicrosoftFabricAgentTool

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
fabric_dataagent_preview	objeto	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 conexão recurso anexado à 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	DESCRIÇÃO	Obrigatório	Padrão
capabilities	objeto	Recursos do modelo implantado	Yes
nome da conexão	cadeia	Nome da conexão de onde vem a implantação	Não
modelName	cadeia	Nome específico do editor do modelo implantado	Yes
modelPublisher	cadeia	Nome do editor do modelo implantado	Yes
modelVersion	cadeia	Versão específica do editor do modelo implantado	Yes
sku	objeto	Informações de SKU	Yes
└─ capacidade	inteiro	Capacidade de SKU	Não
└─ família	cadeia	Família Sku	Não
└─ nome	cadeia	Nome do SKU	Não
└─ tamanho	cadeia	Tamanho do SKU	Não
└─ camada	cadeia	Camada 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	DESCRIÇÃO	Obrigatório	Padrão
max_completion_tokens	inteiro	O número máximo de tokens permitidos na conclusão.	Yes
seed	inteiro	A semente aleatória para reprodutibilidade.	Yes
temperatura	número	O parâmetro de temperatura para amostragem.	Yes
top_p	número	O parâmetro top-p para amostragem de núcleo.	Yes

ModelSamplingParamsUpdate

Representa um conjunto de parâmetros usados para controlar o comportamento de amostragem de um modelo de linguagem durante a geração de texto.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
max_completion_tokens	inteiro	O número máximo de tokens permitidos na conclusão.	Não
seed	inteiro	A semente aleatória para 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úcleo.	Não

MonthlyRecurrenceSchedule

Cronograma mensal de recorrência.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
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	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	O tipo de credencial Valores possíveis: None	Yes

OAuthConsentRequestItemResource

Solicitação do serviço para que o usuário execute o consentimento do OAuth.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
consent_link	cadeia	O link que o usuário pode usar para executar o consentimento do OAuth.	Yes
id	cadeia		Yes
etiqueta_do_servidor	cadeia	O rótulo do servidor para a solicitação de consentimento OAuth.	Yes
tipo	enumeração	Valores possíveis: oauth_consent_request	Yes

OneTimeTrigger

Gatilho único.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
timeZone	cadeia	Fuso horário para o gatilho único.	Não	UTC
triggerAt	cadeia	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

Esse 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	DESCRIÇÃO	Obrigatório	Padrão
tipo	OpenAI.AnnotationType		Yes

OpenAI.AnnotationFileCitation

Uma citação a um arquivo.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
file_id	cadeia	A ID do arquivo.	Yes
filename	cadeia	O nome do arquivo citado.	Yes
indexar	inteiro	O índice do arquivo na lista de arquivos.	Yes
tipo	enumeração	O tipo da citação de arquivo. Sempre file_citation. Valores possíveis: file_citation	Yes

OpenAI.AnnotationFilePath

Um caminho para um arquivo.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
file_id	cadeia	A ID do arquivo.	Yes
indexar	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
Tipo	cadeia
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	DESCRIÇÃO	Obrigatório	Padrão
end_index	inteiro	O índice do último caractere da citação de URL na mensagem.	Yes
start_index	inteiro	O índice do primeiro caractere da citação de URL na mensagem.	Yes
title	cadeia	O título do recurso da Web.	Yes
tipo	enumeração	O tipo da citação de URL. Sempre url_citation. Valores possíveis: url_citation	Yes
url	cadeia	URL do recurso da Web.	Yes

OpenAI.ApproximateLocation

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
cidade	cadeia		Não
country	cadeia		Não
região	cadeia		Não
timezone	cadeia		Não
tipo	enumeração	Valores possíveis: approximate	Yes

Ferramenta de Conclusão de Chat da OpenAI

Uma ferramenta de função que pode ser usada para gerar uma resposta.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
função	OpenAI.FunctionObject		Yes
tipo	enumeração	O tipo da ferramenta. Atualmente, há suporte apenas para function. Valores possíveis: function	Yes

OpenAI.CodeInterpreterOutput

Discriminador para OpenAI.CodeInterpreterOutput

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

Valor do tipo	Schema
image	OpenAI.CodeInterpreterOutputImage
logs	OpenAI.CodeInterpreterOutputLogs

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	OpenAI.CodeInterpreterOutputType		Yes

OpenAI.CodeInterpreterOutputImage

A saída da imagem do interpretador de código.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	O tipo da saída. Sempre “imagem”. Valores possíveis: image	Yes
url	cadeia	A URL da saída da imagem do interpretador de código.	Yes

OpenAI.CodeInterpreterOutputLogs

A saída de logs do interpretador de código.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
logs	cadeia	A saída de logs do interpretador de código.	Yes
tipo	enumeração	O tipo da saída. Sempre “logs”. Valores possíveis: logs	Yes

OpenAI.CodeInterpreterOutputType

Propriedade	Valor
Tipo	cadeia
Valores	logs image

OpenAI.CodeInterpreterTool

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
contêiner	objeto	Configuração para um contêiner de interpretador de código. Especifique os identificadores opcionalmente dos arquivos em que executar o código.	Yes
└─ file_ids (identificadores de arquivo)	matriz	Uma lista opcional de arquivos carregados a serem disponibilizados para 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	DESCRIÇÃO	Obrigatório	Padrão
identificadores_de_arquivos	matriz	Uma lista opcional de arquivos carregados a serem disponibilizados para seu código.	Não
tipo	enumeração	Sempre auto. Valores possíveis: auto	Yes

OpenAI.CodeInterpreterToolCallItemParam

Uma chamada de ferramenta para executar o código.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
codificar	cadeia	O código a ser executado ou nulo se não estiver disponível.	Yes
container_id	cadeia	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 o código.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
codificar	cadeia	O código a ser executado ou nulo se não estiver disponível.	Yes
container_id	cadeia	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
status	enumeração	Valores possíveis: in_progress, , completed, incomplete, interpreting, failed	Yes
tipo	enumeração	Valores possíveis: code_interpreter_call	Yes

OpenAI.FiltroComparativo

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
chave	cadeia	A chave a ser comparada com o valor.	Yes
tipo	enumeração	Especifica o operador de comparação: eq (igual), ne (não igual), gt (maior que), gte (maior ou igual), lt (menor que) lte (menor ou igual). Valores possíveis: eq, , ne, gt, gte, , ltlte	Yes
valor	cadeia de caracteres ou número ou booleano		Yes

OpenAI.CompoundFilter

Combinar vários filtros usando and ou or.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
filters	matriz	Matriz de filtros a serem combinados. Os itens podem ser ComparisonFilter ou CompoundFilter.	Yes
tipo	enumeração	Tipo de operação: and ou or. Valores possíveis: and, or	Yes

OpenAI.ComputerAction

Discriminador para OpenAI.ComputerAction

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

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	DESCRIÇÃO	Obrigatório	Padrão
tipo	OpenAI.ComputerActionType		Yes

OpenAI.ComputerActionClick

Uma ação de clique.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
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, essa propriedade é sempre definido como click. Valores possíveis: click	Yes
x	inteiro	A coordenada x em que o clique ocorreu.	Yes
y	inteiro	A coordenada y em que o clique ocorreu.	Yes

OpenAI.ComputerActionDoubleClick

Uma ação de clique duplo.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Especifica o tipo de evento. Para uma ação de clique duplo, essa propriedade é sempre definido como double_click. Valores possíveis: double_click	Yes
x	inteiro	A coordenada x em que o clique duplo ocorreu.	Yes
y	inteiro	A coordenada y em que o clique duplo ocorreu.	Yes

OpenAI.ComputerActionDrag

Uma ação de arrastar.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
caminho	matriz	Uma matriz de coordenadas que representa o caminho da ação de arrastar. As coordenadas serão exibidas como uma matriz de objetos, por exemplo <br>[<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br>]<br>	Yes
tipo	enumeração	Especifica o tipo de evento. Para uma ação de arrastar, essa propriedade é sempre definido como drag. Valores possíveis: drag	Yes

OpenAI.ComputerActionKeyPress

Uma coleção de pressionamentos de teclas que o modelo deseja realizar.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
keys	matriz	A combinação de teclas que o modelo está solicitando que sejam pressionadas. 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 keypress, essa propriedade é sempre definido como keypress. Valores possíveis: keypress	Yes

OpenAI.ComputerActionMove

Uma ação de movimentação do mouse.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Especifica o tipo de evento. Para uma ação de movimentação, essa propriedade é sempre definido como move. Valores possíveis: move	Yes
x	inteiro	A coordenada x para a qual mover.	Yes
y	inteiro	A coordenada y para a qual mover.	Yes

OpenAI.ComputerActionScreenshot

Uma ação de captura de tela.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Especifica o tipo de evento. Para uma ação de captura de tela, essa propriedade é sempre definido como screenshot. Valores possíveis: screenshot	Yes

OpenAI.ComputerActionScroll

Uma ação de rolagem.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
scroll_x	inteiro	A distância de rolagem horizontal.	Yes
scroll_y	inteiro	A distância de rolagem vertical.	Yes
tipo	enumeração	Especifica o tipo de evento. Para uma ação de rolagem, essa propriedade é sempre definido como scroll. Valores possíveis: scroll	Yes
x	inteiro	A coordenada x em que a rolagem ocorreu.	Yes
y	inteiro	A coordenada y em que a rolagem ocorreu.	Yes

OpenAI.ComputerActionType

Propriedade	Valor
Tipo	cadeia
Valores	screenshot click double_click scroll type wait keypress drag move

OpenAI.ComputerActionTypeKeys

Uma ação para digitar texto.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
enviar SMS	cadeia	O texto a ser digitado.	Yes
tipo	enumeração	Especifica o tipo de evento. Para uma ação de tipo, essa propriedade é sempre definido como type. Valores possíveis: type	Yes

OpenAI.ComputerActionWait

Uma ação de espera.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Especifica o tipo de evento. Para uma ação de espera, essa propriedade é sempre definido como wait. Valores possíveis: wait	Yes

OpenAI.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	DESCRIÇÃO	Obrigatório	Padrão
ação	OpenAI.ComputerAction		Yes
call_id	cadeia	Um identificador usado ao responder à chamada de ferramenta com saída.	Yes
pending_safety_checks	matriz	As verificações de segurança pendentes para a chamada de 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	DESCRIÇÃO	Obrigatório	Padrão
ação	OpenAI.ComputerAction		Yes
call_id	cadeia	Um identificador usado ao responder à chamada de ferramenta com saída.	Yes
pending_safety_checks	matriz	As verificações de segurança pendentes para a chamada de computador.	Yes
status	enumeração	A situação do item. Um de in_progress, completed, ou incomplete. Populado quando os itens são retornados por meio da API. Valores possíveis: in_progress, , completedincomplete	Yes
tipo	enumeração	Valores possíveis: computer_call	Yes

OpenAI.ComputerToolCallOutputItemOutput

Discriminador para OpenAI.ComputerToolCallOutputItemOutput

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

Valor do tipo	Schema
computer_screenshot	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	OpenAI.ComputerToolCallOutputItemOutputType	Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.	Yes

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
file_id	cadeia		Não
image_url	cadeia		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.
Tipo	cadeia
Valores	computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

A saída de uma chamada de ferramenta de computador.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
acknowledged_safety_checks	matriz	As verificações de segurança relatadas pela API que foram confirmadas pela desenvolvedor.	Não
call_id	cadeia	A ID da chamada da ferramenta de computador que produziu a saída.	Yes
saída	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	DESCRIÇÃO	Obrigatório	Padrão
acknowledged_safety_checks	matriz	As verificações de segurança relatadas pela API que foram confirmadas pela desenvolvedor.	Não
call_id	cadeia	A ID da chamada da ferramenta de computador que produziu a saída.	Yes
saída	OpenAI.ComputerToolCallOutputItemOutput		Yes
status	enumeração	A situação do item. Um de in_progress, completed, ou incomplete. Populado quando os itens são retornados por meio da API. Valores possíveis: in_progress, , completedincomplete	Yes
tipo	enumeração	Valores possíveis: computer_call_output	Yes

OpenAI.ComputerToolCallSafetyCheck

Uma verificação de segurança pendente para a chamada de computador.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
codificar	cadeia	O tipo da verificação de segurança pendente.	Yes
id	cadeia	A ID da verificação de segurança pendente.	Yes
mensagem	cadeia	Detalhes sobre a verificação de segurança pendente.	Yes

OpenAI.ComputerUsePreviewTool

Uma ferramenta que controla um computador virtual.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
altura_do_display	inteiro	A altura da exibição do computador.	Yes
largura de exibição	inteiro	A largura da exibição do computador.	Yes
ambiente	enumeração	O tipo de ambiente de computador a ser controlado. Valores possíveis: windows, , mac, linux, ubuntu, browser	Yes
tipo	enumeração	O tipo da ferramenta de uso do computador. Sempre computer_use_preview. Valores possíveis: computer_use_preview	Yes

OpenAI.ConversationItemList

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
dados	matriz		Yes
first_id	cadeia		Yes
has_more	boolean		Yes
last_id	cadeia		Yes
objeto	enumeração	Valores possíveis: list	Yes

OpenAI.ConversationResource

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
criado_em	inteiro		Yes
id	cadeia	A ID exclusiva da conversa.	Yes
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
objeto	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	DESCRIÇÃO	Obrigatório	Padrão
x	inteiro	A coordenada x.	Yes
y	inteiro	A coordenada y.	Yes

OpenAI.CreateConversationRequest

Criar uma conversa

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
items	matriz	Itens iniciais para incluir o contexto da conversa. Você pode adicionar até 20 itens por vez.	Não
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

OpenAI.CreateEvalCompletionsRunDataSource

Um objeto CompletionsRunDataSource que descreve uma configuração de amostragem de modelo.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
mensagens_de_entrada	objeto		Não
└─ referência_item	cadeia		Não
└─ modelo	matriz		Não
└─ tipo	enumeração	Valores possíveis: item_reference	Não
modelo	cadeia	O nome do modelo a ser usado para gerar conclusões (por exemplo, "o3-mini").	Não
sampling_params	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		Não
fonte	objeto		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	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. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ modelo	cadeia		Não
└─ tipo	enumeração	O tipo de origem. 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	DESCRIÇÃO	Obrigatório	Padrão
item_reference	cadeia		Yes
tipo	enumeração	Valores possíveis: item_reference	Yes

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
modelo	matriz		Yes
tipo	enumeração	Valores possíveis: template	Yes

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
max_completion_tokens	OpenAI.integer		Não
esforço de raciocínio	Esforço de Raciocínio da OpenAI	Restringe o esforço de raciocínio para modelos de raciocínio. Atualmente, os valores com suporte são nenhum, mínimo, baixo, médio e alto. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio de uma resposta. gpt-5.1 usa como padrão nenhum, o que não executa o raciocínio. Os valores de raciocínio com suporte para gpt-5.1 são nenhum, baixo, médio e alto. Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. Todos os modelos antes do gpt-5.1 são padrão para o esforço de raciocínio médio e não dão suporte a nenhum. O modelo gpt-5-pro usa como padrão (e só dá suporte) ao alto esforço de raciocínio.	Não
formato_de_resposta	objeto	Formato de resposta padrão. Usado para gerar respostas de texto.	Não
└─ esquema_json	objeto	Opções de configuração de Saídas Estruturadas, incluindo um esquema JSON.	Não
└─ descrição	cadeia	Uma descrição do formato de resposta, usado pelo modelo para determinar como responder no formato.	Não
└─ nome	cadeia	O nome do formato de resposta. Deve ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com um comprimento máximo de 64.	Não
└─ esquema	objeto		Não
└─ rigoroso	boolean	Se deseja habilitar a adesão estrita do esquema ao gerar a saída. Se definido como true, o modelo sempre seguirá o esquema exato definido no campo schema. Há suporte apenas para um subconjunto de esquema JSON quando strict é true. Para saber mais, leia o guia de Saídas Estruturadas .	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	objeto		Não
temperatura	objeto		Não
Ferramentas	matriz		Não
top_p	objeto		Não

OpenAI.CreateEvalCustomDataSourceConfig

Um objeto CustomDataSourceConfig que define o esquema da fonte de dados usada para as execuções de avaliação. Esse esquema é usado para definir a forma dos dados que serão:

• Usados para definir seus critérios de teste e
• Quais dados são necessários ao criar uma execução

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
incluir_esquema_exemplo	boolean	Se a avaliação deve esperar que você preencha o namespace de exemplo (ou seja, gerando respostas a partir da sua fonte de dados)	Não
esquema_de_item	objeto	O esquema json para cada linha na fonte de dados.	Yes
tipo	enumeração	O tipo de fonte de dados. Sempre custom. Valores possíveis: custom	Yes

OpenAI.CreateEvalJsonlRunDataSource

Um objeto JsonlRunDataSource com o qual especifica um arquivo JSONL que corresponde à avaliação

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
fonte	objeto		Yes
└─ conteúdo	matriz	O conteúdo do arquivo jsonl.	Não
└─ id	cadeia	O identificador do arquivo.	Não
└─ tipo	enumeraçã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 dos metadados da consulta de logs. Geralmente, são metadados como usecase=chatbot ou prompt-version=v2etc.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
metadados	objeto	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	DESCRIÇÃO	Obrigatório	Padrão
mensagens_de_entrada	objeto		Não
└─ referência_item	cadeia		Não
└─ modelo	matriz		Não
└─ tipo	enumeração	Valores possíveis: item_reference	Não
modelo	cadeia	O nome do modelo a ser usado para gerar conclusões (por exemplo, "o3-mini").	Não
sampling_params	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Não
fonte	objeto		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	O identificador do arquivo.	Não
└─ instruções_busca	cadeia		Não
└─ metadados	objeto		Não
└─ modelo	cadeia		Não
└─ esforço_de_raciocínio	Esforço de Raciocínio da OpenAI	Restringe o esforço de raciocínio para modelos de raciocínio. Atualmente, os valores com suporte são nenhum, mínimo, baixo, médio e alto. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio de uma resposta. gpt-5.1 usa como padrão nenhum, o que não executa o raciocínio. Os valores de raciocínio com suporte para gpt-5.1 são nenhum, baixo, médio e alto. Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. Todos os modelos antes do gpt-5.1 são padrão para o esforço de raciocínio médio e não dão suporte a nenhum. O modelo gpt-5-pro usa como padrão (e só dá suporte) ao alto esforço de raciocínio.	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
└─ usuários	matriz		Não
tipo	enumeração	O tipo de fonte de dados de execução. Sempre responses. Valores possíveis: responses	Yes

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
item_reference	cadeia		Yes
tipo	enumeração	Valores possíveis: item_reference	Yes

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
modelo	matriz		Yes
tipo	enumeração	Valores possíveis: template	Yes

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
max_completion_tokens	OpenAI.integer		Não
esforço de raciocínio	Esforço de Raciocínio da OpenAI	Restringe o esforço de raciocínio para modelos de raciocínio. Atualmente, os valores com suporte são nenhum, mínimo, baixo, médio e alto. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio de uma resposta. gpt-5.1 usa como padrão nenhum, o que não executa o raciocínio. Os valores de raciocínio com suporte para gpt-5.1 são nenhum, baixo, médio e alto. Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. Todos os modelos antes do gpt-5.1 são padrão para o esforço de raciocínio médio e não dão suporte a nenhum. O modelo gpt-5-pro usa como padrão (e só dá suporte) ao alto esforço de raciocínio.	Não
seed	objeto		Não
temperatura	objeto		Não
enviar SMS	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		Não
Ferramentas	matriz		Não
top_p	objeto		Não

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

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

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

Preterido em favor de LogsDataSourceConfig.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
metadados	objeto	Filtros de metadados da fonte de dados de conclusões armazenadas.	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	DESCRIÇÃO	Obrigatório	Padrão
hiperparâmetros	objeto	Os hiperparâmetros usados no trabalho de ajuste fino. Agora, esse valor foi preterido em favor de method, e deve ser passado sob o parâmetro method.	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 habilitar seu trabalho de ajuste fino.	Não
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
método	OpenAI.FineTuneMethod	O método usado no ajuste fino.	Não
modelo	cadeia de caracteres (veja os modelos válidos abaixo)	O nome do modelo a ser refinado. Você pode selecionar um dos modelos com suporte.	Yes
seed	inteiro	A semente controla a reprodutibilidade do trabalho. Passar os mesmos parâmetros iniciais e de trabalho deve produzir os mesmos resultados, mas pode diferir em casos raros. Se uma semente não for especificada, uma será gerada para você.	Não
sufixo	cadeia	Uma cadeia de caracteres de até 64 caracteres que será adicionada ao seu nome de modelo ajustado. Por exemplo, um suffix "custom-model-name" produz um nome de modelo como ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.	Não	Nenhum
arquivo_de_treinamento	cadeia	A ID de um arquivo carregado que contém os dados de treinamento. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Além disso, você deve carregar seu arquivo com a finalidade fine-tune. O conteúdo do arquivo deve diferir dependendo se o modelo usa o formato de chat, conclusões 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
arquivo_de_validação	cadeia	A ID de um arquivo carregado que contém os dados de validação. Se você fornecer esse arquivo, os dados serão usados para gerar validação métricas periódicas durante o ajuste fino. Essas métricas podem ser exibidas em o arquivo de resultados de ajuste fino. Os mesmos dados não devem estar presentes nos arquivos de treinamento e validação. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Você deve carregar seu arquivo com a finalidade fine-tune. Consulte o guia de ajuste fino para obter mais detalhes.	Não

OpenAI.CreateFineTuningJobRequestIntegration

Discriminador para OpenAI.CreateFineTuningJobRequestIntegration

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

Valor do tipo	Schema
wandb	OpenAI.CreateFineTuningJobRequestWandbIntegration

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	cadeia de caracteres (veja os modelos válidos abaixo)		Yes

OpenAI.CreateFineTuningJobRequestWandbIntegration

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: wandb	Yes
wandb	objeto		Yes
└─ entidade	cadeia		Não
└─ nome	cadeia		Não
└─ projeto	cadeia		Não
└─ etiquetas	matriz		Não

OpenAI.CreateResponse

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
agente	objeto		Não
└─ nome	cadeia	O nome do agente.	Não
└─ tipo	enumeração	Valores possíveis: agent_reference	Não
└─ versão	cadeia	O identificador de versão do agente.	Não
em segundo plano	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas em segundo plano.	Não	Falso
conversa	objeto		Não
└─ id	cadeia		Não
incluir	matriz	Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Atualmente os valores com suporte são: - code_interpreter_call.outputs: inclui as saídas da execução de código python nos itens de chamada de ferramenta de interpretador de código. - computer_call_output.output.image_url: inclua urls de imagem da saída da chamada do computador. - file_search_call.results: incluir os resultados da pesquisa de a chamada da ferramenta de pesquisa de arquivos. - message.input_image.image_url: inclua urls de imagem da mensagem de entrada. - message.output_text.logprobs: inclua os logprobs com mensagens de assistente. - reasoning.encrypted_content: inclui uma versão criptografada do raciocínio tokens em saídas de item de raciocínio. Isso permite que itens de raciocínio sejam usados em conversas de vários turnos ao usar a API de Respostas sem estado (como quando o parâmetro store é definido como false, ou quando uma organização é registrado no programa de retenção de dados zero).	Não
entrada	cadeia de caracteres ou matriz		Não
instructions	cadeia	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao usar junto com previous_response_id, as instruções de uma resposta A resposta não será transferida para a próxima resposta. Isso torna simples para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.	Não
max_output_tokens	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	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	Não
parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
previous_response_id	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. Saiba mais sobre gerenciando o estado da conversa.	Não
solicitação	objeto	Referência a um modelo de prompt e suas variáveis. Saiba mais.	Não
└─ id	cadeia	O identificador exclusivo do modelo de prompt a ser usado.	Não
└─ variáveis	OpenAI.ResponsePromptVariables	Mapa opcional de valores a serem substituídos por variáveis no seu solicitação. Os valores de substituição podem ser cadeias de caracteres ou outros Tipos de entrada de resposta, como imagens ou arquivos.	Não
└─ versão	cadeia	Versão opcional do modelo de prompt.	Não
reasoning	objeto	somente modelos da série o Opções de configuração para modelos de raciocínio.	Não
└─ esforço	Esforço de Raciocínio da OpenAI	Restringe o esforço de raciocínio para modelos de raciocínio. Atualmente, os valores com suporte são nenhum, mínimo, baixo, médio e alto. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio de uma resposta. gpt-5.1 usa como padrão nenhum, o que não executa o raciocínio. Os valores de raciocínio com suporte para gpt-5.1 são nenhum, baixo, médio e alto. Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. Todos os modelos antes do gpt-5.1 são padrão para o esforço de raciocínio médio e não dão suporte a nenhum. O modelo gpt-5-pro usa como padrão (e só dá suporte) ao alto esforço de raciocínio.	Não
└─ gerar_resumo	enumeração	Preterido: use summary em vez disso. Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo. Uma opção entre auto, concise ou detailed. Valores possíveis: auto, , concisedetailed	Não
└─ resumo	enumeração	Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo. Uma opção entre auto, concise ou detailed. Valores possíveis: auto, , concisedetailed	Não
nível de serviço	objeto	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 configurado nas configurações do Projeto. A menos que esteja configurado de outra forma, o Projeto usará "padrão". * Se definido como 'padrão', a solicitação será processada com o padrão preços e desempenho para o modelo selecionado. * Se definido como 'flex' ou "prioridade", a solicitação será processada com o serviço correspondente camada. Entre em contato com as vendas para saber mais sobre o processamento de prioridade. * Quando não definido, o comportamento padrão é 'auto'. Quando o service_tier parâmetro for definido, o corpo da resposta incluirá o service_tier 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.	Não
armazenar	boolean	Se deseja armazenar a resposta do modelo gerado para recuperação posterior via API.	Não	Verdade
fluxo	boolean	Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente como ele é gerado usando eventos enviados pelo servidor. para obter mais informações.	Não	Falso
structured_inputs	objeto	As entradas estruturadas para a resposta que podem participar de substituição de modelo de prompt ou associações de argumento de ferramenta.	Não
temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou top_p, mas não as duas coisas.	Não	1
enviar SMS	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. Ver entradas e saídas de texto e saídas estruturadas	Não
└─ Formato	OpenAI.ResponseTextFormatConfiguration		Não
tool_choice	objeto	Controla qual ferramenta (se houver) é chamada pelo modelo. none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem. auto significa que o modelo pode escolher entre gerar uma mensagem ou 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 internas.	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 internas: ferramentas fornecidas pelo OpenAI que estendem o capacidades do modelo, como busca de arquivos - Chamadas de função (ferramentas personalizadas): funções definidas por você, permitindo que o modelo chame seu próprio código.	Não
top_logprobs	inteiro	Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada.	Não
top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa apenas os tokens que compõem os 10% superiores da massa de probabilidade%. são considerados. Geralmente recomendamos alterar isso ou temperature, mas não as duas coisas.	Não	1
truncation	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - auto: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - disabled (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: auto, disabled	Não
usuário	cadeia	Saiba mais sobre as práticas recomendadas de segurança.	Não

OpenAI.DeletedConversationResource

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
excluído	boolean		Yes
id	cadeia		Yes
objeto	enumeração	Valores possíveis: conversation.deleted	Yes

OpenAI.EasyInputMessage

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
conteúdo	cadeia de caracteres ou matriz		Yes
função	cadeia		Yes

OpenAI.Error

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
additionalInfo	objeto		Não
codificar	cadeia		Yes
debugInfo	objeto		Não
details	matriz		Não
mensagem	cadeia		Yes
param	cadeia		Yes
tipo	cadeia		Yes

OpenAI.EvalApiError

Um objeto que representa uma resposta de erro da API de Eval.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
codificar	cadeia	O código de erro.	Yes
mensagem	cadeia	A mensagem de erro.	Yes

OpenAI.EvalGraderLabelModel

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
entrada	matriz		Yes
labels	matriz	Os rótulos a serem atribuídos a cada item na avaliação.	Yes
modelo	cadeia	O modelo a ser usado para a avaliação. Deve dar suporte a saídas estruturadas.	Yes
nome	cadeia	O nome do avaliador.	Yes
etiquetas_de_passagem	matriz	Os rótulos que indicam um resultado aprovado. Deve ser um subconjunto de rótulos.	Yes
tipo	enumeração	O tipo de objeto, que é sempre label_model. Valores possíveis: label_model	Yes

OpenAI.EvalGraderPython

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
image_tag	cadeia	A marca da imagem a ser usada no script python.	Não
nome	cadeia	O nome do avaliador.	Yes
limite_de_passagem	objeto		Não
fonte	cadeia	O código-fonte do script python.	Yes
tipo	enumeração	O tipo de objeto, que é sempre python. Valores possíveis: python	Yes

OpenAI.EvalGraderScoreModel

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
entrada	matriz	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Yes
modelo	cadeia	O modelo a ser usado para a avaliação.	Yes
nome	cadeia	O nome do avaliador.	Yes
limite_de_passagem	objeto		Não
alcance	matriz	O intervalo da pontuação. Usa [0, 1] como padrão.	Não
sampling_params	objeto		Não
└─ max_completions_tokens	OpenAI.integer		Não
└─ esforço_de_raciocínio	Esforço de Raciocínio da OpenAI	Restringe o esforço de raciocínio para modelos de raciocínio. Atualmente, os valores com suporte são nenhum, mínimo, baixo, médio e alto. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio de uma resposta. gpt-5.1 usa como padrão nenhum, o que não executa o raciocínio. Os valores de raciocínio com suporte para gpt-5.1 são nenhum, baixo, médio e alto. Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. Todos os modelos antes do gpt-5.1 são padrão para o esforço de raciocínio médio e não dão suporte a nenhum. O modelo gpt-5-pro usa como padrão (e só dá suporte) ao alto esforço de raciocínio.	Não
└─ semente	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	DESCRIÇÃO	Obrigatório	Padrão
max_completions_tokens	objeto		Não
esforço de raciocínio	Esforço de Raciocínio da OpenAI	Restringe o esforço de raciocínio para modelos de raciocínio. Atualmente, os valores com suporte são nenhum, mínimo, baixo, médio e alto. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio de uma resposta. gpt-5.1 usa como padrão nenhum, o que não executa o raciocínio. Os valores de raciocínio com suporte para gpt-5.1 são nenhum, baixo, médio e alto. Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. Todos os modelos antes do gpt-5.1 são padrão para o esforço de raciocínio médio e não dão suporte a nenhum. O modelo gpt-5-pro usa como padrão (e só dá suporte) ao alto esforço de raciocínio.	Não
seed	objeto		Não
temperatura	objeto		Não
top_p	objeto		Não

OpenAI.EvalGraderStringCheck

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
entrada	cadeia	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Yes
nome	cadeia	O nome do avaliador.	Yes
operação	enumeração	A operação de verificação de cadeia de caracteres a ser executada. Uma opção entre eq, ne, like ou ilike. Valores possíveis: eq, , ne, likeilike	Yes
referência	cadeia	O texto de referência. Isso pode incluir cadeias de caracteres de modelo.	Yes
tipo	enumeração	O tipo de objeto, que é sempre string_check. Valores possíveis: string_check	Yes

OpenAI.EvalGraderTextSimilarity

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
métrica de avaliação	enumeração	A métrica de avaliação a ser usada. Uma opção entre cosine, fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, , rouge_3, rouge_4, , rouge_5 ou rouge_l. Valores possíveis: cosine, , fuzzy_match, bleu, gleu, meteor, rouge_1, , rouge_2, rouge_3, , rouge_4, , rouge_5rouge_l	Yes
entrada	cadeia	O texto que está sendo avaliado.	Yes
nome	cadeia	O nome do avaliador.	Yes
limite_de_passagem	objeto		Yes
referência	cadeia	O texto de referência para avaliação.	Yes
tipo	enumeração	O tipo de avaliador. Valores possíveis: text_similarity	Yes

OpenAI.EvalItem

Uma mensagem de entrada para o modelo com uma função que indica a hierarquia de instruções a seguir. As instruções fornecidas com a função developer ou system têm precedência sobre as instruções fornecidas com a função user. Presume-se que as mensagens com a assistant função tenham sido geradas pelo modelo em interações anteriores.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
conteúdo	objeto	Uma entrada de texto para o modelo.	Yes
└─ dados	cadeia	Dados de áudio codificados em Base64.	Não
└─ detalhe	cadeia		Não
└─ Formato	enumeração	O formato dos dados de áudio. Os formatos com suporte no momento são mp3 e wav. Valores possíveis: mp3, wav	Não
└─ URL da imagem	cadeia		Não
└─ texto	cadeia		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 de user, assistant, system ou developer. Valores possíveis: user, , assistant, systemdeveloper	Yes
tipo	enumeração	O tipo de entrada da mensagem. Sempre message. Valores possíveis: message	Não

OpenAI.EvalItemContentInputImage

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
detail	cadeia		Não
image_url	cadeia		Yes
tipo	enumeração	Valores possíveis: input_image	Yes

OpenAI.EvalItemContentOutputText

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
enviar SMS	cadeia		Yes
tipo	enumeração	Valores possíveis: output_text	Yes

OpenAI.EvalJsonlFileContentSource

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
conteúdo	matriz	O conteúdo do arquivo jsonl.	Yes
tipo	enumeração	Tipo de fonte jsonl. Sempre file_content. Valores possíveis: file_content	Yes

OpenAI.EvalJsonlFileContentSourceContent

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
item	objeto		Yes
amostra	objeto		Não

OpenAI.EvalJsonlFileIdSource

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
id	cadeia	O identificador do arquivo.	Yes
tipo	enumeração	Tipo de fonte jsonl. Sempre file_id. Valores possíveis: file_id	Yes

OpenAI.EvalResponsesSource

Um objeto EvalResponsesSource que descreve uma configuração de fonte de dados de execução.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
created_after	objeto		Não
criado_antes	objeto		Não
instructions_search	cadeia		Não
metadados	objeto		Não
modelo	cadeia		Não
esforço de raciocínio	objeto	Restringe o esforço de raciocínio para modelos de raciocínio. Atualmente, os valores com suporte são nenhum, mínimo, baixo, médio e alto. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio de uma resposta. gpt-5.1 usa como padrão nenhum, o que não executa o raciocínio. Os valores de raciocínio com suporte para gpt-5.1 são nenhum, baixo, médio e alto. Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. Todos os modelos antes do gpt-5.1 são padrão para o esforço de raciocínio médio e não dão suporte a nenhum. O modelo gpt-5-pro usa como padrão (e só dá suporte) ao alto esforço de raciocínio.	Não
temperatura	objeto		Não
Ferramentas	matriz		Não
top_p	objeto		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	DESCRIÇÃO	Obrigatório	Padrão
erro	OpenAI.EvalApiError	Um objeto que representa uma resposta de erro da API de Eval.	Yes
motivo_de_conclusão	cadeia		Yes
entrada	matriz		Yes
max_completion_tokens	OpenAI.integer		Yes
modelo	cadeia		Yes
saída	matriz		Yes
seed	OpenAI.integer		Yes
temperatura	OpenAI.numeric		Yes
top_p	OpenAI.numeric		Yes
uso	OpenAI.EvalRunOutputItemSampleUsage		Yes

OpenAI.EvalRunOutputItemSampleInput

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
conteúdo	cadeia		Yes
função	cadeia		Yes

OpenAI.EvalRunOutputItemSampleOutput

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
conteúdo	cadeia		Não
função	cadeia		Não

OpenAI.EvalRunOutputItemSampleUsage

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
cached_tokens	OpenAI.integer		Yes
completion_tokens	OpenAI.integer		Yes
prompt_tokens	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

OpenAI.EvalRunPerModelUsage

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
cached_tokens	OpenAI.integer		Yes
completion_tokens	OpenAI.integer		Yes
invocation_count	OpenAI.integer		Yes
model_name	cadeia		Yes
prompt_tokens	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

OpenAI.EvalRunPerTestingCriteriaResults

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
falhou	OpenAI.integer		Yes
passado	OpenAI.integer		Yes
critérios_de_teste	cadeia		Yes

OpenAI.EvalRunResultCounts

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
erro	OpenAI.integer		Yes
falhou	OpenAI.integer		Yes
passado	OpenAI.integer		Yes
total	OpenAI.integer		Yes

OpenAI.EvalStoredCompletionsSource

Uma configuração StoredCompletionsRunDataSource que descreve um conjunto de filtros

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
created_after	objeto		Não
criado_antes	objeto		Não
limit	objeto		Não
metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
modelo	cadeia		Não
tipo	enumeração	O tipo de origem. Sempre stored_completions. Valores possíveis: stored_completions	Yes

OpenAI.FileSearchTool

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
filters	objeto		Não
numero_maximo_de_resultados	inteiro	O número máximo de resultados a serem retornados. Esse número deve estar entre 1 e 50 inclusivo.	Não
opções_de_classificação	objeto		Não
└─ Ranker	enumeração	O classificador a ser usado para a pesquisa de arquivos. Valores possíveis: auto, default-2024-11-15	Não
└─ limite_de_pontuação	número	O limite de pontuação para a pesquisa de arquivos, um número entre 0 e 1. Números mais próximos de 1 tentarão retornar apenas os resultados mais relevantes, mas podem retornar menos resultados.	Não
tipo	enumeração	O tipo da ferramenta de pesquisa de arquivo. Sempre file_search. Valores possíveis: file_search	Yes
vector_store_ids	matriz	Os IDs dos repositórios de vetores a serem pesquisados.	Yes

OpenAI.FileSearchToolCallItemParam

Os resultados de uma chamada de ferramenta de pesquisa de arquivo. Consulte o guia de pesquisa de arquivos para obter mais informações.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
consultas	matriz	As consultas usadas para pesquisar arquivos.	Yes
results	matriz	Os resultados da chamada da ferramenta de pesquisa de arquivos.	Não
tipo	enumeração	Valores possíveis: file_search_call	Yes

OpenAI.FileSearchToolCallItemResource

Os resultados de uma chamada de ferramenta de pesquisa de arquivo. Consulte o guia de pesquisa de arquivos para obter mais informações.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
consultas	matriz	As consultas usadas para pesquisar arquivos.	Yes
results	matriz	Os resultados da chamada da ferramenta de pesquisa de arquivos.	Não
status	enumeração	O status da chamada da ferramenta de pesquisa de arquivos. Uma opção entre in_progress, searching, incomplete ou failed, Valores possíveis: in_progress, , searching, completed, incomplete, failed	Yes
tipo	enumeração	Valores possíveis: file_search_call	Yes

OpenAI.Filters

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
filters	matriz	Matriz de filtros a serem combinados. Os itens podem ser ComparisonFilter ou CompoundFilter.	Yes
chave	cadeia	A chave a ser comparada com o valor.	Yes
tipo	enumeração	Tipo de operação: and ou or. Valores possíveis: and, or	Yes
valor	cadeia de caracteres ou número ou booleano	O valor a ser comparado com a chave de atributo; dá suporte a tipos de cadeia de caracteres, número ou booliano.	Yes

OpenAI.FineTuneDPOHyperparameters

Os hiperparâmetros usados no trabalho de ajuste fino do DPO.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tamanho_do_lote	enumeração	Valores possíveis: auto	Não
beta	enumeração	Valores possíveis: auto	Não
multiplicador_da_taxa_de_aprendizado	enumeração	Valores possíveis: auto	Não
n_épocas	enumeração	Valores possíveis: auto	Não

OpenAI.FineTuneDPOMethod

Configuração do método de ajuste fino do DPO.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
hiperparâmetros	OpenAI.FineTuneDPOHyperparameters	Os hiperparâmetros usados no trabalho de ajuste fino do DPO.	Não

OpenAI.FineTuneMethod

O método usado no ajuste fino.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
dpo	OpenAI.FineTuneDPOMethod	Configuração do 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 do método de ajuste fino a ser supervisionado.	Não
tipo	enumeração	O tipo de método. É, supervised, dpoou reinforcement. Valores possíveis: supervised, , dporeinforcement	Yes

OpenAI.FineTuneReinforcementHyperparameters

Os hiperparâmetros usados no trabalho de ajuste fino de reforço.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tamanho_do_lote	enumeração	Valores possíveis: auto	Não
compute_multiplier	enumeração	Valores possíveis: auto	Não
eval_interval	enumeração	Valores possíveis: auto	Não
eval_samples	enumeração	Valores possíveis: auto	Não
multiplicador_da_taxa_de_aprendizado	enumeração	Valores possíveis: auto	Não
n_é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, mediumhigh	Não

OpenAI.FineTuneReinforcementMethod

Configuração para o método de ajuste fino de reforço.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
motoniveladora	objeto	Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada.	Yes
└─ calculate_output	cadeia	Uma fórmula para calcular a saída com base nos resultados do avaliador.	Não
└─ métrica_de_avaliação	enumeração	A métrica de avaliação a ser usada. Uma opção entre cosine, fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, , rouge_3, rouge_4, , rouge_5 ou rouge_l. Valores possíveis: cosine, , fuzzy_match, bleu, gleu, meteor, rouge_1, , rouge_2, rouge_3, , rouge_4, , rouge_5rouge_l	Não
└─ classificadores	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
└─ etiqueta_de_imagem	cadeia	A marca da imagem a ser usada no script python.	Não
└─ entrada	matriz	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Não
└─ modelo	cadeia	O modelo a ser usado para a avaliação.	Não
└─ nome	cadeia	O nome do avaliador.	Não
└─ Operação	enumeração	A operação de verificação de cadeia de caracteres a ser executada. Uma opção entre eq, ne, like ou ilike. Valores possíveis: eq, , ne, likeilike	Não
└─ intervalo	matriz	O intervalo da pontuação. Usa [0, 1] como padrão.	Não
└─ Referência	cadeia	O texto de referência para avaliação.	Não
└─ parâmetros_de_amostragem	OpenAI.EvalGraderScoreModelSamplingParams	Os parâmetros de amostragem do modelo.	Não
└─ origem	cadeia	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 usados no trabalho de ajuste fino de reforço.	Não

OpenAI.FineTuneSupervisedHyperparameters

Os hiperparâmetros usados no trabalho de ajuste fino.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tamanho_do_lote	enumeração	Valores possíveis: auto	Não
multiplicador_da_taxa_de_aprendizado	enumeração	Valores possíveis: auto	Não
n_épocas	enumeração	Valores possíveis: auto	Não

OpenAI.FineTuneSupervisedMethod

Configuração do método de ajuste fino a ser supervisionado.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
hiperparâmetros	OpenAI.FineTuneSupervisedHyperparameters	Os hiperparâmetros usados no trabalho de ajuste fino.	Não

OpenAI.FineTuningIntegration

Discriminatório para OpenAI.FineTuningIntegration

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

Valor do tipo	Schema
wandb	OpenAI.FineTuningIntegrationWandb

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	cadeia de caracteres (veja os modelos válidos abaixo)		Yes

OpenAI.FineTuningIntegrationWandb

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	O tipo da integração que está sendo habilitada para o trabalho de ajuste fino Valores possíveis: wandb	Yes
wandb	objeto	As configurações para sua integração com Pesos e Vieses. Esta carga útil especifica o projeto para o qual as métricas serão enviadas. Opcionalmente, você pode definir um nome de exibição explícito para sua execução, adicionar marcas à sua execução e definir uma entidade padrão (equipe, nome de usuário, etc.) a ser associada à sua execução.	Yes
└─ entidade	cadeia	A entidade a ser usada para a execução. Isso permite que você defina a equipe ou o nome de usuário do WandB que você quer associar à execução. Se não estiver definido, será usada a entidade padrão para a chave de API do WandB registrada.	Não
└─ nome	cadeia	Um nome de exibição a ser definido para a execução. Se não estiver definido, usaremos a ID do trabalho como o nome.	Não
└─ projeto	cadeia	O nome do projeto no qual a nova execução será criada.	Não
└─ etiquetas	matriz	Uma lista de marcas a serem anexadas à execução recém-criada. Essas marcas são passadas diretamente para o WandB. Alguns as marcas padrão são geradas pelo OpenAI: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".	Não

OpenAI.FineTuningJob

O objeto fine_tuning.job representa um trabalho de ajuste fino que foi criado pela API.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
criado_em	inteiro	O carimbo de data/hora Unix (em segundos) da criação da tarefa de ajuste fino.	Yes
erro	objeto	Quanto aos trabalhos de ajuste fino que tenham failed, isso conterá mais informações sobre a causa da falha.	Yes
└─ código	cadeia	Um código de erro legível pelo computador.	Não
Mensagem └─	cadeia	Uma mensagem de erro legível por humanos.	Não
└─ Param	cadeia	O parâmetro que era inválido, geralmente training_file ou validation_file. Esse campo será nulo se a falha não tiver sido específica do parâmetro.	Não
estimativa de conclusão	inteiro	O carimbo de data/hora unix (em segundos) para quando o trabalho de ajuste fino é estimado para ser concluído. O valor será nulo se o trabalho de ajuste fino não estiver em execução.	Não
fine_tuned_model	cadeia	O nome do modelo ajustado que está sendo criado. O valor será nulo se o trabalho de ajuste fino ainda estiver em execução.	Yes
finished_at	inteiro	O carimbo de data/hora Unix (em segundos) de quando o trabalho de ajuste fino foi concluído. O valor será nulo se o trabalho de ajuste fino ainda estiver em execução.	Yes
hiperparâmetros	objeto	Os hiperparâmetros usados no trabalho de ajuste fino. Esse valor só será retornado ao executar os trabalhos supervised.	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	O identificador do objeto, que pode ser referenciado nos pontos de extremidade da API.	Yes
Integrações	matriz	Uma lista de integrações para habilitar esse trabalho de ajuste fino.	Não
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
método	OpenAI.FineTuneMethod	O método usado no ajuste fino.	Não
modelo	cadeia	O modelo base que está sendo ajustado.	Yes
objeto	enumeração	O tipo de objeto, o qual será sempre "fine_tuning.job". Valores possíveis: fine_tuning.job	Yes
organization_id	cadeia	A organização que possui o trabalho de ajuste fino.	Yes
arquivos_de_resultado	matriz	As IDs do arquivo de resultados compilados para o trabalho de ajuste fino. Você pode recuperar os resultados com a API de Arquivos.	Yes
seed	inteiro	A posição inicial usada para o trabalho de ajuste fino.	Yes
status	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, , failedcancelled	Yes
trained_tokens	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
arquivo_de_treinamento	cadeia	A ID do arquivo usada para treinamento. Você pode recuperar os dados de treinamento com a API de Arquivos.	Yes
user_provided_suffix	cadeia	O sufixo descritivo aplicado ao trabalho, conforme especificado na solicitação de criação do trabalho.	Não
arquivo_de_validação	cadeia	A ID do arquivo usada para validação. Você pode recuperar os resultados de validação com a API de Arquivos.	Yes

OpenAI.FineTuningJobCheckpoint

O objeto fine_tuning.job.checkpoint representa um ponto de verificação de modelo para um trabalho de ajuste fino que está pronto para ser usado.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
criado_em	inteiro	O carimbo de data/hora unix (em segundos) para quando o ponto de verificação foi criado.	Yes
fine_tuned_model_checkpoint	cadeia	O nome do modelo de ponto de verificação ajustado que é criado.	Yes
fine_tuning_job_id	cadeia	O nome do trabalho de ajuste fino do qual esse ponto de verificação foi criado.	Yes
id	cadeia	O identificador de ponto de verificação, que pode ser referenciado nos pontos de extremidade da API.	Yes
métricas	objeto	Métricas no número da etapa durante o trabalho de ajuste fino.	Yes
└─ perda_total_de_validacao	número		Não
└─ precisão_média_de_tokens_válidos_completos	número		Não
└─ etapa	número		Não
└─ perda_ao_treinar (train_loss)	número		Não
└─ precisão_média_de_tokens_em_treinamento (train_mean_token_accuracy)	número		Não
└─ perda_de_validação	número		Não
└─ precisão_média_dos_tokens_válidos	número		Não
objeto	enumeração	O tipo de objeto, o qual será sempre "fine_tuning.job.checkpoint". Valores possíveis: fine_tuning.job.checkpoint	Yes
número_do_passo	inteiro	O número da etapa em que o ponto de verificação foi criado.	Yes

OpenAI.FineTuningJobEvent

Ajustar objeto de evento de trabalho

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
criado_em	inteiro	O carimbo de data/hora Unix (em segundos) da criação da tarefa de ajuste fino.	Yes
dados		Os dados associados ao evento.	Não
id	cadeia	O identificador do objeto.	Yes
nível	enumeração	O nível de log do evento. Valores possíveis: info, , warnerror	Yes
mensagem	cadeia	A mensagem do evento.	Yes
objeto	enumeração	O tipo de objeto, o qual será sempre "fine_tuning.job.event". Valores possíveis: fine_tuning.job.event	Yes
tipo	enumeração	O tipo do evento. Valores possíveis: message, metrics	Não

OpenAI.FunctionObject

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	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	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 aceitos pelas funções, 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	boolean	Se deseja habilitar a adesão estrita do esquema ao gerar a chamada de função. Se definido como true, o modelo seguirá o esquema exato definido no campo parameters. Somente um subconjunto de esquema JSON tem suporte quando strict é true. Saiba mais sobre saídas estruturadas no	Não	Falso

OpenAI.FunctionTool

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	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	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	boolean	Se deve impor a validação estrita de parâmetro. 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	DESCRIÇÃO	Obrigatório	Padrão
argumentos	cadeia	Uma cadeia de caracteres JSON dos argumentos a serem passados para a função.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Yes
nome	cadeia	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	DESCRIÇÃO	Obrigatório	Padrão
argumentos	cadeia	Uma cadeia de caracteres JSON dos argumentos a serem passados para a função.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Yes
nome	cadeia	O nome da função a ser executada.	Yes
status	enumeração	A situação do item. Um de in_progress, completed, ou incomplete. Populado quando os itens são retornados por meio da API. Valores possíveis: in_progress, , completedincomplete	Yes
tipo	enumeração	Valores possíveis: function_call	Yes

OpenAI.FunctionToolCallOutputItemParam

A saída de uma chamada de ferramenta de função.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Yes
saída	cadeia	Uma cadeia de caracteres JSON da saída da chamada da ferramenta de função.	Yes
tipo	enumeração	Valores possíveis: function_call_output	Yes

OpenAI.FunctionToolCallOutputItemResource

A saída de uma chamada de ferramenta de função.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Yes
saída	cadeia	Uma cadeia de caracteres JSON da saída da chamada da ferramenta de função.	Yes
status	enumeração	A situação do item. Um de in_progress, completed, ou incomplete. Populado quando os itens são retornados por meio da API. Valores possíveis: in_progress, , completedincomplete	Yes
tipo	enumeração	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	DESCRIÇÃO	Obrigatório	Padrão
entrada	matriz		Yes
labels	matriz	Os rótulos a serem atribuídos a cada item na avaliação.	Yes
modelo	cadeia	O modelo a ser usado para a avaliação. Deve dar suporte a saídas estruturadas.	Yes
nome	cadeia	O nome do avaliador.	Yes
etiquetas_de_passagem	matriz	Os rótulos que indicam um resultado aprovado. Deve ser um subconjunto de rótulos.	Yes
tipo	enumeração	O tipo de objeto, que é sempre label_model. Valores possíveis: label_model	Yes

OpenAI.GraderMulti

Um objeto MultiGrader combina os resultados de vários avaliadores para produzir uma única pontuação.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
calculate_output	cadeia	Uma fórmula para calcular a saída com base nos resultados do avaliador.	Yes
Série	objeto	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. Uma opção entre cosine, fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, , rouge_3, rouge_4, , rouge_5 ou rouge_l. Valores possíveis: cosine, , fuzzy_match, bleu, gleu, meteor, rouge_1, , rouge_2, rouge_3, , rouge_4, , rouge_5rouge_l	Não
└─ etiqueta_de_imagem	cadeia	A marca da imagem a ser usada no script python.	Não
└─ entrada	matriz		Não
└─ rótulos	matriz	Os rótulos a serem atribuídos a cada item na avaliação.	Não
└─ modelo	cadeia	O modelo a ser usado para a avaliação. Deve dar suporte a saídas estruturadas.	Não
└─ nome	cadeia	O nome do avaliador.	Não
└─ Operação	enumeração	A operação de verificação de cadeia de caracteres a ser executada. Uma opção entre eq, ne, like ou ilike. Valores possíveis: eq, , ne, likeilike	Não
└─ passing_labels	matriz	Os rótulos que indicam um resultado aprovado. Deve ser um subconjunto de rótulos.	Não
└─ intervalo	matriz	O intervalo da pontuação. Usa [0, 1] como padrão.	Não
└─ Referência	cadeia	O texto de referência para avaliação.	Não
└─ parâmetros_de_amostragem	OpenAI.EvalGraderScoreModelSamplingParams	Os parâmetros de amostragem do modelo.	Não
└─ origem	cadeia	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	O nome do avaliador.	Yes
tipo	enumeração	O tipo de objeto, que é sempre multi. Valores possíveis: multi	Yes

OpenAI.GraderPython

Um objeto PythonGrader que executa um script python na entrada.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
image_tag	cadeia	A marca da imagem a ser usada no script python.	Não
nome	cadeia	O nome do avaliador.	Yes
fonte	cadeia	O código-fonte do script python.	Yes
tipo	enumeração	O tipo de objeto, que é sempre python. Valores possíveis: python	Yes

OpenAI.GraderScoreModel

Um objeto ScoreModelGrader que usa um modelo para atribuir uma pontuação à entrada.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
entrada	matriz	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Yes
modelo	cadeia	O modelo a ser usado para a avaliação.	Yes
nome	cadeia	O nome do avaliador.	Yes
alcance	matriz	O intervalo da pontuação. Usa [0, 1] como padrão.	Não
sampling_params	objeto		Não
└─ max_completions_tokens	OpenAI.integer		Não
└─ esforço_de_raciocínio	Esforço de Raciocínio da OpenAI	Restringe o esforço de raciocínio para modelos de raciocínio. Atualmente, os valores com suporte são nenhum, mínimo, baixo, médio e alto. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio de uma resposta. gpt-5.1 usa como padrão nenhum, o que não executa o raciocínio. Os valores de raciocínio com suporte para gpt-5.1 são nenhum, baixo, médio e alto. Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. Todos os modelos antes do gpt-5.1 são padrão para o esforço de raciocínio médio e não dão suporte a nenhum. O modelo gpt-5-pro usa como padrão (e só dá suporte) ao alto esforço de raciocínio.	Não
└─ semente	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	DESCRIÇÃO	Obrigatório	Padrão
entrada	cadeia	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Yes
nome	cadeia	O nome do avaliador.	Yes
operação	enumeração	A operação de verificação de cadeia de caracteres a ser executada. Uma opção entre eq, ne, like ou ilike. Valores possíveis: eq, , ne, likeilike	Yes
referência	cadeia	O texto de referência. Isso pode incluir cadeias de caracteres de modelo.	Yes
tipo	enumeração	O tipo de objeto, que é sempre string_check. Valores possíveis: string_check	Yes

OpenAI.GraderTextSimilarity

Um objeto TextSimilarityGrader que classifica o texto com base em métricas de similaridade.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
métrica de avaliação	enumeração	A métrica de avaliação a ser usada. Uma opção entre cosine, fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, , rouge_3, rouge_4, , rouge_5 ou rouge_l. Valores possíveis: cosine, , fuzzy_match, bleu, gleu, meteor, rouge_1, , rouge_2, rouge_3, , rouge_4, , rouge_5rouge_l	Yes
entrada	cadeia	O texto que está sendo avaliado.	Yes
nome	cadeia	O nome do avaliador.	Yes
referência	cadeia	O texto de referência para avaliação.	Yes
tipo	enumeração	O tipo de avaliador. Valores possíveis: text_similarity	Yes

OpenAI.ImageGenTool

Uma ferramenta que gera imagens usando um modelo como gpt-image-1.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
em segundo plano	enumeração	Tipo de plano de fundo para a imagem gerada. Uma opção entre transparent, opaque ou auto. Padrão: auto. Valores possíveis: transparent, , opaqueauto	Não
input_image_mask	objeto	Máscara opcional para inpainting. Contém image_url (cadeia de caracteres, opcional) e file_id (cadeia de caracteres, opcional).	Não
└─ identificador_de_arquivo	cadeia	ID do arquivo para a imagem da máscara.	Não
└─ URL da imagem	cadeia	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	inteiro	Nível de compactação para a imagem de saída. Padrão: 100.	Não	100
formato de saída	enumeração	O formato de saída da imagem gerada. Um de png, webp, ou jpeg. Padrão: png. Valores possíveis: png, , webpjpeg	Não
imagens parciais	inteiro	Número de imagens parciais a serem geradas no modo de streaming, de 0 (valor padrão) a 3.	Não	0
quality	enumeração	A qualidade da imagem gerada. Uma opção entre low, medium, high, ou auto. Padrão: auto. Valores possíveis: low, , medium, highauto	Não
size	enumeração	O tamanho da imagem gerada. Uma opção entre 1024x1024, 1024x1536, 1536x1024 ou auto. Padrão: auto. Valores possíveis: 1024x1024, , 1024x1536, 1536x1024auto	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

Uma solicitação de geração de imagem feita pelo modelo.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
resultado	cadeia	A imagem gerada codificada em base64.	Yes
tipo	enumeração	Valores possíveis: image_generation_call	Yes

OpenAI.ImageGenToolCallItemResource

Uma solicitação de geração de imagem feita pelo modelo.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
resultado	cadeia	A imagem gerada codificada em base64.	Yes
status	enumeração	Valores possíveis: in_progress, , completed, generatingfailed	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 com suporte no momento são:

• code_interpreter_call.outputs: inclui os resultados da execução do código python nos itens de chamada da ferramenta interpretadora de código.
• computer_call_output.output.image_url: inclua urls de imagem da saída da chamada do computador.
• file_search_call.results: inclua os resultados da pesquisa da chamada da ferramenta de pesquisa de arquivos.
• message.input_image.image_url: inclua urls de imagem da mensagem de entrada.
• message.output_text.logprobs: inclua logprobs com mensagens de assistente.
• reasoning.encrypted_content: inclui uma versão criptografada de tokens de raciocínio em saídas de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em conversas de vários turnos ao utilizar a API de Respostas sem estado (como quando o parâmetro store é definido para false, ou quando uma organização está inscrita no programa de retenção de dados zero).

Propriedade	Valor
Descrição	Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Atualmente os valores com suporte são: - code_interpreter_call.outputs: inclui as saídas da execução de código python nos itens de chamada de ferramenta de interpretador de código. - computer_call_output.output.image_url: inclua urls de imagem da saída da chamada do computador. - file_search_call.results: incluir os resultados da pesquisa de a chamada da ferramenta de pesquisa de arquivos. - message.input_image.image_url: inclua urls de imagem da mensagem de entrada. - message.output_text.logprobs: inclua os logprobs com mensagens de assistente. - reasoning.encrypted_content: inclui uma versão criptografada do raciocínio tokens em saídas de item de raciocínio. Isso permite que itens de raciocínio sejam usados em conversas de vários turnos ao usar a API de Respostas sem estado (como quando o parâmetro store é definido como false, ou quando uma organização é registrado no programa de retenção de dados zero).
Tipo	cadeia
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

Esse 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	DESCRIÇÃO	Obrigatório	Padrão
tipo	OpenAI.ItemContentType	Conteúdo de entrada e saída multi modal.	Yes

OpenAI.ItemContentInputAudio

Uma entrada de áudio para o modelo.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
dados	cadeia	Dados de áudio codificados em Base64.	Yes
format	enumeração	O formato dos dados de áudio. Os formatos com suporte no momento 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	DESCRIÇÃO	Obrigatório	Padrão
file_data	cadeia	O conteúdo do arquivo a ser enviado para o modelo.	Não
file_id	cadeia	A ID do arquivo a ser enviado para o modelo.	Não
filename	cadeia	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	DESCRIÇÃO	Obrigatório	Padrão
detail	enumeração	O nível de detalhes da imagem a ser enviada para o modelo. Uma opção entre high, low ou auto. Usa auto como padrão. Valores possíveis: low, , highauto	Não
file_id	cadeia	A ID do arquivo a ser enviado para o modelo.	Não
image_url	cadeia	A URL da imagem a ser enviada para o modelo. Uma URL totalmente qualificada ou uma imagem codificada em base64 em uma 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	DESCRIÇÃO	Obrigatório	Padrão
enviar SMS	cadeia	A entrada de texto para o modelo.	Yes
tipo	enumeração	O tipo do item de entrada. Sempre input_text. Valores possíveis: input_text	Yes

OpenAI.ItemContentOutputAudio

Uma saída de áudio do modelo.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
dados	cadeia	Dados de áudio do modelo codificados em Base64.	Yes
transcrição	cadeia	A transcrição dos dados de áudio provenientes do modelo.	Yes
tipo	enumeração	O tipo do áudio de saída. Sempre output_audio. Valores possíveis: output_audio	Yes

OpenAI.ItemContentOutputText

Uma saída de texto do modelo.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
Anotações	matriz	As anotações da saída de texto.	Yes
logprobs	matriz		Não
enviar SMS	cadeia	A saída de texto do modelo.	Yes
tipo	enumeração	O tipo do texto de saída. Sempre output_text. Valores possíveis: output_text	Yes

OpenAI.ItemContentRefusal

Uma recusa do modelo.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
recusa	cadeia	A explicação da recusa do modelo.	Yes
tipo	enumeração	O tipo da recusa. Sempre refusal. Valores possíveis: refusal	Yes

OpenAI.ItemContentType

Conteúdo de entrada e saída multi modal.

Propriedade	Valor
Descrição	Conteúdo de entrada e saída multi modal.
Tipo	cadeia
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

Esse 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	DESCRIÇÃO	Obrigatório	Padrão
tipo	OpenAI.ItemType		Yes

OpenAI.ItemReferenceItemParam

Um identificador interno para um item a ser referenciado.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
id	cadeia	A ID originada pelo serviço do item de resposta gerado anteriormente sendo referenciado.	Yes
tipo	enumeração	Valores possíveis: item_reference	Yes

OpenAI.ItemResource

Item de conteúdo usado para gerar uma resposta.

Discriminador para OpenAI.ItemResource

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

Valor do tipo	Schema
structured_outputs	StructuredOutputsItemResource
workflow_action	WorkflowActionOutputItemResource
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	DESCRIÇÃO	Obrigatório	Padrão
created_by	objeto		Não
└─ agente	AgentId	O agente que criou o item.	Não
└─ response_id	cadeia	A resposta na qual o item é criado.	Não
id	cadeia		Yes
tipo	OpenAI.ItemType		Yes

OpenAI.ItemType

Propriedade	Valor
Tipo	cadeia
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	DESCRIÇÃO	Obrigatório	Padrão
dados	matriz		Yes
first_id	cadeia		Não
has_more	boolean		Yes
last_id	cadeia		Não
objeto	enumeração	Valores possíveis: list	Yes

OpenAI.ListFineTuningJobEventsResponse

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
dados	matriz		Yes
has_more	boolean		Yes
objeto	enumeração	Valores possíveis: list	Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
dados	matriz		Yes
has_more	boolean		Yes
objeto	enumeração	Valores possíveis: list	Yes

OpenAI.LocalShellExecAction

Execute um comando shell no servidor.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
command	matriz	O comando a ser executado.	Yes
Env	objeto	Variáveis de ambiente a serem definidas para o comando.	Yes
tempo_de_espera_ms	inteiro	Tempo limite opcional em milissegundos para o comando.	Não
tipo	enumeração	O tipo da ação do shell local. Sempre exec. Valores possíveis: exec	Yes
usuário	cadeia	Usuário opcional para executar o comando como.	Não
working_directory	cadeia	Diretório de trabalho opcional para executar o comando.	Não

OpenAI.LocalShellTool

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	O tipo da 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	DESCRIÇÃO	Obrigatório	Padrão
ação	OpenAI.LocalShellExecAction	Execute um comando shell no servidor.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Yes
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	DESCRIÇÃO	Obrigatório	Padrão
ação	OpenAI.LocalShellExecAction	Execute um comando shell no servidor.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Yes
status	enumeração	Valores possíveis: in_progress, , completedincomplete	Yes
tipo	enumeração	Valores possíveis: local_shell_call	Yes

OpenAI.LocalShellToolCallOutputItemParam

A saída de uma chamada de ferramenta de shell local.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
saída	cadeia	Uma cadeia de caracteres JSON da saída da chamada da ferramenta de shell local.	Yes
tipo	enumeração	Valores possíveis: local_shell_call_output	Yes

OpenAI.LocalShellToolCallOutputItemResource

A saída de uma chamada de ferramenta de shell local.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
saída	cadeia	Uma cadeia de caracteres JSON da saída da chamada da ferramenta de shell local.	Yes
status	enumeração	Valores possíveis: in_progress, , completedincomplete	Yes
tipo	enumeração	Valores possíveis: local_shell_call_output	Yes

OpenAI.Location

Discriminador para OpenAI.Location

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

Valor do tipo	Schema
approximate	OpenAI.ApproximateLocation

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	OpenAI.LocationType		Yes

OpenAI.LocationType

Propriedade	Valor
Tipo	cadeia
Valores	approximate

OpenAI.LogProb

A probabilidade de log de um token.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
bytes	matriz		Yes
logprob	número		Yes
símbolo	cadeia		Yes
top_logprobs	matriz		Yes

OpenAI.MCPApprovalRequestItemParam

Uma solicitação de aprovação humana de uma invocação de ferramenta.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
argumentos	cadeia	Uma string JSON de argumentos para a ferramenta.	Yes
nome	cadeia	O nome da ferramenta a ser executada.	Yes
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que está fazendo a solicitação.	Yes
tipo	enumeração	Valores possíveis: mcp_approval_request	Yes

OpenAI.MCPApprovalRequestItemResource

Uma solicitação de aprovação humana de uma invocação de ferramenta.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
argumentos	cadeia	Uma string JSON de argumentos para a ferramenta.	Yes
nome	cadeia	O nome da ferramenta a ser executada.	Yes
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que está fazendo a solicitação.	Yes
tipo	enumeração	Valores possíveis: mcp_approval_request	Yes

OpenAI.MCPApprovalResponseItemParam

Uma resposta a uma solicitação de aprovação do MCP.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
approval_request_id	cadeia	A ID da solicitação de aprovação que está sendo respondida.	Yes
aprovar	boolean	Se a solicitação foi aprovada.	Yes
reason	cadeia	Motivo opcional para a 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 do MCP.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
approval_request_id	cadeia	A ID da solicitação de aprovação que está sendo respondida.	Yes
aprovar	boolean	Se a solicitação foi aprovada.	Yes
reason	cadeia	Motivo opcional para a 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	DESCRIÇÃO	Obrigatório	Padrão
argumentos	cadeia	Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta.	Yes
erro	cadeia	O erro da chamada da ferramenta, se houver.	Não
nome	cadeia	O nome da ferramenta que foi executada.	Yes
saída	cadeia	A saída da chamada da ferramenta.	Não
etiqueta_do_servidor	cadeia	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	DESCRIÇÃO	Obrigatório	Padrão
argumentos	cadeia	Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta.	Yes
erro	cadeia	O erro da chamada da ferramenta, se houver.	Não
nome	cadeia	O nome da ferramenta que foi executada.	Yes
saída	cadeia	A saída da chamada da ferramenta.	Não
etiqueta_do_servidor	cadeia	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	DESCRIÇÃO	Obrigatório	Padrão
erro	cadeia	Mensagem de erro se o servidor não puder listar ferramentas.	Não
etiqueta_do_servidor	cadeia	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	DESCRIÇÃO	Obrigatório	Padrão
erro	cadeia	Mensagem de erro se o servidor não puder listar ferramentas.	Não
etiqueta_do_servidor	cadeia	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	DESCRIÇÃO	Obrigatório	Padrão
Anotações		Anotações adicionais sobre a ferramenta.	Não
descrição	cadeia	A descrição da ferramenta.	Não
input_schema		O esquema JSON que descreve a entrada da ferramenta.	Yes
nome	cadeia	O nome da ferramenta.	Yes

OpenAI.MCPTool

Conceda ao modelo acesso a ferramentas adicionais por meio de servidores remotos do Protocolo de Contexto de Modelo. Saiba mais sobre o MCP.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
ferramentas_permitidas	objeto		Não
└─ nomes_das_ferramentas	matriz	Lista de nomes de ferramentas permitidos.	Não
headers	objeto	Cabeçalhos HTTP opcionais para enviar ao servidor MCP. Usar para autenticação ou outras finalidades.	Não
project_connection_id	cadeia	A ID de conexão no projeto para o servidor MCP. A conexão armazena a autenticação e outros detalhes de conexão necessários para se conectar ao servidor MCP.	Não
requer_aprovação	objeto (consulte modelos válidos abaixo)	Especifique quais das ferramentas do servidor MCP exigem aprovação.	Não
etiqueta_do_servidor	cadeia	Um rótulo para esse servidor MCP, usado para identificá-lo em chamadas de ferramenta.	Yes
URL_do_servidor	cadeia	A URL do servidor MCP.	Yes
tipo	enumeração	O tipo da ferramenta MCP. Sempre mcp. Valores possíveis: mcp	Yes

OpenAI.Metadata

Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.

Tipo: objeto

OpenAI.Prompt

Referência a um modelo de prompt e suas variáveis. Saiba mais.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
id	cadeia	O identificador exclusivo do modelo de prompt a ser usado.	Yes
variáveis	objeto	Mapa opcional de valores a serem substituídos por variáveis no seu solicitação. Os valores de substituição podem ser cadeias de caracteres ou outros Tipos de entrada de resposta, como imagens ou arquivos.	Não
versão	cadeia	Versão opcional do modelo de prompt.	Não

OpenAI.RankingOptions

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrã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 arquivos, um número entre 0 e 1. Números mais próximos de 1 tentarão retornar apenas os resultados mais relevantes, mas podem retornar menos resultados.	Não

OpenAI.Reasoning

somente modelos da série o

Opções de configuração para modelos de raciocínio.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
Esforço	objeto	Restringe o esforço de raciocínio para modelos de raciocínio. Atualmente, os valores com suporte são nenhum, mínimo, baixo, médio e alto. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio de uma resposta. gpt-5.1 usa como padrão nenhum, o que não executa o raciocínio. Os valores de raciocínio com suporte para gpt-5.1 são nenhum, baixo, médio e alto. Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. Todos os modelos antes do gpt-5.1 são padrão para o esforço de raciocínio médio e não dão suporte a nenhum. O modelo gpt-5-pro usa como padrão (e só dá suporte) ao alto esforço de raciocínio.	Não
generate_summary	enumeração	Preterido: use summary em vez disso. Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo. Uma opção entre auto, concise ou detailed. Valores possíveis: auto, , concisedetailed	Não
resumo	enumeração	Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo. Uma opção entre auto, concise ou detailed. Valores possíveis: auto, , concisedetailed	Não

OpenAI.ReasoningEffort

Restringe o esforço de raciocínio para modelos de raciocínio.

Atualmente, os valores com suporte são nenhum, mínimo, baixo, médio e alto.

A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio de uma resposta.

gpt-5.1 usa como padrão nenhum, o que não executa o raciocínio. Os valores de raciocínio com suporte para gpt-5.1 são nenhum, baixo, médio e alto. Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1.

Todos os modelos antes do gpt-5.1 são padrão para o esforço de raciocínio médio e não dão suporte a nenhum.

O modelo gpt-5-pro usa como padrão (e só dá suporte) ao alto esforço de raciocínio.

Propriedade	Valor
Descrição	Restringe o esforço de raciocínio para modelos de raciocínio. Atualmente, os valores com suporte são nenhum, mínimo, baixo, médio e alto. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio de uma resposta. gpt-5.1 usa como padrão nenhum, o que não executa o raciocínio. Os valores de raciocínio com suporte para gpt-5.1 são nenhum, baixo, médio e alto. Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. Todos os modelos antes do gpt-5.1 são padrão para o esforço de raciocínio médio e não dão suporte a nenhum. O modelo gpt-5-pro usa como padrão (e só dá suporte) ao alto esforço de raciocínio.
Tipo	cadeia
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	DESCRIÇÃO	Obrigatório	Padrão
encrypted_content	cadeia	O conteúdo criptografado do item de raciocínio — preenchido quando uma resposta for gerado com reasoning.encrypted_content no parâmetro include.	Não
resumo	matriz	Conteúdo de texto de raciocínio.	Yes
tipo	enumeração	Valores possíveis: reasoning	Yes

OpenAI.ReasoningItemResource

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	DESCRIÇÃO	Obrigatório	Padrão
encrypted_content	cadeia	O conteúdo criptografado do item de raciocínio — preenchido quando uma resposta for gerado com reasoning.encrypted_content no parâmetro include.	Não
resumo	matriz	Conteúdo de texto de raciocínio.	Yes
tipo	enumeração	Valores possíveis: reasoning	Yes

OpenAI.ReasoningItemSummaryPart

Discriminador para OpenAI.ReasoningItemSummaryPart

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

Valor do tipo	Schema
summary_text	OpenAI.ReasoningItemSummaryTextPart

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	OpenAI.ReasoningItemSummaryPartType		Yes

OpenAI.ReasoningItemSummaryPartType

Propriedade	Valor
Tipo	cadeia
Valores	summary_text

OpenAI.ReasoningItemSummaryTextPart

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
enviar SMS	cadeia		Yes
tipo	enumeração	Valores possíveis: summary_text	Yes

OpenAI.Response

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
agente	objeto		Não
└─ nome	cadeia	O nome do agente.	Não
└─ tipo	enumeração	Valores possíveis: agent_id	Não
└─ versão	cadeia	O identificador de versão do agente.	Não
em segundo plano	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas em segundo plano.	Não	Falso
conversa	objeto		Yes
└─ id	cadeia		Não
criado_em	inteiro	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Yes
erro	objeto	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Yes
└─ código	OpenAI.ResponseErrorCode	O código de erro da resposta.	Não
Mensagem └─	cadeia	Uma descrição do erro legível para humanos.	Não
id	cadeia	Identificador exclusivo para esta resposta.	Yes
incomplete_details	objeto	Detalhes sobre por que a resposta está incompleta.	Yes
└─ motivo	enumeração	O motivo pelo 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	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	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	Não
objeto	enumeração	O tipo de objeto desse recurso – sempre definido como response. Valores possíveis: response	Yes
saída	matriz	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na output matriz são dependentes na resposta do modelo. – Em vez de acessar o primeiro item na matriz output e supondo que seja uma assistant mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade output_text em que Suportado por SDKs.	Yes
output_text	cadeia	Propriedade de conveniência exclusiva do SDK que contém a saída de texto agregada de todos os itens de output_text na matriz output, se houver algum presente. Com suporte nos SDKs python e JavaScript.	Não
parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Yes	Verdade
previous_response_id	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. Saiba mais sobre gerenciando o estado da conversa.	Não
solicitação	objeto	Referência a um modelo de prompt e suas variáveis. Saiba mais.	Não
└─ id	cadeia	O identificador exclusivo do modelo de prompt a ser usado.	Não
└─ variáveis	OpenAI.ResponsePromptVariables	Mapa opcional de valores a serem substituídos por variáveis no seu solicitação. Os valores de substituição podem ser cadeias de caracteres ou outros Tipos de entrada de resposta, como imagens ou arquivos.	Não
└─ versão	cadeia	Versão opcional do modelo de prompt.	Não
reasoning	objeto	somente modelos da série o Opções de configuração para modelos de raciocínio.	Não
└─ esforço	Esforço de Raciocínio da OpenAI	Restringe o esforço de raciocínio para modelos de raciocínio. Atualmente, os valores com suporte são nenhum, mínimo, baixo, médio e alto. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio de uma resposta. gpt-5.1 usa como padrão nenhum, o que não executa o raciocínio. Os valores de raciocínio com suporte para gpt-5.1 são nenhum, baixo, médio e alto. Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. Todos os modelos antes do gpt-5.1 são padrão para o esforço de raciocínio médio e não dão suporte a nenhum. O modelo gpt-5-pro usa como padrão (e só dá suporte) ao alto esforço de raciocínio.	Não
└─ gerar_resumo	enumeração	Preterido: use summary em vez disso. Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo. Uma opção entre auto, concise ou detailed. Valores possíveis: auto, , concisedetailed	Não
└─ resumo	enumeração	Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo. Uma opção entre auto, concise ou detailed. Valores possíveis: auto, , concisedetailed	Não
nível de serviço	objeto	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 configurado nas configurações do Projeto. A menos que esteja configurado de outra forma, o Projeto usará "padrão". * Se definido como 'padrão', a solicitação será processada com o padrão preços e desempenho para o modelo selecionado. * Se definido como 'flex' ou "prioridade", a solicitação será processada com o serviço correspondente camada. Entre em contato com as vendas para saber mais sobre o processamento de prioridade. * Quando não definido, o comportamento padrão é 'auto'. Quando o service_tier parâmetro for definido, o corpo da resposta incluirá o service_tier 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.	Não
status	enumeração	O status da geração de resposta. Uma opção entre completed, failed, in_progress, cancelled, queuedou incomplete. Valores possíveis: completed, , failed, in_progress, cancelled, , queuedincomplete	Não
structured_inputs	objeto	As entradas estruturadas para a resposta que podem participar de substituição de modelo de prompt ou associações de argumento de ferramenta.	Não
temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou top_p, mas não as duas coisas.	Yes
enviar SMS	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. Ver entradas e saídas de texto e saídas estruturadas	Não
└─ Formato	OpenAI.ResponseTextFormatConfiguration		Não
tool_choice	objeto	Controla qual ferramenta (se houver) é chamada pelo modelo. none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem. auto significa que o modelo pode escolher entre gerar uma mensagem ou 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 internas.	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 internas: ferramentas fornecidas pelo OpenAI que estendem o funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivo. Saiba mais sobre ferramentas internas. * Chamadas de função (ferramentas personalizadas): funções definidas por você, permitindo que o modelo chame seu próprio código. Saiba mais sobre chamada de função.	Não
top_logprobs	inteiro	Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada.	Não
top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa apenas os tokens que compõem os 10% superiores da massa de probabilidade%. são considerados. Geralmente recomendamos alterar isso ou temperature, mas não as duas coisas.	Yes
truncation	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - auto: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - disabled (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: auto, disabled	Não
uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
usuário	cadeia	Saiba mais sobre as práticas recomendadas de segurança.	Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Emitido quando um snippet de código parcial é transmitido pelo interpretador de código.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
delta	cadeia	O snippet de código parcial que está sendo transmitido pelo interpretador de código.	Yes
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretadora de código.	Yes
output_index	inteiro	O índice do item de saída na resposta para o 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 snippet de código é finalizado pelo interpretador de código.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
codificar	cadeia	A saída final do snippet de código pelo intérprete de código.	Yes
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretadora de código.	Yes
output_index	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	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretadora de código.	Yes
output_index	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	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretadora de código.	Yes
output_index	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 snippet de código.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretadora de código.	Yes
output_index	inteiro	O índice do item de saída na resposta para a qual o interpretador de código está interpretando o 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 é concluída.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
response	objeto		Yes
└─ agente	AgentId	O agente usado para essa resposta	Não
└─ plano de fundo	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas em segundo plano.	Não	Falso
└─ conversa	objeto		Não
└─ id	cadeia		Não
└─ created_at	inteiro	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Não
└─ id	cadeia	Identificador exclusivo para esta resposta.	Não
└─ detalhes_incompletos	objeto	Detalhes sobre por que a resposta está incompleta.	Não
└─ motivo	enumeração	O motivo pelo 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 usar junto com previous_response_id, as instruções de uma resposta A resposta não será transferida para a próxima resposta. Isso torna simples para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (número máximo de tokens de saída)	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	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	Não
└─ objeto	enumeração	O tipo de objeto desse 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 ordem dos itens na output matriz são dependentes na resposta do modelo. – Em vez de acessar o primeiro item na matriz output e supondo que seja uma assistant mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade output_text em que Suportado por SDKs.	Não
└─ texto_de_saida	cadeia	Propriedade de conveniência exclusiva do SDK que contém a saída de texto agregada de todos os itens de output_text na matriz output, se houver algum presente. Com suporte nos SDKs python e JavaScript.	Não
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. Saiba mais sobre gerenciando o estado da conversa.	Não
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis. Saiba mais.	Não
└─ raciocínio	OpenAI.Reasoning	somente modelos da série o Opções de configuração para modelos de raciocínio.	Não
└─ service_tier	OpenAI.ServiceTier	Observação: service_tier não é aplicável ao Azure OpenAI.	Não
└─ estado	enumeração	O status da geração de resposta. Uma opção entre completed, failed, in_progress, cancelled, queuedou incomplete. Valores possíveis: completed, , failed, in_progress, cancelled, , queuedincomplete	Não
└─ structured_inputs	objeto	As entradas estruturadas para a resposta que podem participar de substituição de modelo de prompt ou associações de argumento de ferramenta.	Não
└─ temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou top_p, mas não as duas coisas.	Não
└─ texto	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples 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 internas: ferramentas fornecidas pelo OpenAI que estendem o funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivo. Saiba mais sobre ferramentas internas. * Chamadas de função (ferramentas personalizadas): funções definidas por você, permitindo que o modelo chame seu próprio código. Saiba mais sobre chamada de função.	Não
└─ top_logprobs	inteiro	Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa apenas os tokens que compõem os 10% superiores da massa de probabilidade%. são considerados. Geralmente recomendamos alterar isso ou temperature, mas não as duas coisas.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - auto: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - disabled (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: auto, disabled	Não
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ usuário	cadeia	Saiba mais sobre as práticas recomendadas 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	DESCRIÇÃO	Obrigatório	Padrão
content_index	inteiro	O índice da parte de conteúdo que foi adicionada.	Yes
item_id	cadeia	A ID do item de saída ao qual a parte de conteúdo foi adicionada.	Yes
output_index	inteiro	O índice do item de saída ao qual a parte de conteúdo foi adicionada.	Yes
part	objeto		Yes
└─ tipo	OpenAI.ItemContentType	Conteúdo de entrada e saída multi modal.	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	DESCRIÇÃO	Obrigatório	Padrão
content_index	inteiro	O índice da parte de conteúdo que está concluída.	Yes
item_id	cadeia	A ID do item de saída ao qual a parte de conteúdo foi adicionada.	Yes
output_index	inteiro	O índice do item de saída ao qual a parte de conteúdo foi adicionada.	Yes
part	objeto		Yes
└─ tipo	OpenAI.ItemContentType	Conteúdo de entrada e saída multi modal.	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 emitido quando uma resposta é criada.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
response	objeto		Yes
└─ agente	AgentId	O agente usado para essa resposta	Não
└─ plano de fundo	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas em segundo plano.	Não	Falso
└─ conversa	objeto		Não
└─ id	cadeia		Não
└─ created_at	inteiro	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Não
└─ id	cadeia	Identificador exclusivo para esta resposta.	Não
└─ detalhes_incompletos	objeto	Detalhes sobre por que a resposta está incompleta.	Não
└─ motivo	enumeração	O motivo pelo 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 usar junto com previous_response_id, as instruções de uma resposta A resposta não será transferida para a próxima resposta. Isso torna simples para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (número máximo de tokens de saída)	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	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	Não
└─ objeto	enumeração	O tipo de objeto desse 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 ordem dos itens na output matriz são dependentes na resposta do modelo. – Em vez de acessar o primeiro item na matriz output e supondo que seja uma assistant mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade output_text em que Suportado por SDKs.	Não
└─ texto_de_saida	cadeia	Propriedade de conveniência exclusiva do SDK que contém a saída de texto agregada de todos os itens de output_text na matriz output, se houver algum presente. Com suporte nos SDKs python e JavaScript.	Não
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. Saiba mais sobre gerenciando o estado da conversa.	Não
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis. Saiba mais.	Não
└─ raciocínio	OpenAI.Reasoning	somente modelos da série o Opções de configuração para modelos de raciocínio.	Não
└─ service_tier	OpenAI.ServiceTier	Observação: service_tier não é aplicável ao Azure OpenAI.	Não
└─ estado	enumeração	O status da geração de resposta. Uma opção entre completed, failed, in_progress, cancelled, queuedou incomplete. Valores possíveis: completed, , failed, in_progress, cancelled, , queuedincomplete	Não
└─ structured_inputs	objeto	As entradas estruturadas para a resposta que podem participar de substituição de modelo de prompt ou associações de argumento de ferramenta.	Não
└─ temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou top_p, mas não as duas coisas.	Não
└─ texto	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples 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 internas: ferramentas fornecidas pelo OpenAI que estendem o funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivo. Saiba mais sobre ferramentas internas. * Chamadas de função (ferramentas personalizadas): funções definidas por você, permitindo que o modelo chame seu próprio código. Saiba mais sobre chamada de função.	Não
└─ top_logprobs	inteiro	Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa apenas os tokens que compõem os 10% superiores da massa de probabilidade%. são considerados. Geralmente recomendamos alterar isso ou temperature, mas não as duas coisas.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - auto: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - disabled (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: auto, disabled	Não
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ usuário	cadeia	Saiba mais sobre as práticas recomendadas 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 falha ao gerar uma Resposta.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
codificar	OpenAI.ResponseErrorCode	O código de erro da resposta.	Yes
mensagem	cadeia	Uma descrição do erro legível para humanos.	Yes

OpenAI.ResponseErrorCode

O código de erro da resposta.

Propriedade	Valor
Descrição	O código de erro da resposta.
Tipo	cadeia
Valores	server_error rate_limit_exceeded invalid_prompt vector_store_timeout invalid_image invalid_image_format invalid_base64_image invalid_image_url image_too_large image_too_small image_parse_error image_content_policy_violation invalid_image_mode image_file_too_large unsupported_image_media_type empty_image_file failed_to_download_image image_file_not_found

OpenAI.ResponseErrorEvent

Emitido quando ocorre um erro.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
codificar	cadeia	O código de erro.	Yes
mensagem	cadeia	A mensagem de erro.	Yes
param	cadeia	O parâmetro de erro.	Yes
tipo	enumeração	O tipo de evento. Sempre error. Valores possíveis: error	Yes

OpenAI.ResponseFailedEvent

Um evento emitido quando uma resposta falha.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
response	objeto		Yes
└─ agente	AgentId	O agente usado para essa resposta	Não
└─ plano de fundo	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas em segundo plano.	Não	Falso
└─ conversa	objeto		Não
└─ id	cadeia		Não
└─ created_at	inteiro	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Não
└─ id	cadeia	Identificador exclusivo para esta resposta.	Não
└─ detalhes_incompletos	objeto	Detalhes sobre por que a resposta está incompleta.	Não
└─ motivo	enumeração	O motivo pelo 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 usar junto com previous_response_id, as instruções de uma resposta A resposta não será transferida para a próxima resposta. Isso torna simples para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (número máximo de tokens de saída)	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	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	Não
└─ objeto	enumeração	O tipo de objeto desse 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 ordem dos itens na output matriz são dependentes na resposta do modelo. – Em vez de acessar o primeiro item na matriz output e supondo que seja uma assistant mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade output_text em que Suportado por SDKs.	Não
└─ texto_de_saida	cadeia	Propriedade de conveniência exclusiva do SDK que contém a saída de texto agregada de todos os itens de output_text na matriz output, se houver algum presente. Com suporte nos SDKs python e JavaScript.	Não
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. Saiba mais sobre gerenciando o estado da conversa.	Não
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis. Saiba mais.	Não
└─ raciocínio	OpenAI.Reasoning	somente modelos da série o Opções de configuração para modelos de raciocínio.	Não
└─ service_tier	OpenAI.ServiceTier	Observação: service_tier não é aplicável ao Azure OpenAI.	Não
└─ estado	enumeração	O status da geração de resposta. Uma opção entre completed, failed, in_progress, cancelled, queuedou incomplete. Valores possíveis: completed, , failed, in_progress, cancelled, , queuedincomplete	Não
└─ structured_inputs	objeto	As entradas estruturadas para a resposta que podem participar de substituição de modelo de prompt ou associações de argumento de ferramenta.	Não
└─ temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou top_p, mas não as duas coisas.	Não
└─ texto	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples 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 internas: ferramentas fornecidas pelo OpenAI que estendem o funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivo. Saiba mais sobre ferramentas internas. * Chamadas de função (ferramentas personalizadas): funções definidas por você, permitindo que o modelo chame seu próprio código. Saiba mais sobre chamada de função.	Não
└─ top_logprobs	inteiro	Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa apenas os tokens que compõem os 10% superiores da massa de probabilidade%. são considerados. Geralmente recomendamos alterar isso ou temperature, mas não as duas coisas.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - auto: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - disabled (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: auto, disabled	Não
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ usuário	cadeia	Saiba mais sobre as práticas recomendadas 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	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	A ID do item de saída que a chamada de pesquisa de arquivo é iniciada.	Yes
output_index	inteiro	O índice do item de saída que a chamada de pesquisa de arquivo é iniciada.	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	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	A ID do item de saída que a chamada de pesquisa de arquivo é iniciada.	Yes
output_index	inteiro	O índice do item de saída que a chamada de pesquisa de arquivo é iniciada.	Yes
tipo	enumeração	O tipo de evento. Sempre response.file_search_call.in_progress. Valores possíveis: response.file_search_call.in_progress	Yes

OpenAI.ResponseFileSearchCallSearchingEvent

Emitido quando uma pesquisa de arquivo está em andamento.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	A ID do item de saída que a chamada de pesquisa de arquivo é iniciada.	Yes
output_index	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

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

Valor do tipo	Schema
json_object	OpenAI.ResponseFormatJsonObject
json_schema	OpenAI.ResponseFormatJsonSchema

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: text, , json_objectjson_schema	Yes

OpenAI.ResponseFormatJsonObject

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
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. Saiba como criar esquemas JSON aqui. Formato de resposta de esquema JSON. Usado para gerar respostas JSON estruturadas. Saiba mais sobre saídas estruturadas.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
json_schema	objeto	Opções de configuração de Saídas Estruturadas, incluindo um esquema JSON.	Yes
└─ descrição	cadeia	Uma descrição do formato de resposta, usado pelo modelo para determinar como responder no formato.	Não
└─ nome	cadeia	O nome do formato de resposta. Deve ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com um comprimento máximo de 64.	Não
└─ esquema	objeto		Não
└─ rigoroso	boolean	Se deseja habilitar a adesão estrita do esquema ao gerar a saída. Se definido como true, o modelo sempre seguirá o esquema exato definido no campo schema. Há suporte apenas para um subconjunto de esquema JSON quando strict é true. Para saber mais, leia o guia de Saídas Estruturadas .	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	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	O tipo de formato de resposta que está sendo definido. Sempre text. Valores possíveis: text	Yes

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Emitido quando há um delta de argumentos parciais de chamada de função.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
delta	cadeia	O delta de argumentos de chamada de função que é adicionado.	Yes
item_id	cadeia	A ID do item de saída ao qual o delta de argumentos de chamada de função é adicionado.	Yes
output_index	inteiro	O índice do item de saída ao qual o delta de argumentos de chamada de função é adicionado.	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	DESCRIÇÃO	Obrigatório	Padrão
argumentos	cadeia	Os argumentos de chamada de função.	Yes
item_id	cadeia	O ID do item.	Yes
output_index	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	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	O identificador exclusivo do item de geração de imagem que está sendo processado.	Yes
output_index	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	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	O identificador exclusivo do item de geração de imagem que está sendo processado.	Yes
output_index	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.generating". Valores possíveis: response.image_generation_call.generating	Yes

OpenAI.ResponseImageGenCallInProgressEvent

Emitido quando uma chamada de ferramenta de geração de imagem está em andamento.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	O identificador exclusivo do item de geração de imagem que está sendo processado.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
tipo	enumeração	O tipo de evento. Use 'response.image_generation_call.in_progress' sempre. Valores possíveis: response.image_generation_call.in_progress	Yes

OpenAI.ResponseImageGenCallPartialImageEvent

Emitido quando uma imagem parcial está disponível durante o streaming de geração de imagem.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	O identificador exclusivo do item de geração de imagem que está sendo processado.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
partial_image_b64	cadeia	Dados de imagem parciais codificados em Base64, adequados para renderização como uma imagem.	Yes
partial_image_index	inteiro	Índice baseado em 0 para a imagem parcial (o back-end é baseado em 1, mas é baseado em 0 para o usuário).	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	DESCRIÇÃO	Obrigatório	Padrão
response	objeto		Yes
└─ agente	AgentId	O agente usado para essa resposta	Não
└─ plano de fundo	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas em segundo plano.	Não	Falso
└─ conversa	objeto		Não
└─ id	cadeia		Não
└─ created_at	inteiro	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Não
└─ id	cadeia	Identificador exclusivo para esta resposta.	Não
└─ detalhes_incompletos	objeto	Detalhes sobre por que a resposta está incompleta.	Não
└─ motivo	enumeração	O motivo pelo 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 usar junto com previous_response_id, as instruções de uma resposta A resposta não será transferida para a próxima resposta. Isso torna simples para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (número máximo de tokens de saída)	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	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	Não
└─ objeto	enumeração	O tipo de objeto desse 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 ordem dos itens na output matriz são dependentes na resposta do modelo. – Em vez de acessar o primeiro item na matriz output e supondo que seja uma assistant mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade output_text em que Suportado por SDKs.	Não
└─ texto_de_saida	cadeia	Propriedade de conveniência exclusiva do SDK que contém a saída de texto agregada de todos os itens de output_text na matriz output, se houver algum presente. Com suporte nos SDKs python e JavaScript.	Não
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. Saiba mais sobre gerenciando o estado da conversa.	Não
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis. Saiba mais.	Não
└─ raciocínio	OpenAI.Reasoning	somente modelos da série o Opções de configuração para modelos de raciocínio.	Não
└─ service_tier	OpenAI.ServiceTier	Observação: service_tier não é aplicável ao Azure OpenAI.	Não
└─ estado	enumeração	O status da geração de resposta. Uma opção entre completed, failed, in_progress, cancelled, queuedou incomplete. Valores possíveis: completed, , failed, in_progress, cancelled, , queuedincomplete	Não
└─ structured_inputs	objeto	As entradas estruturadas para a resposta que podem participar de substituição de modelo de prompt ou associações de argumento de ferramenta.	Não
└─ temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou top_p, mas não as duas coisas.	Não
└─ texto	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples 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 internas: ferramentas fornecidas pelo OpenAI que estendem o funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivo. Saiba mais sobre ferramentas internas. * Chamadas de função (ferramentas personalizadas): funções definidas por você, permitindo que o modelo chame seu próprio código. Saiba mais sobre chamada de função.	Não
└─ top_logprobs	inteiro	Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa apenas os tokens que compõem os 10% superiores da massa de probabilidade%. são considerados. Geralmente recomendamos alterar isso ou temperature, mas não as duas coisas.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - auto: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - disabled (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: auto, disabled	Não
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ usuário	cadeia	Saiba mais sobre as práticas recomendadas 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 emitido quando uma resposta é concluída como incompleta.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
response	objeto		Yes
└─ agente	AgentId	O agente usado para essa resposta	Não
└─ plano de fundo	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas em segundo plano.	Não	Falso
└─ conversa	objeto		Não
└─ id	cadeia		Não
└─ created_at	inteiro	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Não
└─ id	cadeia	Identificador exclusivo para esta resposta.	Não
└─ detalhes_incompletos	objeto	Detalhes sobre por que a resposta está incompleta.	Não
└─ motivo	enumeração	O motivo pelo 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 usar junto com previous_response_id, as instruções de uma resposta A resposta não será transferida para a próxima resposta. Isso torna simples para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (número máximo de tokens de saída)	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	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	Não
└─ objeto	enumeração	O tipo de objeto desse 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 ordem dos itens na output matriz são dependentes na resposta do modelo. – Em vez de acessar o primeiro item na matriz output e supondo que seja uma assistant mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade output_text em que Suportado por SDKs.	Não
└─ texto_de_saida	cadeia	Propriedade de conveniência exclusiva do SDK que contém a saída de texto agregada de todos os itens de output_text na matriz output, se houver algum presente. Com suporte nos SDKs python e JavaScript.	Não
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. Saiba mais sobre gerenciando o estado da conversa.	Não
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis. Saiba mais.	Não
└─ raciocínio	OpenAI.Reasoning	somente modelos da série o Opções de configuração para modelos de raciocínio.	Não
└─ service_tier	OpenAI.ServiceTier	Observação: service_tier não é aplicável ao Azure OpenAI.	Não
└─ estado	enumeração	O status da geração de resposta. Uma opção entre completed, failed, in_progress, cancelled, queuedou incomplete. Valores possíveis: completed, , failed, in_progress, cancelled, , queuedincomplete	Não
└─ structured_inputs	objeto	As entradas estruturadas para a resposta que podem participar de substituição de modelo de prompt ou associações de argumento de ferramenta.	Não
└─ temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou top_p, mas não as duas coisas.	Não
└─ texto	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples 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 internas: ferramentas fornecidas pelo OpenAI que estendem o funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivo. Saiba mais sobre ferramentas internas. * Chamadas de função (ferramentas personalizadas): funções definidas por você, permitindo que o modelo chame seu próprio código. Saiba mais sobre chamada de função.	Não
└─ top_logprobs	inteiro	Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa apenas os tokens que compõem os 10% superiores da massa de probabilidade%. são considerados. Geralmente recomendamos alterar isso ou temperature, mas não as duas coisas.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - auto: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - disabled (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: auto, disabled	Não
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ usuário	cadeia	Saiba mais sobre as práticas recomendadas 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	DESCRIÇÃO	Obrigatório	Padrão
delta		A atualização parcial para os argumentos da chamada da ferramenta MCP.	Yes
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado.	Yes
output_index	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 de uma chamada de ferramenta MCP são finalizados.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
argumentos		Os argumentos finalizados para a chamada da ferramenta MCP.	Yes
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado.	Yes
output_index	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 é concluída com êxito.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call.concluído'. Valores possíveis: response.mcp_call.completed	Yes

OpenAI.ResponseMCPCallFailedEvent

Emitido quando uma chamada de ferramenta MCP falha.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call.falhou'. Valores possíveis: response.mcp_call.failed	Yes

OpenAI.ResponseMCPCallInProgressEvent

Emitido quando uma chamada de ferramenta MCP está em andamento.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
tipo	enumeração	O tipo de evento. O estado sempre é 'response.mcp_call.in_progress'. Valores possíveis: response.mcp_call.in_progress	Yes

OpenAI.ResponseMCPListToolsCompletedEvent

Emitido quando a lista de ferramentas MCP disponíveis foi recuperada com êxito.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
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	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_list_tools.falhou'. Valores possíveis: response.mcp_list_tools.failed	Yes

OpenAI.ResponseMCPListToolsInProgressEvent

Emitido quando o sistema está no processo de recuperação da lista de ferramentas MCP disponíveis.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
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	DESCRIÇÃO	Obrigatório	Padrão
item	objeto	Item de conteúdo usado para gerar uma resposta.	Yes
└─ created_by	Criado por	As informações sobre o criador do item	Não
└─ id	cadeia		Não
└─ tipo	OpenAI.ItemType		Não
output_index	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	DESCRIÇÃO	Obrigatório	Padrão
item	objeto	Item de conteúdo usado para gerar uma resposta.	Yes
└─ created_by	Criado por	As informações sobre o criador do item	Não
└─ id	cadeia		Não
└─ tipo	OpenAI.ItemType		Não
output_index	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 a serem substituídos por variáveis no seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros tipos de entrada de resposta, como imagens ou arquivos.

Tipo: objeto

OpenAI.ResponseQueuedEvent

Emitido quando uma resposta é enfileirada e aguardando para ser processada.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
response	objeto		Yes
└─ agente	AgentId	O agente usado para essa resposta	Não
└─ plano de fundo	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais sobre respostas em segundo plano.	Não	Falso
└─ conversa	objeto		Não
└─ id	cadeia		Não
└─ created_at	inteiro	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Não
└─ id	cadeia	Identificador exclusivo para esta resposta.	Não
└─ detalhes_incompletos	objeto	Detalhes sobre por que a resposta está incompleta.	Não
└─ motivo	enumeração	O motivo pelo 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 usar junto com previous_response_id, as instruções de uma resposta A resposta não será transferida para a próxima resposta. Isso torna simples para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (número máximo de tokens de saída)	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	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	Não
└─ objeto	enumeração	O tipo de objeto desse 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 ordem dos itens na output matriz são dependentes na resposta do modelo. – Em vez de acessar o primeiro item na matriz output e supondo que seja uma assistant mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade output_text em que Suportado por SDKs.	Não
└─ texto_de_saida	cadeia	Propriedade de conveniência exclusiva do SDK que contém a saída de texto agregada de todos os itens de output_text na matriz output, se houver algum presente. Com suporte nos SDKs python e JavaScript.	Não
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. Saiba mais sobre gerenciando o estado da conversa.	Não
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis. Saiba mais.	Não
└─ raciocínio	OpenAI.Reasoning	somente modelos da série o Opções de configuração para modelos de raciocínio.	Não
└─ service_tier	OpenAI.ServiceTier	Observação: service_tier não é aplicável ao Azure OpenAI.	Não
└─ estado	enumeração	O status da geração de resposta. Uma opção entre completed, failed, in_progress, cancelled, queuedou incomplete. Valores possíveis: completed, , failed, in_progress, cancelled, , queuedincomplete	Não
└─ structured_inputs	objeto	As entradas estruturadas para a resposta que podem participar de substituição de modelo de prompt ou associações de argumento de ferramenta.	Não
└─ temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou top_p, mas não as duas coisas.	Não
└─ texto	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples 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 internas: ferramentas fornecidas pelo OpenAI que estendem o funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivo. Saiba mais sobre ferramentas internas. * Chamadas de função (ferramentas personalizadas): funções definidas por você, permitindo que o modelo chame seu próprio código. Saiba mais sobre chamada de função.	Não
└─ top_logprobs	inteiro	Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa apenas os tokens que compõem os 10% superiores da massa de probabilidade%. são considerados. Geralmente recomendamos alterar isso ou temperature, mas não as duas coisas.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - auto: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - disabled (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: auto, disabled	Não
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ usuário	cadeia	Saiba mais sobre as práticas recomendadas de segurança.	Não
tipo	enumeração	O tipo de evento. Sempre 'response.enfileirado'. Valores possíveis: response.queued	Yes

OpenAI.ResponseReasoningDeltaEvent

Emitido quando há um delta (atualização parcial) no conteúdo do raciocínio.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
content_index	inteiro	O índice da parte de conteúdo de raciocínio dentro do item de saída.	Yes
delta		A atualização parcial para o conteúdo de raciocínio.	Yes
item_id	cadeia	O identificador único do item para o qual o raciocínio está sendo atualizado.	Yes
output_index	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 do raciocínio é finalizado para um item.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
content_index	inteiro	O índice da parte de conteúdo de raciocínio dentro do item de saída.	Yes
item_id	cadeia	O identificador exclusivo do item para o qual o raciocínio é finalizado.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
enviar SMS	cadeia	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á uma atualização parcial (delta) no conteúdo do resumo de raciocínio.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
delta		A atualização parcial para o conteúdo de resumo do raciocínio.	Yes
item_id	cadeia	O identificador exclusivo do item para o qual o resumo do raciocínio está sendo atualizado.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
summary_index	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 do raciocínio é finalizado para um item.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	O identificador exclusivo do item para o qual o resumo do raciocínio é finalizado.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
summary_index	inteiro	O índice da parte de resumo dentro do item de saída.	Yes
enviar SMS	cadeia	O texto de resumo do raciocínio finalizado.	Yes
tipo	enumeração	O tipo de evento. Sempre "response.reasoning_summary.concluído". Valores possíveis: response.reasoning_summary.done	Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

Emitido quando uma nova parte de resumo de raciocínio é adicionada.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	A ID do item à qual essa parte de resumo está associada.	Yes
output_index	inteiro	O índice do item de saída ao qual essa parte de resumo está associada.	Yes
part	objeto		Yes
└─ tipo	OpenAI.ReasoningItemSummaryPartType		Não
summary_index	inteiro	O índice da parte de resumo dentro do resumo do raciocínio.	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 do resumo do raciocínio é concluída.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	A ID do item à qual essa parte de resumo está associada.	Yes
output_index	inteiro	O índice do item de saída ao qual essa parte de resumo está associada.	Yes
part	objeto		Yes
└─ tipo	OpenAI.ReasoningItemSummaryPartType		Não
summary_index	inteiro	O índice da parte de resumo dentro do resumo do raciocínio.	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 lógico.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
delta	cadeia	O delta de texto que foi adicionado ao resumo.	Yes
item_id	cadeia	A ID do item ao qual este delta de texto de resumo está associado.	Yes
output_index	inteiro	O índice do item de saída ao qual este delta de texto de resumo está associado.	Yes
summary_index	inteiro	O índice da parte de resumo dentro do resumo do raciocínio.	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	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	A ID do item ao qual este texto de resumo está associado.	Yes
output_index	inteiro	O índice do item de saída ao qual este texto de resumo está associado.	Yes
summary_index	inteiro	O índice da parte de resumo dentro do resumo do raciocínio.	Yes
enviar SMS	cadeia	O texto completo do resumo do raciocínio concluído.	Yes
tipo	enumeração	O tipo de evento. Sempre response.reasoning_summary_text.done. Valores possíveis: response.reasoning_summary_text.done	Yes

OpenAI.ResponseRefusalDeltaEvent

Emitido quando há um texto de recusa parcial.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
content_index	inteiro	O índice da parte de conteúdo à qual o texto de recusa é adicionado.	Yes
delta	cadeia	O texto de recusa que é adicionado.	Yes
item_id	cadeia	A ID do item de saída ao qual o texto de recusa é adicionado.	Yes
output_index	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	DESCRIÇÃO	Obrigatório	Padrão
content_index	inteiro	O índice da parte de conteúdo que o texto de recusa é finalizado.	Yes
item_id	cadeia	A ID do item de saída em que o texto de recusa é finalizado.	Yes
output_index	inteiro	O índice do item de saída em que o texto de recusa é finalizado.	Yes
recusa	cadeia	O texto finalizado de recusa.	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

Esse 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	DESCRIÇÃO	Obrigatório	Padrão
sequence_number	inteiro	O número sequencial para esse evento.	Yes
tipo	OpenAI.ResponseStreamEventType		Yes

OpenAI.ResponseStreamEventType

Propriedade	Valor
Tipo	cadeia
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	DESCRIÇÃO	Obrigatório	Padrão
content_index	inteiro	O índice da parte de conteúdo à qual o delta de texto foi adicionado.	Yes
delta	cadeia	O delta de texto que foi adicionado.	Yes
item_id	cadeia	A ID do item de saída ao qual o delta de texto foi adicionado.	Yes
output_index	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	DESCRIÇÃO	Obrigatório	Padrão
content_index	inteiro	O índice da parte de conteúdo que o conteúdo do texto é finalizado.	Yes
item_id	cadeia	A ID do item de saída em que o conteúdo do texto é finalizado.	Yes
output_index	inteiro	O índice do item de saída que o conteúdo do texto é finalizado.	Yes
enviar SMS	cadeia	O conteúdo do texto finalizado.	Yes
tipo	enumeração	O tipo de evento. Sempre response.output_text.done. Valores possíveis: response.output_text.done	Yes

OpenAI.ResponseTextFormatConfiguration

Discriminador para OpenAI.ResponseTextFormatConfiguration

Esse 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	DESCRIÇÃO	Obrigatório	Padrão
tipo	OpenAI.ResponseTextFormatConfigurationType	Um objeto que especifica o formato que o modelo deve gerar. Configurar { "type": "json_schema" } habilita saídas estruturadas, que garante que o modelo corresponda ao esquema JSON fornecido. Saiba mais em O formato padrão é { "type": "text" } sem opções adicionais. Não recomendado para modelos gpt-4o e mais recentes: Definir para { "type": "json_object" } habilita o modo JSON mais antigo, que garante que a mensagem gerada pelo modelo seja JSON válida. Usando json_schema é preferencial para modelos que dão suporte a isso.	Yes

OpenAI.ResponseTextFormatConfigurationJsonObject

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: json_object	Yes

OpenAI.ResponseTextFormatConfigurationJsonSchema

Formato de resposta de esquema JSON. Usado para gerar respostas JSON estruturadas. Saiba mais sobre saídas estruturadas.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	Uma descrição do formato de resposta, usado pelo modelo para determinar como responder no formato.	Não
nome	cadeia	O nome do formato de resposta. Deve ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com um comprimento máximo de 64.	Yes
esquema	objeto		Yes
rigoroso	boolean	Se deseja habilitar a adesão estrita do esquema ao gerar a saída. Se definido como true, o modelo sempre seguirá o esquema exato definido no campo schema. Há suporte apenas para um subconjunto de esquema JSON quando strict é true. Para saber mais, leia o guia de Saídas Estruturadas .	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.ResponseTextFormatConfigurationText

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: text	Yes

OpenAI.ResponseTextFormatConfigurationType

Um objeto que especifica o formato que o modelo deve gerar.

A configuração { "type": "json_schema" } habilita saídas estruturadas, o que garante que o modelo corresponda ao esquema JSON fornecido. Saiba mais em

O formato padrão é { "type": "text" } sem opções adicionais.

Não recomendado para modelos gpt-4o e mais recentes:

A configuração para { "type": "json_object" } habilita o modo JSON antigo, garantindo que a mensagem gerada pelo modelo seja JSON válido. O uso json_schema é preferencial para modelos que dão suporte a ele.

Propriedade	Valor
Descrição	Um objeto que especifica o formato que o modelo deve gerar.

A configuração { "type": "json_schema" } habilita saídas estruturadas, o que garante que o modelo corresponda ao esquema JSON fornecido. Saiba mais em

O formato padrão é { "type": "text" } sem opções adicionais.

Não recomendado para modelos gpt-4o e mais recentes:

A configuração para { "type": "json_object" } habilita o modo JSON antigo, garantindo que a mensagem gerada pelo modelo seja JSON válido. O uso json_schema é preferencial para modelos que dão suporte a ele. | | Tipo | cadeia de caracteres | | Valores | text
json_schema
json_object |

OpenAI.ResponseUsage

Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, uma divisão de tokens de saída e o total de tokens usados.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
input_tokens	inteiro	O número de tokens de entrada.	Yes
input_tokens_details	objeto	Um detalhamento detalhado dos tokens de entrada.	Yes
└─ tokens em cache	inteiro	O número de tokens recuperados do cache. Mais informações sobre o cache de prompts.	Não
output_tokens	inteiro	O número de tokens de saída.	Yes
output_tokens_details	objeto	Um detalhamento detalhado dos tokens de saída.	Yes
└─ tokens_de_raciocínio	inteiro	O número de tokens de raciocínio.	Não
total_tokens	inteiro	O número total de tokens usados.	Yes

OpenAI.ResponseWebSearchCallCompletedEvent

Observação: web_search ainda não está disponível por meio do Azure OpenAI.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	ID exclusiva para o item de saída associado à chamada de pesquisa na Web.	Yes
output_index	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

Observação: web_search ainda não está disponível por meio do Azure OpenAI.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	ID exclusiva para o item de saída associado à chamada de pesquisa na Web.	Yes
output_index	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

Observação: web_search ainda não está disponível por meio do Azure OpenAI.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
item_id	cadeia	ID exclusiva para o item de saída associado à chamada de pesquisa na Web.	Yes
output_index	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 função assistant.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
conteúdo	cadeia de caracteres ou matriz		Yes
função	enumeração	A função da mensagem, que é sempre assistant. Valores possíveis: assistant	Yes

OpenAI.ResponsesAssistantMessageItemResource

Um item de recurso de mensagem com a função assistant.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
conteúdo	matriz	O conteúdo associado à mensagem.	Yes
função	enumeração	A função da mensagem, que é sempre assistant. Valores possíveis: assistant	Yes

OpenAI.ResponsesDeveloperMessageItemParam

Um item de parâmetro de mensagem com a função developer.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
conteúdo	cadeia de caracteres ou matriz		Yes
função	enumeração	A função da mensagem, que é sempre developer. Valores possíveis: developer	Yes

OpenAI.ResponsesDeveloperMessageItemResource

Um item de recurso de mensagem com a função developer.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
conteúdo	matriz	O conteúdo associado à mensagem.	Yes
função	enumeração	A função da mensagem, que é sempre developer. Valores possíveis: developer	Yes

OpenAI.ResponsesMessageItemParam

Um item de mensagem de resposta, que representa uma função e um conteúdo, conforme fornecido como parâmetros de solicitação do cliente.

Discriminador para OpenAI.ResponsesMessageItemParam

Esse 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	DESCRIÇÃO	Obrigatório	Padrão
função	objeto	A coleção de funções válidas para itens de mensagem de respostas.	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, que representa uma função e um conteúdo, conforme fornecido nas respostas do serviço.

Discriminador para OpenAI.ResponsesMessageItemResource

Esse 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	DESCRIÇÃO	Obrigatório	Padrão
função	objeto	A coleção de funções válidas para itens de mensagem de respostas.	Yes
status	enumeração	A situação do item. Um de in_progress, completed, ou incomplete. Populado quando os itens são retornados por meio da API. Valores possíveis: in_progress, , completedincomplete	Yes
tipo	enumeração	O tipo 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 respostas.

Propriedade	Valor
Descrição	A coleção de funções válidas para itens de mensagem de respostas.
Tipo	cadeia
Valores	system developer user assistant

OpenAI.ResponsesSystemMessageItemParam

Um item de parâmetro de mensagem com a função system.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
conteúdo	cadeia de caracteres ou matriz		Yes
função	enumeração	A função da mensagem, que é sempre system. Valores possíveis: system	Yes

OpenAI.ResponsesSystemMessageItemResource

Um item de recurso de mensagem com a função system.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
conteúdo	matriz	O conteúdo associado à mensagem.	Yes
função	enumeração	A função da mensagem, que é sempre system. Valores possíveis: system	Yes

OpenAI.ResponsesUserMessageItemParam

Um item de parâmetro de mensagem com a função user.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
conteúdo	cadeia de caracteres ou matriz		Yes
função	enumeração	A função da mensagem, que é sempre user. Valores possíveis: user	Yes

OpenAI.ResponsesUserMessageItemResource

Um item de recurso de mensagem com a função user.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
conteúdo	matriz	O conteúdo associado à mensagem.	Yes
função	enumeração	A função 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 "automático", a solicitação será processada com a camada de serviço configurada nas configurações do Projeto. A menos que esteja configurado de outra forma, o Projeto usará "padrão".
• Se definido como "padrão", a solicitação será processada com o preço padrão e o desempenho do modelo selecionado.
• Se definido como 'flex' ou 'priority', a solicitação será processada com a camada de serviço correspondente. Entre em contato com as vendas para saber mais sobre o processamento de prioridade.
• Quando não definido, o comportamento padrão é 'auto'.

Quando o service_tier parâmetro for definido, o corpo da resposta incluirá o service_tier valor com base no modo de processamento realmente usado para atender à solicitação. Esse valor de resposta pode ser diferente do valor definido no parâmetro.

Propriedade	Valor
Descrição	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 configurado nas configurações do Projeto. A menos que esteja configurado de outra forma, o Projeto usará "padrão". * Se definido como 'padrão', a solicitação será processada com o padrão preços e desempenho para o modelo selecionado. * Se definido como 'flex' ou "prioridade", a solicitação será processada com o serviço correspondente camada. Entre em contato com as vendas para saber mais sobre o processamento de prioridade. * Quando não definido, o comportamento padrão é 'auto'. Quando o service_tier parâmetro for definido, o corpo da resposta incluirá o service_tier 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.
Tipo	cadeia
Valores	auto default flex scale priority

OpenAI.TextResponseFormatConfiguration

Um objeto que especifica o formato que o modelo deve gerar.

A configuração { "type": "json_schema" } habilita saídas estruturadas, o que garante que o modelo corresponda ao esquema JSON fornecido. Saiba mais em

O formato padrão é { "type": "text" } sem opções adicionais.

Não recomendado para modelos gpt-4o e mais recentes:*

A configuração para { "type": "json_object" } habilita o modo JSON antigo, garantindo que a mensagem gerada pelo modelo seja JSON válido. O uso json_schema é preferencial para modelos que dão suporte a ele.

Discriminador para OpenAI.TextResponseFormatConfiguration

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

Valor do tipo	Schema

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	cadeia		Yes

OpenAI.Tool

Discriminador para OpenAI.Tool

Esse 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	DESCRIÇÃO	Obrigatório	Padrão
tipo	OpenAI.ToolType	Uma ferramenta que pode ser usada para gerar uma resposta.	Yes

OpenAI.ToolChoiceObject

Discriminador para OpenAI.ToolChoiceObject

Esse 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	DESCRIÇÃO	Obrigatório	Padrão
tipo	OpenAI.ToolChoiceObjectType	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. Saiba mais sobre ferramentas internas.	Yes

OpenAI.ToolChoiceObjectCodeInterpreter

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: code_interpreter	Yes

OpenAI.ToolChoiceObjectComputer

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: computer_use_preview	Yes

OpenAI.ToolChoiceObjectFileSearch

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: file_search	Yes

OpenAI.ToolChoiceObjectFunction

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nome	cadeia	O nome da função a ser chamada.	Yes
tipo	enumeração	Para a chamada de função, o tipo é sempre function. Valores possíveis: function	Yes

OpenAI.ToolChoiceObjectImageGen

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: image_generation	Yes

OpenAI.ToolChoiceObjectMCP

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nome	cadeia	O nome da ferramenta a ser chamada no servidor.	Não
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP a ser usado.	Yes
tipo	enumeração	Quanto ás ferramentas MCP, o tipo será 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 internas.

Propriedade	Valor
Descrição	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta.
Saiba mais sobre ferramentas internas.
Tipo	cadeia
Valores	file_search function computer_use_preview web_search_preview image_generation code_interpreter mcp

OpenAI.ToolChoiceObjectWebSearch

Observação: web_search ainda não está disponível por meio do Azure OpenAI.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: web_search_preview	Yes

OpenAI.ToolChoiceOptions

Controla qual ferramenta (se houver) é chamada pelo modelo.

none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem.

auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas.

required significa que o modelo deve chamar uma ou mais ferramentas.

Propriedade	Valor
Descrição	Controla qual ferramenta (se houver) é chamada pelo modelo. none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem. auto significa que o modelo pode escolher entre gerar uma mensagem ou fazer uma chamada mais ferramentas. required significa que o modelo deve chamar uma ou mais ferramentas.
Tipo	cadeia
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.
Tipo	cadeia
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 de log superior de um token.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
bytes	matriz		Yes
logprob	número		Yes
símbolo	cadeia		Yes

OpenAI.UpdateConversationRequest

Atualizar uma conversa

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	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 por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres, boolianos ou números.

Tipo: objeto

OpenAI.WebSearchAction

Discriminador para OpenAI.WebSearchAction

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

Valor do tipo	Schema
find	OpenAI.WebSearchActionFind
open_page	OpenAI.WebSearchActionOpenPage
search	OpenAI.WebSearchActionSearch

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	OpenAI.WebSearchActionType		Yes

OpenAI.WebSearchActionFind

Tipo de ação "localizar": pesquisa um padrão em uma página carregada.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
padrão	cadeia	O padrão ou texto a ser pesquisado na página.	Yes
tipo	enumeração	O tipo de ação. Valores possíveis: find	Yes
url	cadeia	A URL da página pesquisou o padrão.	Yes

OpenAI.WebSearchActionOpenPage

Tipo de ação "open_page" - abre uma URL específica dos resultados da pesquisa.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	O tipo de ação. Valores possíveis: open_page	Yes
url	cadeia	A URL aberta pelo modelo.	Yes

OpenAI.WebSearchActionSearch

Tipo de ação "pesquisa" - Executa uma consulta de pesquisa na Web.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
consulta	cadeia	A consulta de pesquisa.	Yes
Fontes	matriz	As fontes usadas na pesquisa.	Não
tipo	enumeração	O tipo de ação. Valores possíveis: search	Yes

OpenAI.WebSearchActionSearchSources

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: url	Yes
url	cadeia		Yes

OpenAI.WebSearchActionType

Propriedade	Valor
Tipo	cadeia
Valores	search open_page find

OpenAI.WebSearchPreviewTool

Observação: web_search ainda não está disponível por meio do Azure OpenAI.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tamanho_do_contexto_de_busca	enumeração	Diretrizes de alto nível para a quantidade de espaço de janela de contexto a ser usada para a pesquisa. Uma opção entre low, medium ou high. medium é o padrão. Valores possíveis: low, , mediumhigh	Não
tipo	enumeração	O tipo da ferramenta de pesquisa na Web. Uma opção entre web_search_preview ou web_search_preview_2025_03_11. Valores possíveis: web_search_preview	Yes
localização_do_usuario	objeto		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	DESCRIÇÃO	Obrigatório	Padrão
ação	objeto		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	DESCRIÇÃO	Obrigatório	Padrão
ação	objeto		Yes
└─ tipo	OpenAI.WebSearchActionType		Não
status	enumeração	O status da chamada da ferramenta de pesquisa na Web. Valores possíveis: in_progress, , searching, completedfailed	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, conforme usado para configurar um agente.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
openapi	objeto	As informações de definição de entrada para uma função openapi.	Yes
└─ autenticação	OpenApiAuthDetails	Abrir detalhes de autenticação de 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	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	O nome da função a ser chamada.	Não
└─ especificação		A forma da função openapi, descrita como um objeto de esquema JSON.	Não
tipo	enumeração	O tipo de objeto, que é sempre 'openapi'. Valores possíveis: openapi	Yes

OpenApiAnonymousAuthDetails

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	enumeração	O tipo de objeto, que é sempre 'anônimo'. Valores possíveis: anonymous	Yes

OpenApiAuthDetails

detalhes de autenticação para OpenApiFunctionDefinition

Discriminador para OpenApiAuthDetails

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

Valor do tipo	Schema
anonymous	OpenApiAnonymousAuthDetails
project_connection	OpenApiProjectConnectionAuthDetails
managed_identity	OpenApiManagedAuthDetails

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	objeto	Tipo de autenticação para o ponto de extremidade OpenApi. Os tipos permitidos são: – Anônimo (nenhuma autenticação necessária) - Conexão do Projeto (requer project_connection_id ao ponto de extremidade, como configuração no Foundry) - Managed_Identity (requer audiência para autenticação baseada em identidade)	Yes

OpenApiAuthType

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

• Anônimo (sem necessidade de autenticação)
• Conexão do Projeto (requer project_connection_id ao ponto de extremidade, como configuração no Foundry)
• Managed_Identity (requer público-alvo para autenticação baseada em identidade)

Propriedade	Valor
Tipo	cadeia
Valores	anonymous project_connection managed_identity

OpenApiFunctionDefinition

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
auth	objeto	detalhes de autenticação para OpenApiFunctionDefinition	Yes
└─ tipo	OpenApiAuthType	O tipo de autenticação deve ser anônimo/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	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	O nome da função a ser chamada.	Yes
spec		A forma da função openapi, descrita como um objeto de esquema JSON.	Yes

OpenApiManagedAuthDetails

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
security_scheme	objeto	Esquema de segurança para autenticação de managed_identity OpenApi	Yes
└─ audiência	cadeia	Escopo de autenticação para managed_identity tipo de autenticação	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 de managed_identity OpenApi

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
audience	cadeia	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	DESCRIÇÃO	Obrigatório	Padrão
security_scheme	objeto	Esquema de segurança para autenticação de managed_identity OpenApi	Yes
└─ project_connection_id	cadeia	ID de conexão do Project 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 de managed_identity OpenApi

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
project_connection_id	cadeia	ID de conexão do Project para o tipo de autenticação do Project Connection	Yes

PagedConnection

Coleção paginada de itens de conexão

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nextLink	cadeia	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	DESCRIÇÃO	Obrigatório	Padrão
nextLink	cadeia	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	DESCRIÇÃO	Obrigatório	Padrão
nextLink	cadeia	O link para a próxima página de itens	Não
valor	matriz	Os itens de implantação nesta página	Yes

PagedEvaluationRule

Coleção de páginas de itens EvaluationRule

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nextLink	cadeia	O link para a próxima página de itens	Não
valor	matriz	Os itens EvaluationRule nesta página	Yes

PagedEvaluationTaxonomy

Coleção de páginas de itens EvaluationTaxonomy

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nextLink	cadeia	O link para a próxima página de itens	Não
valor	matriz	Os itens EvaluationTaxonomy nesta página	Yes

PagedEvaluatorVersion

Coleção de páginas de itens EvaluatorVersion

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nextLink	cadeia	O link para a próxima página de itens	Não
valor	matriz	Os itens de EvaluatorVersion nesta página	Yes

PagedIndex

Coleção paginada de itens de índice

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nextLink	cadeia	O link para a próxima página de itens	Não
valor	matriz	Os itens do índice nesta página	Yes

PagedInsight

Coleção de páginas de itens do Insight

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nextLink	cadeia	O link para a próxima página de itens	Não
valor	matriz	Os itens do Insight nesta página	Yes

PagedRedTeam

Coleção paginada de itens RedTeam

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nextLink	cadeia	O link para a próxima página de itens	Não
valor	matriz	Os itens do RedTeam nesta página	Yes

PagedSchedule

Coleção paginada de itens do Cronograma

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nextLink	cadeia	O link para a próxima página de itens	Não
valor	matriz	Os itens de Agendamento nesta página	Yes

PagedScheduleRun

Coleção paginada de itens ScheduleRun

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
nextLink	cadeia	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 de upload pendente.

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

PendingUploadResponse

Representa a resposta para uma solicitação de upload pendente

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
blobReference	objeto	Detalhes de referência de blob.	Yes
└─ blobUri	cadeia	Caminho do URI do blob para o cliente carregar dados. Exemplo: https://blob.windows.core.net/Container/Path	Não
└─ credencial	SasCredential	Informações de credencial para acessar a conta de armazenamento.	Não
└─ storageAccountArmId	cadeia	ID do ARM da conta de armazenamento a ser usada.	Não
pendingUploadId	cadeia	ID para esta solicitação de upload.	Yes
pendingUploadType	enumeração	BlobReference é o único tipo com suporte Valores possíveis: BlobReference	Yes
versão	cadeia	Versão do ativo a ser criado se o usuário não tiver especificado a versão ao criar o upload inicialmente	Não

PromptAgentDefinition

A definição do agente de prompt

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
instructions	cadeia	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo.	Não
variante	enumeração	Valores possíveis: prompt	Yes
modelo	cadeia	A implantação do modelo a ser usada para esse agente.	Yes
reasoning	objeto	somente modelos da série o Opções de configuração para modelos de raciocínio.	Não
└─ esforço	Esforço de Raciocínio da OpenAI	Restringe o esforço de raciocínio para modelos de raciocínio. Atualmente, os valores com suporte são nenhum, mínimo, baixo, médio e alto. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio de uma resposta. gpt-5.1 usa como padrão nenhum, o que não executa o raciocínio. Os valores de raciocínio com suporte para gpt-5.1 são nenhum, baixo, médio e alto. Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. Todos os modelos antes do gpt-5.1 são padrão para o esforço de raciocínio médio e não dão suporte a nenhum. O modelo gpt-5-pro usa como padrão (e só dá suporte) ao alto esforço de raciocínio.	Não
└─ gerar_resumo	enumeração	Preterido: use summary em vez disso. Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo. Uma opção entre auto, concise ou detailed. Valores possíveis: auto, , concisedetailed	Não
└─ resumo	enumeração	Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo. Uma opção entre auto, concise ou detailed. Valores possíveis: auto, , concisedetailed	Não
structured_inputs	objeto	Conjunto de entradas estruturadas que podem participar da substituição de modelo de prompt ou associações de argumento de ferramenta.	Não
temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou top_p, mas não as duas coisas.	Não	1
enviar SMS	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto sem formatação 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, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa apenas os tokens que compõem os 10% superiores da massa de probabilidade%. são considerados. Geralmente recomendamos alterar isso ou temperature, mas não as duas coisas.	Não	1

PromptBasedEvaluatorDefinition

Avaliador baseado em prompt

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
prompt_text	cadeia	O texto de 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	DESCRIÇÃO	Obrigatório	Padrão
protocolo	objeto		Yes
versão	cadeia	A string de versão do protocolo, por exemplo, 'v0.1.1'.	Yes

RaiConfig

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
rai_policy_name	cadeia	O nome da política RAI a ser aplicada.	Yes

RecurrenceSchedule

Modelo de cronograma de recorrência.

Discriminatório para RecurrenceSchedule

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

Valor do tipo	Schema
Hourly	HourlyRecurrenceSchedule
Daily	DailyRecurrenceSchedule
Weekly	WeeklyRecurrenceSchedule
Monthly	MonthlyRecurrenceSchedule

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	objeto	Tipo de recorrência.	Yes

RecurrenceTrigger

Gatilho baseado em recorrência.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
endTime	cadeia	Hora de término do agendamento de recorrência no formato ISO 8601.	Não
intervalo	inteiro	Intervalo para o agendamento de recorrência.	Yes
cronograma	objeto	Modelo de cronograma de recorrência.	Yes
└─ tipo	RecurrenceType	Tipo de recorrência para o agendamento de recorrência.	Não
startTime	cadeia	Hora de início do cronograma de recorrência no formato ISO 8601.	Não
timeZone	cadeia	Fuso horário para o agendamento de recorrência.	Não	UTC
tipo	enumeração	Tipo do gatilho. Valores possíveis: Recurrence	Yes

RecurrenceType

Tipo de recorrência.

Propriedade	Valor
Descrição	Tipo de recorrência.
Tipo	cadeia
Valores	Hourly Daily Weekly Monthly

RedTeam

Detalhes da equipe vermelha.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
applicationScenario	cadeia	Cenário de aplicação para a operação red team, para gerar ataques específicos do cenário.	Não
attackStrategies	matriz	Lista de estratégias de ataque ou listas aninhadas de estratégias de ataque.	Não
nome de exibição	cadeia	Nome da corrida da equipe vermelha.	Não
id	cadeia	Identificador da corrida da equipe vermelha.	Yes
numTurns	inteiro	Número de rodadas de simulação.	Não
propriedades	objeto	Propriedades da equipe vermelha. Ao contrário das marcas, as propriedades são somente suplementos. Depois de adicionada, uma propriedade não pode ser removida.	Não
riskCategories	matriz	Lista de categorias de risco para gerar objetivos de ataque.	Não
simulationOnly	boolean	Simulação apenas ou Simulação + Avaliação. Padrão false, se verdadeiro, a verificação gera a conversa, não o resultado da avaliação.	Não	Falso
status	cadeia	Status da equipe vermelha. Ele é definido pelo serviço e é somente leitura.	Não
tags	objeto	Tags da equipe vermelha. Ao contrário das propriedades, as marcas são totalmente mutáveis.	Não
destino	objeto	Classe abstrata para configuração de destino.	Yes
└─ tipo	cadeia	Tipo de configuração do modelo.	Não

RedTeamItemGenerationParams

Representa os parâmetros para a geração de item de equipe vermelha.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
attack_strategies	matriz	A coleção de estratégias de ataque a serem usadas.	Yes
num_turns	inteiro	O número de turnos permitido no jogo.	Yes
tipo	enumeração	O tipo de parâmetros de geração de item, sempre red_team. Valores possíveis: red_team	Yes

RiskCategory

Categoria de risco para o objetivo do ataque.

Propriedade	Valor
Descrição	Categoria de risco para o objetivo do ataque.
Tipo	cadeia
Valores	HateUnfairness Violence Sexual SelfHarm ProtectedMaterial CodeVulnerability UngroundedAttributes ProhibitedActions SensitiveDataLeakage TaskAdherence

SASCredentials

Definição de credencial de SAS (Assinatura de Acesso Compartilhado)

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
SAS	cadeia	token SAS	Não
tipo	enumeração	O tipo de credencial Valores possíveis: SAS	Yes

SampleType

O tipo de amostra usada na análise.

Propriedade	Valor
Tipo	cadeia
Valores	EvaluationResultSample

SasCredential

Definição de credencial SAS

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
sasUri	cadeia	Uri SAS	Yes
tipo	enumeração	Tipo de credencial Valores possíveis: SAS	Yes

Cronograma

Modelo de agendamento.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	Descrição do agendamento.	Não
nome de exibição	cadeia	Nome da agenda.	Não
enabled	boolean	Status habilitado do agendamento.	Yes
id	cadeia	Identificador da programação.	Yes
propriedades	objeto	Propriedades da tabela. Ao contrário das marcas, as propriedades são somente suplementos. Depois de adicionada, uma propriedade não pode ser removida.	Não
status de provisionamento	objeto	Agende o status de provisionamento.	Não
dados do sistema	objeto	Metadados do sistema para o recurso.	Yes
tags	objeto	Tags de agendamento. Ao contrário das propriedades, as marcas são totalmente mutáveis.	Não
tarefa	objeto	Modelo de tarefa de agendamento.	Yes
Configuração do └─	objeto	Configuração para a tarefa.	Não
└─ tipo	ScheduleTaskType	Tipo da tarefa.	Não
disparador	objeto	Modelo base para Trigger do agendamento.	Yes
└─ tipo	Tipo de gatilho	Tipo do gatilho.	Não

ScheduleProvisioningStatus

Agende o status de provisionamento.

Propriedade	Valor
Descrição	Agende o status de provisionamento.
Tipo	cadeia
Valores	Creating Updating Deleting Succeeded Failed

ScheduleRun

Agendar modelo de execução.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
erro	cadeia	Informações de erro para a execução do agendamento.	Não
id	cadeia	Identificador da execução do agendamento.	Yes
propriedades	objeto	As propriedades da programação são executadas.	Yes
scheduleId	cadeia	Identificador da programação.	Yes
sucesso	boolean	Disparar o status de êxito da execução do agendamento.	Yes
triggerTime	cadeia	Hora do acionamento da execução do agendamento.	Não

Agendar Tarefa

Modelo de tarefa de agendamento.

Discriminador para ScheduleTask

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

Valor do tipo	Schema
Evaluation	EvaluationScheduleTask
Insight	InsightScheduleTask

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
configuração	objeto	Configuração para a tarefa.	Não
tipo	objeto	Tipo da tarefa.	Yes

ScheduleTaskType

Tipo da tarefa.

Propriedade	Valor
Descrição	Tipo da tarefa.
Tipo	cadeia
Valores	Evaluation Insight

SeedPromptsRedTeamItemGenerationParams

Representa os parâmetros para a geração de item de equipe vermelha com prompts de semente.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
attack_strategies	matriz	A coleção de estratégias de ataque a serem usadas.	Yes
num_turns	inteiro	O número de turnos permitido no jogo.	Yes
fonte	objeto		Yes
└─ conteúdo	matriz	O conteúdo do arquivo jsonl.	Não
└─ id	cadeia	O identificador do arquivo.	Não
└─ tipo	enumeraçã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 item, 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, conforme usado para configurar um agente.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
sharepoint_grounding_preview	objeto	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 conexão recurso anexado à ferramenta.	Não
tipo	enumeração	O tipo de objeto, que é sempre 'sharepoint_grounding'. Valores possíveis: sharepoint_grounding_preview	Yes

SharepointGroundingToolParameters

Os parâmetros da ferramenta de aterramento do sharepoint.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
project_connections	matriz	As conexões do projeto anexadas a esta ferramenta. Pode haver um máximo de 1 conexão recurso anexado à ferramenta.	Não

Sku

Informações de SKU

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
capacidade	inteiro	Capacidade de SKU	Yes
family	cadeia	Família Sku	Yes
nome	cadeia	Nome do SKU	Yes
size	cadeia	Tamanho do SKU	Yes
nível	cadeia	Camada de SKU	Yes

StructuredInputDefinition

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
default_value		O valor padrão para a entrada se nenhum valor de tempo de execução for fornecido.	Não
descrição	cadeia	Uma descrição legível da entrada.	Não
required	boolean	Se a propriedade input é necessária quando o agente é chamado.	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	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	Uma descrição da saída a ser emitida. Usado pelo modelo para determinar quando emitir a saída.	Yes
nome	cadeia	O nome da saída estruturada.	Yes
esquema		O esquema JSON para a saída estruturada.	Yes
rigoroso	boolean	Se a validação estrita deve ser imposta. Padrão true.	Yes

StructuredOutputsItemResource

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
saída		A saída estruturada capturada durante a resposta.	Yes
tipo	enumeração	Valores possíveis: structured_outputs	Yes

Meta

Classe base para destinos com suporte a discriminadores.

Discriminador para Destino

Esse 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	DESCRIÇÃO	Obrigatório	Padrão
tipo	cadeia	O tipo de destino.	Yes

TargetCompletions

Representa uma fonte de dados para a configuração de avaliação de conclusão baseada em destino.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
mensagens_de_entrada	objeto		Não
└─ referência_item	cadeia		Não
└─ tipo	enumeração	Valores possíveis: item_reference	Não
fonte	objeto		Yes
└─ conteúdo	matriz	O conteúdo do arquivo jsonl.	Não
└─ id	cadeia	O identificador do arquivo.	Não
└─ tipo	enumeração	Tipo de fonte jsonl. Sempre file_id. Valores possíveis: file_id	Não
destino	objeto	Classe base para destinos com suporte a discriminadores.	Yes
└─ tipo	cadeia	O tipo de destino.	Não
tipo	enumeração	O tipo de fonte de dados, always TargetCompletions. Valores possíveis: azure_ai_target_completions	Yes

TargetConfig

Classe abstrata para configuração de destino.

Discriminador para TargetConfig

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

Valor do tipo	Schema
AzureOpenAIModel	AzureOpenAIModelConfiguration

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	cadeia	Tipo de configuração do modelo.	Yes

TargetUpdate

Classe base para destinos com suporte a discriminadores.

Discriminatório para TargetUpdate

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

Valor do tipo	Schema
azure_ai_model	AzureAIModelTargetUpdate
azure_ai_assistant	AzureAIAssistantTargetUpdate

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	cadeia	O tipo de destino.	Yes

TaxonomyCategory

Definição de categoria de taxonomia.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	Descrição da categoria de taxonomia.	Não
id	cadeia	Identificador único da categoria de taxonomia.	Yes
nome	cadeia	Nome da categoria de taxonomia.	Yes
propriedades	objeto	Propriedades adicionais para a categoria de taxonomia.	Não
riskCategory	objeto	Categoria de risco para o objetivo do ataque.	Yes
Subcategorias	matriz	Lista de subcategorias de taxonomia.	Yes

TaxonomyRedTeamItemGenerationParams

Representa os parâmetros para a geração de item de equipe vermelha com prompts de semente.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
attack_strategies	matriz	A coleção de estratégias de ataque a serem usadas.	Yes
num_turns	inteiro	O número de turnos permitido no jogo.	Yes
fonte	objeto		Yes
└─ conteúdo	matriz	O conteúdo do arquivo jsonl.	Não
└─ id	cadeia	O identificador do arquivo.	Não
└─ tipo	enumeraçã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 item, sempre red_team. Valores possíveis: red_team_taxonomy	Yes

TaxonomySubCategory

Definição de subcategoria de taxonomia.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	Descrição da subcategoria de taxonomia.	Não
enabled	boolean	Lista de itens de taxonomia nesta subcategoria.	Yes
id	cadeia	Identificador único da subcategoria de taxonomia.	Yes
nome	cadeia	Nome da subcategoria de taxonomia.	Yes
propriedades	objeto	Propriedades adicionais para a subcategoria de taxonomia.	Não

ToolDescription

Descrição de uma ferramenta que pode ser usada por um agente.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	Uma breve descrição da finalidade da ferramenta.	Não
nome	cadeia	O nome da ferramenta.	Não

ToolProjectConnection

Um recurso de conexão de projeto.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
project_connection_id	cadeia	Uma conexão de projeto em um ToolProjectConnectionList anexado a essa ferramenta.	Yes

TracesEvalRunDataSource

Representa uma fonte de dados para execuções de avaliação que operam sobre rastreamentos do Agente armazenados no Application Insights.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
lookback_hours	inteiro	Janela de pesquisa (em horas) aplicada ao recuperar rastreamentos 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, always azure_ai_traces. Valores possíveis: azure_ai_traces	Yes

TreatmentEffectType

Tipo de efeito de tratamento.

Propriedade	Valor
Tipo	cadeia
Valores	TooFewSamples Inconclusive Changed Improved Degraded

Disparador

Modelo base para Trigger do agendamento.

Discriminador para gatilho

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

Valor do tipo	Schema
Cron	crontrigger
Recurrence	RecurrenceTrigger
OneTime	OneTimeTrigger

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
tipo	objeto	Tipo do gatilho.	Yes

TriggerType

Tipo do gatilho.

Propriedade	Valor
Descrição	Tipo do gatilho.
Tipo	cadeia
Valores	Cron Recurrence OneTime

UpdateAgentFromManifestRequest

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
descrição	cadeia	Uma descrição legível por humanos do agente.	Não
manifest_id	cadeia	A ID do manifesto da qual importar a versão do agente.	Yes
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
parameter_values	objeto	As entradas para o manifesto que resultarão em um Agente totalmente materializado.	Yes

UpdateAgentRequest

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
definição	objeto		Yes
└─ tipo	AgentKind		Não
└─ rai_config	RaiConfig	Configuração para filtragem de conteúdo e recursos de segurança de IA Responsável (RAI).	Não
descrição	cadeia	Uma descrição legível por humanos do agente.	Não
metadados	objeto	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

UpdateEvalParametersBody

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
metadados	OpenAI.Metadata	Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto de maneira estruturada formatar e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia		Não
propriedades	objeto	Conjunto de 16 pares chave-valor imutáveis que podem ser anexados a um objeto para armazenar informações adicionais. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	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	DESCRIÇÃO	Obrigatório	Padrão
variante	enumeração	O tipo de item de memória. Valores possíveis: user_profile	Yes

WeeklyRecurrenceSchedule

Cronograma de recorrência semanal.

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
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

WorkflowActionOutputItemResource

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
action_id	cadeia	Identificador exclusivo para a ação.	Yes
variante	cadeia	O tipo de ação CSDL (por exemplo, 'SetVariable', 'InvokeAzureAgent').	Yes
parent_action_id	cadeia	ID da ação pai se esta for uma ação aninhada.	Não
previous_action_id	cadeia	ID da ação anterior se essa ação seguir outra.	Não
status	enumeração	Status da ação (por exemplo, 'in_progress', 'concluída', 'falha', 'cancelada'). Valores possíveis: completed, , failed, in_progresscancelled	Yes
tipo	enumeração	Valores possíveis: workflow_action	Yes

WorkflowAgentDefinition

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

Nome	Tipo	DESCRIÇÃO	Obrigatório	Padrão
variante	enumeração	Valores possíveis: workflow	Yes
fluxo de trabalho	cadeia	A definição YAML CSDL do fluxo de trabalho.	Não

inteiro

Tipo: inteiro

Formato: int64