Azure OpenAI evals

Versão API: v1

Server:{endpoint}/openai/v1 — APIs Azure AI Foundry Models

Variáveis do Servidor:

Variable	Predefinição	Description
ponto final		Um endpoint suportado para APIs do Azure AI Foundry Models, incluindo protocolo e nome de host. Por exemplo: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).

Authentication

ApiKeyAuth (Chave API)

Passa a tua chave API no api-key cabeçalho.

ApiKeyAuth_ (Chave API)

Passa a tua chave API no authorization cabeçalho.

OAuth2Auth (OAuth 2.0)

Fluxo: implícito

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

Alcances:

https://cognitiveservices.azure.com/.default

Requisitos de segurança

Os endpoints aceitam qualquer um dos seguintes métodos de autenticação:

ApiKeyAuth
ApiKeyAuth_
OAuth2Auth (telescópio: https://cognitiveservices.azure.com/.default)

Lista de avaliações

GET {endpoint}/openai/v1/evals

Listar avaliações de um projeto.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	servidor	Sim	cadeia (de caracteres)	Um endpoint suportado para APIs do Azure AI Foundry Models, incluindo protocolo e nome de host. Por exemplo: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
Versão da API	consulta	No	cadeia (de caracteres) Valores possíveis: `v1`, `preview`	A versão explícita da API do Azure AI Foundry Models a ser usada para essa solicitação. `v1` se não especificado de outra forma.
depois	consulta	No	cadeia (de caracteres)	Identificador da última avaliação da solicitação de paginação anterior. Serialização: explode: false
limit	consulta	No	inteiro (int32)	Um limite no número de avaliações a serem retornadas numa única resposta de paginação. Serialização: explode: false
order	consulta	No	cadeia (de caracteres) Valores possíveis: `asc`, `desc`	Ordem de ordenação das avaliações por carimbo de data/hora. Use `asc` para ordem crescente ou `desc` por ordem decrescente. Serialização: explode: false
ordenar por	consulta	No	cadeia (de caracteres) Valores possíveis: `created_at`, `updated_at`	Os Evals podem ser ordenados por hora de criação ou hora da última atualização. Use `created_at` para o tempo de criação ou `updated_at` para a última atualização Hora. Serialização: explode: false

Responses

Código de status: 200

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

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

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objecto

Name	Tipo	Obrigatório
código	string ou null	Sim
inner_error		No
mensagem	cadeia (de caracteres)	Sim
param	string ou null	No
tipo	cadeia (de caracteres)	No

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Criar avaliação

POST {endpoint}/openai/v1/evals

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 uma fonte de dados. Depois de criar uma avaliação, você pode executá-la em diferentes modelos e parâmetros de modelo. Suportamos vários tipos de classificadores e fontes de dados.

Para mais informações, consulte o guia de Avaliações.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	servidor	Sim	cadeia (de caracteres)	Um endpoint suportado para APIs do Azure AI Foundry Models, incluindo protocolo e nome de host. Por exemplo: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
Versão da API	consulta	No	cadeia (de caracteres) Valores possíveis: `v1`, `preview`	A versão explícita da API do Azure AI Foundry Models a ser usada para essa solicitação. `v1` se não especificado de outra forma.

Órgão do Pedido

Tipo de conteúdo: application/json

Name	Tipo	Description	Obrigatório
configuração_fonte_dados	OpenAI.CreateEvalCustomDataSourceConfig ou OpenAI.CreateEvalLogsDataSourceConfig ou OpenAI.CreateEvalStoredCompletionsDataSourceConfig	A configuração da fonte de dados utilizada para a avaliação é executada. Dita o esquema dos dados usados na avaliação.	Sim
metadados	OpenAI.Metadata ou null		No
Nome	cadeia (de caracteres)	O nome da avaliação.	No
código de estado	enumeração	Valores possíveis: `201`	Sim
critérios_teste	array of OpenAI.CreateEvalLabelModelGrader ou OpenAI.EvalGraderStringCheck ou OpenAI.EvalGraderTextSimilarity ou OpenAI.EvalGraderPython ou OpenAI.EvalGraderScoreModel ou EvalGraderEndpoint	Uma lista de classificadores para todas as execuções de avaliação neste grupo. Os avaliadores podem fazer referência a variáveis na fonte de dados usando a notação de chaves duplas, como `{{item.variable_name}}`. Para fazer referência à saída do modelo, use o `sample` namespace (ou seja, `{{sample.output_text}}`).	Sim

Responses

Código de status: 200

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

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

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objecto

Name	Tipo	Obrigatório
código	string ou null	Sim
inner_error		No
mensagem	cadeia (de caracteres)	Sim
param	string ou null	No
tipo	cadeia (de caracteres)	No

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Obter eval

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

Recupere uma avaliação através do seu ID. Recupera uma avaliação por seu ID.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	servidor	Sim	cadeia (de caracteres)	Um endpoint suportado para APIs do Azure AI Foundry Models, incluindo protocolo e nome de host. Por exemplo: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
Versão da API	consulta	No	cadeia (de caracteres) Valores possíveis: `v1`, `preview`	A versão explícita da API do Azure AI Foundry Models a ser usada para essa solicitação. `v1` se não especificado de outra forma.
eval_id	caminho	Sim	cadeia (de caracteres)

Responses

Código de status: 200

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

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

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objecto

Name	Tipo	Obrigatório
código	string ou null	Sim
inner_error		No
mensagem	cadeia (de caracteres)	Sim
param	string ou null	No
tipo	cadeia (de caracteres)	No

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Atualização da avaliação

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

Atualizar propriedades selecionadas e mutáveis de uma avaliação especificada.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	servidor	Sim	cadeia (de caracteres)	Um endpoint suportado para APIs do Azure AI Foundry Models, incluindo protocolo e nome de host. Por exemplo: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
Versão da API	consulta	No	cadeia (de caracteres) Valores possíveis: `v1`, `preview`	A versão explícita da API do Azure AI Foundry Models a ser usada para essa solicitação. `v1` se não especificado de outra forma.
eval_id	caminho	Sim	cadeia (de caracteres)

Órgão do Pedido

Tipo de conteúdo: application/json

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

Responses

Código de status: 200

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

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

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objecto

Name	Tipo	Obrigatório
código	string ou null	Sim
inner_error		No
mensagem	cadeia (de caracteres)	Sim
param	string ou null	No
tipo	cadeia (de caracteres)	No

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Excluir eval

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

Exclua uma avaliação especificada.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	servidor	Sim	cadeia (de caracteres)	Um endpoint suportado para APIs do Azure AI Foundry Models, incluindo protocolo e nome de host. Por exemplo: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
Versão da API	consulta	No	cadeia (de caracteres) Valores possíveis: `v1`, `preview`	A versão explícita da API do Azure AI Foundry Models a ser usada para essa solicitação. `v1` se não especificado de outra forma.
eval_id	caminho	Sim	cadeia (de caracteres)

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	objecto

Name	Tipo	Description	Obrigatório
Suprimido	boolean		Sim
eval_id	cadeia (de caracteres)		Sim
objecto	enumeração	Valores possíveis: `eval.deleted`	Sim

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objecto

Name	Tipo	Obrigatório
código	string ou null	Sim
inner_error		No
mensagem	cadeia (de caracteres)	Sim
param	string ou null	No
tipo	cadeia (de caracteres)	No

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Obter execuções de avaliação

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

Recupere uma lista de execuções para uma avaliação especificada.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	servidor	Sim	cadeia (de caracteres)	Um endpoint suportado para APIs do Azure AI Foundry Models, incluindo protocolo e nome de host. Por exemplo: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
Versão da API	consulta	No	cadeia (de caracteres) Valores possíveis: `v1`, `preview`	A versão explícita da API do Azure AI Foundry Models a ser usada para essa solicitação. `v1` se não especificado de outra forma.
eval_id	caminho	Sim	cadeia (de caracteres)
depois	consulta	No	cadeia (de caracteres)	Serialização: explode: false
limit	consulta	No	inteiro (int32)	Serialização: explode: false
order	consulta	No	cadeia (de caracteres) Valores possíveis: `asc`, `desc`	Serialização: explode: false
estado	consulta	No	cadeia (de caracteres) Valores possíveis: `queued`, `in_progress`, `completed`, `canceled`, , `failed`	Serialização: explode: false

Responses

Código de status: 200

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

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

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objecto

Name	Tipo	Obrigatório
código	string ou null	Sim
inner_error		No
mensagem	cadeia (de caracteres)	Sim
param	string ou null	No
tipo	cadeia (de caracteres)	No

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Criar execução de avaliação

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

Crie uma nova execução de teste, iniciando o processo de classificação.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	servidor	Sim	cadeia (de caracteres)	Um endpoint suportado para APIs do Azure AI Foundry Models, incluindo protocolo e nome de host. Por exemplo: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
Versão da API	consulta	No	cadeia (de caracteres) Valores possíveis: `v1`, `preview`	A versão explícita da API do Azure AI Foundry Models a ser usada para essa solicitação. `v1` se não especificado de outra forma.
eval_id	caminho	Sim	cadeia (de caracteres)

Órgão do Pedido

Tipo de conteúdo: application/json

Name	Tipo	Description	Obrigatório
fonte_de_dados	OpenAI.CreateEvalJsonlRunDataSource ou OpenAI.CreateEvalCompletionsRunDataSource ou OpenAI.CreateEvalResponsesRunDataSource	Detalhes sobre a fonte de dados da corrida.	Sim
metadados	OpenAI.Metadata ou null		No
Nome	cadeia (de caracteres)	O nome da execução.	No

Responses

Código de status: 201

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

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

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objecto

Name	Tipo	Obrigatório
código	string ou null	Sim
inner_error		No
mensagem	cadeia (de caracteres)	Sim
param	string ou null	No
tipo	cadeia (de caracteres)	No

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Executar eval

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

Recupere uma avaliação específica executada por seu ID.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	servidor	Sim	cadeia (de caracteres)	Um endpoint suportado para APIs do Azure AI Foundry Models, incluindo protocolo e nome de host. Por exemplo: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
Versão da API	consulta	No	cadeia (de caracteres) Valores possíveis: `v1`, `preview`	A versão explícita da API do Azure AI Foundry Models a ser usada para essa solicitação. `v1` se não especificado de outra forma.
eval_id	caminho	Sim	cadeia (de caracteres)
run_id	caminho	Sim	cadeia (de caracteres)

Responses

Código de status: 200

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

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

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objecto

Name	Tipo	Obrigatório
código	string ou null	Sim
inner_error		No
mensagem	cadeia (de caracteres)	Sim
param	string ou null	No
tipo	cadeia (de caracteres)	No

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Cancelar execução de avaliação

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

Cancelar uma avaliação específica executada pelo seu ID.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	servidor	Sim	cadeia (de caracteres)	Um endpoint suportado para APIs do Azure AI Foundry Models, incluindo protocolo e nome de host. Por exemplo: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
Versão da API	consulta	No	cadeia (de caracteres) Valores possíveis: `v1`, `preview`	A versão explícita da API do Azure AI Foundry Models a ser usada para essa solicitação. `v1` se não especificado de outra forma.
eval_id	caminho	Sim	cadeia (de caracteres)
run_id	caminho	Sim	cadeia (de caracteres)

Responses

Código de status: 200

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

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

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objecto

Name	Tipo	Obrigatório
código	string ou null	Sim
inner_error		No
mensagem	cadeia (de caracteres)	Sim
param	string ou null	No
tipo	cadeia (de caracteres)	No

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Excluir execução de avaliação

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

Exclua uma avaliação específica executada por seu ID.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	servidor	Sim	cadeia (de caracteres)	Um endpoint suportado para APIs do Azure AI Foundry Models, incluindo protocolo e nome de host. Por exemplo: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
Versão da API	consulta	No	cadeia (de caracteres) Valores possíveis: `v1`, `preview`	A versão explícita da API do Azure AI Foundry Models a ser usada para essa solicitação. `v1` se não especificado de outra forma.
eval_id	caminho	Sim	cadeia (de caracteres)
run_id	caminho	Sim	cadeia (de caracteres)

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	objecto

Name	Tipo	Description	Obrigatório
Suprimido	boolean		Sim
eval_run_id	cadeia (de caracteres)		Sim
objecto	enumeração	Valores possíveis: `eval_run.deleted`	Sim

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objecto

Name	Tipo	Obrigatório
código	string ou null	Sim
inner_error		No
mensagem	cadeia (de caracteres)	Sim
param	string ou null	No
tipo	cadeia (de caracteres)	No

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Obter itens de saída de execução de avaliação

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

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

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	servidor	Sim	cadeia (de caracteres)	Um endpoint suportado para APIs do Azure AI Foundry Models, incluindo protocolo e nome de host. Por exemplo: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
Versão da API	consulta	No	cadeia (de caracteres) Valores possíveis: `v1`, `preview`	A versão explícita da API do Azure AI Foundry Models a ser usada para essa solicitação. `v1` se não especificado de outra forma.
eval_id	caminho	Sim	cadeia (de caracteres)
run_id	caminho	Sim	cadeia (de caracteres)
depois	consulta	No	cadeia (de caracteres)	Serialização: explode: false
limit	consulta	No	inteiro (int32)	Serialização: explode: false
estado	consulta	No	cadeia (de caracteres) Valores possíveis: `fail`, `pass`	Serialização: explode: false
order	consulta	No	cadeia (de caracteres) Valores possíveis: `asc`, `desc`	Serialização: explode: false

Responses

Código de status: 200

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

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

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objecto

Name	Tipo	Obrigatório
código	string ou null	Sim
inner_error		No
mensagem	cadeia (de caracteres)	Sim
param	string ou null	No
tipo	cadeia (de caracteres)	No

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Obter item de saída da execução de avaliação

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

Recupere um item de saída específico de uma avaliação utilizando o seu ID.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	servidor	Sim	cadeia (de caracteres)	Um endpoint suportado para APIs do Azure AI Foundry Models, incluindo protocolo e nome de host. Por exemplo: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
Versão da API	consulta	No	cadeia (de caracteres) Valores possíveis: `v1`, `preview`	A versão explícita da API do Azure AI Foundry Models a ser usada para essa solicitação. `v1` se não especificado de outra forma.
eval_id	caminho	Sim	cadeia (de caracteres)
run_id	caminho	Sim	cadeia (de caracteres)
output_item_id	caminho	Sim	cadeia (de caracteres)

Responses

Código de status: 200

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

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

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objecto

Name	Tipo	Obrigatório
código	string ou null	Sim
inner_error		No
mensagem	cadeia (de caracteres)	Sim
param	string ou null	No
tipo	cadeia (de caracteres)	No

Cabeçalhos de Resposta:

Header	Tipo	Description
APIM-Request-ID	cadeia (de caracteres)	Um ID de pedido usado para fins de resolução de problemas.

Components

AzureAIFoundryModelsApiVersion

Property	Valor
Type	cadeia (de caracteres)
Valores	`v1` `preview`

AzureCompletionsSamplingParams

Parâmetros de amostragem para controlar o comportamento das completações.

Name	Tipo	Description	Obrigatório	Predefinição
max_completion_tokens	número inteiro		No
máximo de tokens	inteiro (int32)	O número máximo de tokens na saída gerada.	No
esforço de raciocínio	OpenAI.ReasoningEffort	Restringe o esforço para raciocínio lógico. modelos de raciocínio. Os valores atualmente suportados são `none`, `minimal`, `low`, `medium`, `high`, e `xhigh`. Reduzindo O esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados sobre o raciocínio numa resposta. - `gpt-5.1` por defeito é `none`, que não executa raciocínio. Os valores de raciocínio suportados para `gpt-5.1` são `none`, `low`, `medium`, e `high`. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. - Todos os modelos anteriores `gpt-5.1` por defeito, para `medium` esforço de raciocínio, e não suportam `none`. - O `gpt-5-pro` modelo utiliza por defeito (e apenas suporta) `high` esforço de raciocínio. - `xhigh` é suportado para todos os modelos após `gpt-5.1-codex-max`.	No
formato_de_resposta	OpenAI.ResponseFormatText ou OpenAI.ResponseFormatJsonSchema ou OpenAI.ResponseFormatJsonObject		No
seed	número inteiro	Um valor seed inicializa a aleatoriedade durante a amostragem.	No	42
Temperatura	number	Uma temperatura mais alta aumenta a aleatoriedade nas saídas.	No	1
tools	array de OpenAI.ChatCompletionTool		No
top_p	number	Uma alternativa à temperatura para a amostragem do núcleo; 1.0 inclui todos os tokens.	No	1

AzureResponsesSamplingParams

Parâmetros de amostragem para controlar o comportamento das respostas.

Name	Tipo	Description	Obrigatório	Predefinição
máximo de tokens	inteiro (int32)	O número máximo de tokens na saída gerada.	No
esforço de raciocínio	OpenAI.ReasoningEffort	Restringe o esforço para raciocínio lógico. modelos de raciocínio. Os valores atualmente suportados são `none`, `minimal`, `low`, `medium`, `high`, e `xhigh`. Reduzindo O esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados sobre o raciocínio numa resposta. - `gpt-5.1` por defeito é `none`, que não executa raciocínio. Os valores de raciocínio suportados para `gpt-5.1` são `none`, `low`, `medium`, e `high`. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. - Todos os modelos anteriores `gpt-5.1` por defeito, para `medium` esforço de raciocínio, e não suportam `none`. - O `gpt-5-pro` modelo utiliza por defeito (e apenas suporta) `high` esforço de raciocínio. - `xhigh` é suportado para todos os modelos após `gpt-5.1-codex-max`.	No
seed	número inteiro	Um valor seed inicializa a aleatoriedade durante a amostragem.	No	42
Temperatura	number	Uma temperatura mais alta aumenta a aleatoriedade nas saídas.	No	1
enviar SMS	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		No
tools	array do OpenAI.Tool		No
top_p	number	Uma alternativa à temperatura para a amostragem do núcleo; 1.0 inclui todos os tokens.	No	1

AzureToolApprovalResponse

Resposta de aprovação da ferramenta Azure

Uma resposta de aprovação da ferramenta Azure na entrada do pedido.

Name	Tipo	Description	Obrigatório
approval_request_id	cadeia (de caracteres)	O identificador do pedido de aprovação ao qual se está a responder.	Sim
approve	boolean	Se o pedido foi aprovado.	Sim
tipo	enumeração	O tipo do artigo. Sempre `tool_approval_response`. Valores possíveis: `tool_approval_response`	Sim

EvalGraderEndpoint

Name	Tipo	Description	Obrigatório	Predefinição
headers	objeto ou nulo	Cabeçalhos HTTP opcionais para incluir nos pedidos ao endpoint	No
Nome	cadeia (de caracteres)	O nome do nivelador	Sim
limite_de_passagem	Número ou nulo	Pontuação limiar opcional acima da qual a nota é considerada aprovada Se não for especificado, todas as pontuações são consideradas válidas	No
rate_limit	inteiro ou nulo	Limite opcional de taxa para pedidos por segundo ao endpoint Deve ser um inteiro positivo	No
tipo	enumeração	Valores possíveis: `endpoint`	Sim	ponto final
url	cadeia (de caracteres)	O URL HTTPS do endpoint para chamar para gradação Restrições: padrão: `^https://`	Sim

OpenAI.Annotation

Uma anotação que se aplica a um espaço de texto de saída.

Discriminador para OpenAI.Annotation

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

Valor do tipo	Schema
`file_citation`	OpenAI.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.AnnotationType		Sim

OpenAI.AnnotationType

Property	Valor
Type	cadeia (de caracteres)
Valores	`file_citation` `url_citation` `container_file_citation` `file_path`

OpenAI.ApplyPatchCallOutputStatusParam

Aplicar o estado de saída da chamada de patch

Valores de resultado reportados para apply_patch saídas de chamadas de ferramenta.

Property	Valor
Type	cadeia (de caracteres)
Valores	`completed` `failed`

OpenAI.ApplyPatchCallStatusParam

Aplicar o estado da chamada de contacto

Valores de estado reportados para chamadas apply_patch ferramentas.

Property	Valor
Type	cadeia (de caracteres)
Valores	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperationParam

Aplicar a operação de criação de ficheiro de patch

Instrução para criar um novo ficheiro através da ferramenta apply_patch.

Name	Tipo	Description	Obrigatório	Predefinição
Diff	cadeia (de caracteres)	Conteúdo diferenciado unificado para aplicar na criação do ficheiro. Restrições: maxComprimento: 10485760	Sim
caminho	cadeia (de caracteres)	Caminho do ficheiro a criar em relação à raiz do espaço de trabalho. Restrições: minComprimento: 1	Sim
tipo	enumeração	O tipo de operação. Sempre `create_file`. Valores possíveis: `create_file`	Sim	create_file

OpenAI.ApplyPatchDeleteFileOperationParam

Aplicar a operação de eliminação de ficheiros com patch

Instrução para eliminar um ficheiro existente através da ferramenta apply_patch.

Name	Tipo	Description	Obrigatório	Predefinição
caminho	cadeia (de caracteres)	Caminho do ficheiro a eliminar em relação à raiz do workspace. Restrições: minComprimento: 1	Sim
tipo	enumeração	O tipo de operação. Sempre `delete_file`. Valores possíveis: `delete_file`	Sim	delete_file

OpenAI.ApplyPatchOperationParam

Aplicar operação de patch

Uma das operações create_file, delete_file ou update_file fornecidas à ferramenta apply_patch.

Discriminador para OpenAI.ApplyPatchOperationParam

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

Valor do tipo	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperationParam
`delete_file`	OpenAI.ApplyPatchDeleteFileOperationParam
`update_file`	OpenAI.ApplyPatchUpdateFileOperationParam

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.ApplyPatchOperationParamType		Sim

OpenAI.ApplyPatchOperationParamType

Property	Valor
Type	cadeia (de caracteres)
Valores	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

Aplicar a ferramenta de remendos

Permite ao assistente criar, eliminar ou atualizar ficheiros usando diferenciais unificados.

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

OpenAI.ApplyPatchUpdateFileOperationParam

Aplicar a operação de atualização do ficheiro de atualização

Instrução para atualizar um ficheiro existente através da ferramenta apply_patch.

Name	Tipo	Description	Obrigatório	Predefinição
Diff	cadeia (de caracteres)	Conteúdo diferencial unificado para aplicar ao ficheiro existente. Restrições: maxComprimento: 10485760	Sim
caminho	cadeia (de caracteres)	Caminho do ficheiro para atualizar em relação à raiz do workspace. Restrições: minComprimento: 1	Sim
tipo	enumeração	O tipo de operação. Sempre `update_file`. Valores possíveis: `update_file`	Sim	update_file

OpenAI.ApproximateLocation

Name	Tipo	Description	Obrigatório	Predefinição
Cidade	string ou null		No
país	string ou null		No
região	string ou null		No
timezone	string ou null		No
tipo	enumeração	O tipo de aproximação de localização. Sempre `approximate`. Valores possíveis: `approximate`	Sim	aproximado

OpenAI.AutoCodeInterpreterToolParam

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

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

Name	Tipo	Description	Obrigatório	Predefinição
identificadores_de_arquivo	array de strings	Uma lista opcional de arquivos carregados para disponibilizar para o seu código. Restrições: máximo Itens: 50	No
limite_de_memória	OpenAI.ContainerMemoryLimit ou null		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Política de acesso à rede para o contentor.	No
tipo	enumeração	Sempre `auto`. Valores possíveis: `auto`	Sim	automóvel

FerramentaDeConcluãoDeChatDaOpenAI

Ferramenta funcional

Uma ferramenta funcional que pode ser usada para gerar uma resposta.

Name	Tipo	Description	Obrigatório	Predefinição
função	OpenAI.FunctionObject		Sim
tipo	enumeração	O tipo da ferramenta. Atualmente, apenas `function` é suportado. Valores possíveis: `function`	Sim

OpenAI.ClickButtonType

Property	Valor
Type	cadeia (de caracteres)
Valores	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

Click

Uma ação de clique.

Name	Tipo	Description	Obrigatório	Predefinição
botão	OpenAI.ClickButtonType		Sim
keys	array de string ou nulo		No
tipo	enumeração	Especifica o tipo de evento. Para uma ação de clique, esta propriedade é sempre `click`. Valores possíveis: `click`	Sim	clicar
x	número inteiro	A coordenada x onde ocorreu o clique.	Sim
y	número inteiro	A coordenada y onde ocorreu o clique.	Sim

OpenAI.CodeInterpreterOutputImage

Imagem de saída do interpretador de código

A saída de imagem do interpretador de código.

Name	Tipo	Description	Obrigatório	Predefinição
tipo	enumeração	O tipo de saída. Sempre `image`. Valores possíveis: `image`	Sim	imagem
url	string (uri)	O URL da imagem gerada pelo interpretador de código.	Sim

OpenAI.CodeInterpreterOutputLogs

Logs de saída do interpretador de código

A saída de logs do interpretador de código.

Name	Tipo	Description	Obrigatório	Predefinição
registos	cadeia (de caracteres)	A saída de logs do interpretador de código.	Sim
tipo	enumeração	O tipo de saída. Sempre `logs`. Valores possíveis: `logs`	Sim	registos

OpenAI.CodeInterpreterTool

Interpretador de código

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

Name	Tipo	Description	Obrigatório	Predefinição
contentor	string ou OpenAI.AutoCodeInterpreterToolParam	O contentor do interpretador de código. Pode ser um ID de contentor ou um objeto que especifica IDs de ficheiro carregados para disponibilizar ao seu código, juntamente com um Configuração opcional `memory_limit` .	Sim
tipo	enumeração	O tipo da ferramenta de interpretador de código. Sempre `code_interpreter`. Valores possíveis: `code_interpreter`	Sim

OpenAI.ComparisonFilter

Filtro de Comparação

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

Name	Tipo	Description	Obrigatório	Predefinição
chave	cadeia (de caracteres)	A chave pela qual se compara o valor.	Sim
tipo	enumeração	Especifica o operador de comparação: `eq`, `ne`, `gt`, `gtelt`, `lte`, , `in`, , . `nin` - `eq`: igual a - `ne`: não igual - `gt`: superior a - `gte`: maior ou igual - `lt`: menos de - `lte`: menor ou igual - `in`: em - `nin`: não em Valores possíveis: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`	Sim	eq
value	cadeia ou número ou booleano ou array de cadeia ou número	O valor a ser comparado com a chave de atributo; suporta tipos de string, número ou booleanos.	Sim

OpenAI.CompoundFilter

Filtro Composto

Combine vários filtros usando and ou or.

Name	Tipo	Description	Obrigatório	Predefinição
filters	array de OpenAI.ComparisonFilter ou objeto	Matriz de filtros para combinar. Os itens podem ser `ComparisonFilter` ou `CompoundFilter`.	Sim
tipo	enumeração	Tipo de operação: `and` ou `or`. Valores possíveis: `and`, `or`	Sim

OpenAI.ComputerAction

Discriminador para OpenAI.ComputerAction

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

Valor do tipo	Schema
`click`	OpenAI.ClickParam
`double_click`	OpenAI.DoubleClickAction
`drag`	OpenAI.DragParam
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.MoveParam
`screenshot`	OpenAI.ScreenshotParam
`scroll`	OpenAI.ScrollParam
`type`	OpenAI.TypeParam
`wait`	OpenAI.WaitParam

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.ComputerActionType		Sim

OpenAI.ComputerActionList

Lista de Ações Computacionais

Ações agrupadas achatadas para computer_use. Cada ação inclui um type discriminador e campos específicos de cada ação.

Variedade de: OpenAI.ComputerAction

OpenAI.ComputerActionType

Property	Valor
Type	cadeia (de caracteres)
Valores	`click` `double_click` `drag` `keypress` `move` `screenshot` `scroll` `type` `wait`

OpenAI.ComputerCallSafetyCheckParam

Uma verificação de segurança pendente para a chamada no computador.

Name	Tipo	Description	Obrigatório
código	string ou null		No
id	cadeia (de caracteres)	ID da verificação de segurança pendente.	Sim
mensagem	string ou null		No

OpenAI.ComputerEnvironment

Property	Valor
Type	cadeia (de caracteres)
Valores	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerScreenshotContent

Captura de ecrã do computador

Uma captura de ecrã de um computador.

Name	Tipo	Description	Obrigatório	Predefinição
detail	OpenAI.ImageDetail		Sim
identificação_de_ficheiro	string ou null		Sim
image_url	string ou null		Sim
tipo	enumeração	Especifica o tipo de evento. Para uma captura de tela do computador, essa propriedade é sempre definida como `computer_screenshot`. Valores possíveis: `computer_screenshot`	Sim	computer_screenshot

OpenAI.ComputerScreenshotImage

Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.

Name	Tipo	Description	Obrigatório	Predefinição
identificação_de_ficheiro	cadeia (de caracteres)	O identificador de um arquivo carregado que contém a captura de tela.	No
image_url	string (uri)	O URL da imagem da captura de tela.	No
tipo	enumeração	Especifica o tipo de evento. Para uma captura de ecrã do computador, esta propriedade é sempre definido como `computer_screenshot`. Valores possíveis: `computer_screenshot`	Sim	computer_screenshot

OpenAI.ComputerTool

Computador

Uma ferramenta que controla um computador virtual.

Name	Tipo	Description	Obrigatório	Predefinição
tipo	enumeração	O tipo de ferramenta informática. Sempre `computer`. Valores possíveis: `computer`	Sim	Computador

OpenAI.FerramentaDePréVisualizaçãoDeUsoDoComputador

Pré-visualização do uso do computador

Uma ferramenta que controla um computador virtual.

Name	Tipo	Description	Obrigatório	Predefinição
altura do ecrã	número inteiro	A altura do ecrã do computador.	Sim
largura de exibição	número inteiro	A largura do ecrã do computador.	Sim
ambiente	OpenAI.ComputerEnvironment		Sim
tipo	enumeração	O tipo de ferramenta de uso do computador. Sempre `computer_use_preview`. Valores possíveis: `computer_use_preview`	Sim	computer_use_preview

OpenAI.ContainerAutoParam

Name	Tipo	Description	Obrigatório	Predefinição
identificadores_de_arquivo	array de strings	Uma lista opcional de arquivos carregados para disponibilizar para o seu código. Restrições: máximo Itens: 50	No
limite_de_memória	OpenAI.ContainerMemoryLimit ou null		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Política de acesso à rede para o contentor.	No
competências	array de OpenAI.ContainerSkill	Uma lista opcional de competências referenciadas por ID ou dados inline. Restrições: máximoItens: 200	No
tipo	enumeração	Cria automaticamente um contentor para este pedido Valores possíveis: `container_auto`	Sim	container_auto

OpenAI.ContainerFileCitationBody

Citação do ficheiro contentor

Uma citação para um ficheiro contentor usado para gerar uma resposta de modelo.

Name	Tipo	Description	Obrigatório	Predefinição
container_id	cadeia (de caracteres)	O ID do ficheiro do contentor.	Sim
end_index	número inteiro	O índice do último carácter da citação do ficheiro contentor na mensagem.	Sim
identificação_de_ficheiro	cadeia (de caracteres)	A ID do arquivo.	Sim
filename	cadeia (de caracteres)	O nome do ficheiro do contentor citado.	Sim
start_index	número inteiro	O índice do primeiro carácter da citação do ficheiro contentor na mensagem.	Sim
tipo	enumeração	O tipo da citação do ficheiro contentor. Sempre `container_file_citation`. Valores possíveis: `container_file_citation`	Sim	container_file_citation

OpenAI.ContainerMemoryLimit

Property	Valor
Type	cadeia (de caracteres)
Valores	`1g` `4g` `16g` `64g`

OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Tipo	Description	Obrigatório	Predefinição
allowed_domains	array de strings	Uma lista de domínios permitidos quando o tipo é `allowlist`. Restrições: minItens: 1	Sim
tipo	enumeração	Permitir acesso à rede de saída apenas a domínios especificados. Sempre `allowlist`. Valores possíveis: `allowlist`	Sim	adicionar à lista de permissões

OpenAI.ContainerNetworkPolicyDisabledParam

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

OpenAI.ContainerNetworkPolicyParam

Política de acesso à rede para o contentor.

Discriminador para OpenAI.ContainerNetworkPolicyParam

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

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

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.ContainerNetworkPolicyParamType		Sim

OpenAI.ContainerNetworkPolicyParamType

Property	Valor
Type	cadeia (de caracteres)
Valores	`disabled` `allowlist`

OpenAI.ContainerSkill

Discriminador para OpenAI.ContainerSkill

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

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

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.ContainerSkillType		Sim

OpenAI.ContainerSkillType

Property	Valor
Type	cadeia (de caracteres)
Valores	`skill_reference` `inline`

OpenAI.CoordParam

Coordenadas

Um par de coordenadas x/y, por exemplo. { x: 100, y: 200 }

Name	Tipo	Description	Obrigatório	Predefinição
x	número inteiro	A coordenada x.	Sim
y	número inteiro	A coordenada y.	Sim

OpenAI.CreateChatCompletionRequestResponseFormat

Um objeto que especifica o formato que o modelo deve produzir. Definir para { "type": "json_schema", "json_schema": {...} } ativa ativa o Structured Outputs, que garante que o modelo corresponde ao esquema JSON fornecido. Saiba mais no guia de Resultados Estruturados. Configurar para { "type": "json_object" } ativa o modo JSON antigo, o que garante que a mensagem gerada pelo modelo seja JSON válido. O uso json_schema é preferível para modelos que o suportam.

Discriminador para OpenAI.CreateChatCompletionRequestResponseFormat

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

Valor do tipo	Schema
`json_schema`	OpenAI.ResponseFormatJsonSchema
`text`	OpenAI.CriarChatCompletionRequestResponseFormatResponseFormatText
`json_object`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.CreateChatCompletionRequestResponseFormatType		Sim

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Objeto JSON

Formato de resposta de objeto JSON. Um método mais antigo de gerar respostas JSON. O uso json_schema é recomendado para modelos que o suportam. Observe que o modelo não gerará JSON sem uma mensagem do sistema ou do usuário instruindo-o a fazê-lo.

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

OpenAI.CriarChatCompletionRequestResponseFormatResponseFormatText

Texto

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

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

OpenAI.CreateChatCompletionRequestResponseFormatType

Property	Valor
Type	cadeia (de caracteres)
Valores	`text` `json_schema` `json_object`

OpenAI.CreateEvalCompletionsRunDataSource

CompletionsRunDataSource

Um objeto CompletionsRunDataSource que descreve uma configuração de amostragem de modelo.

Name	Tipo	Description	Obrigatório	Predefinição
mensagens_de_entrada	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate ou OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	Usado ao amostrar a partir de um modelo. Dita a estrutura das mensagens passadas para o modelo. Pode ser uma referência a uma trajetória pré-construída (ou seja, `item.input_trajectory`), ou um template com referências variáveis ao `item` namespace.	No
modelo	cadeia (de caracteres)	O nome do modelo a ser usado para gerar completações (por exemplo, "o3-mini").	No
parâmetros_de_amostragem	AzureCompletionsSamplingParams	Parâmetros de amostragem para controlar o comportamento das completações.	No
origem	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource ou OpenAI.EvalStoredCompletionsSource	Determina o que preenche o `item` namespace na fonte de dados desta execução.	Sim
tipo	enumeração	O tipo de fonte de dados de execução. Sempre `completions`. Valores possíveis: `completions`	Sim	Finalizações

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

Name	Tipo	Description	Obrigatório	Predefinição
item_reference	cadeia (de caracteres)		Sim
tipo	enumeração	Valores possíveis: `item_reference`	Sim

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Name	Tipo	Description	Obrigatório	Predefinição
modelo	array de OpenAI.EasyInputMessage ou OpenAI.EvalItem		Sim
tipo	enumeração	Valores possíveis: `template`	Sim

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Name	Tipo	Description	Obrigatório	Predefinição
max_completion_tokens	número inteiro		No
esforço de raciocínio	OpenAI.ReasoningEffort	Restringe o esforço para raciocínio lógico. modelos de raciocínio. Os valores atualmente suportados são `none`, `minimal`, `low`, `medium`, `high`, e `xhigh`. Reduzindo O esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados sobre o raciocínio numa resposta. - `gpt-5.1` por defeito é `none`, que não executa raciocínio. Os valores de raciocínio suportados para `gpt-5.1` são `none`, `low`, `medium`, e `high`. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. - Todos os modelos anteriores `gpt-5.1` por defeito, para `medium` esforço de raciocínio, e não suportam `none`. - O `gpt-5-pro` modelo utiliza por defeito (e apenas suporta) `high` esforço de raciocínio. - `xhigh` é suportado para todos os modelos após `gpt-5.1-codex-max`.	No
formato_de_resposta	OpenAI.ResponseFormatText ou OpenAI.ResponseFormatJsonSchema ou OpenAI.ResponseFormatJsonObject		No
seed	número inteiro	Um valor seed inicializa a aleatoriedade durante a amostragem.	No	42
Temperatura	number	Uma temperatura mais alta aumenta a aleatoriedade nas saídas.	No	1
tools	array de OpenAI.ChatCompletionTool		No
top_p	number	Uma alternativa à temperatura para a amostragem do núcleo; 1.0 inclui todos os tokens.	No	1

OpenAI.CreateEvalCustomDataSourceConfig

CustomDataSourceConfig

Um objeto CustomDataSourceConfig que define o esquema para a fonte de dados usada para as execuções de avaliação. Este esquema é usado para definir a forma dos dados que serão:

Usado para definir seus critérios de teste e
Quais dados são necessários ao criar uma execução

Name	Tipo	Description	Obrigatório	Predefinição
incluir_schema_exemplo	boolean	Se o processo de avaliação deve esperar que você preencha o namespace de exemplo (ou seja, gerando respostas a partir da sua fonte de dados)	No
item_esquema	objecto	O esquema json para cada linha na fonte de dados.	Sim
tipo	enumeração	O tipo de fonte de dados. Sempre `custom`. Valores possíveis: `custom`	Sim	custom

OpenAI.CreateEvalItem

CreateEvalItem

Uma mensagem de bate-papo que compõe o prompt ou o contexto. Pode incluir referências variáveis ao item namespace, ou seja, {{item.name}}.

Este componente pode ser um dos seguintes:

Name	Tipo	Description	Obrigatório	Predefinição
conteúdo	cadeia (de caracteres)		Sim
função	cadeia (de caracteres)		Sim

OpenAI.EvalItem

OpenAI.CreateEvalJsonlRunDataSource

JsonlRunDataSource

Um objeto JsonlRunDataSource que especifica um ficheiro JSONL que corresponde à avaliação.

Name	Tipo	Description	Obrigatório	Predefinição
origem	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource	Determina o que preenche o `item` namespace na fonte de dados.	Sim
tipo	enumeração	O tipo de fonte de dados. Sempre `jsonl`. Valores possíveis: `jsonl`	Sim	jsonl

OpenAI.CreateEvalLabelModelGrader

LabelModelGrader

Um objeto LabelModelGrader que usa um modelo para atribuir rótulos a cada item na avaliação.

Name	Tipo	Description	Obrigatório
dados introduzidos	array de OpenAI.CreateEvalItem	Uma lista de mensagens de bate-papo que formam o prompt ou o contexto. Pode incluir referências variáveis ao `item` namespace, ou seja, {{item.name}}.	Sim
labels	array de strings	Os rótulos para classificar cada item na avaliação.	Sim
modelo	cadeia (de caracteres)	O modelo a utilizar para a avaliação. Deve suportar resultados estruturados.	Sim
Nome	cadeia (de caracteres)	O nome do classificador.	Sim
etiquetas_de_passagem	array de strings	Os rótulos que indicam um resultado positivo. Deve ser um subconjunto de rótulos.	Sim
tipo	enumeração	O tipo de objeto, que é sempre `label_model`. Valores possíveis: `label_model`	Sim

OpenAI.CreateEvalLogsDataSourceConfig

LogsDataSourceConfig

Uma configuração de fonte de dados que especifica a propriedade de metadados de sua consulta de logs. Geralmente são metadados como usecase=chatbot ou prompt-version=v2, etc.

Name	Tipo	Description	Obrigatório	Predefinição
metadados	objecto	Filtros de metadados para a fonte de dados de logs.	No
tipo	enumeração	O tipo de fonte de dados. Sempre `logs`. Valores possíveis: `logs`	Sim	registos

OpenAI.CreateEvalResponsesRunDataSource

RespostasRunDataSource

Um objeto ResponsesRunDataSource que descreve uma configuração de amostragem de modelo.

Name	Tipo	Description	Obrigatório	Predefinição
mensagens_de_entrada	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate ou OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReferência	Usado ao amostrar a partir de um modelo. Dita a estrutura das mensagens passadas para o modelo. Pode ser uma referência a uma trajetória pré-construída (ou seja, `item.input_trajectory`), ou um template com referências variáveis ao `item` namespace.	No
modelo	cadeia (de caracteres)	O nome do modelo a ser usado para gerar completações (por exemplo, "o3-mini").	No
parâmetros_de_amostragem	AzureResponsesSamplingParams	Parâmetros de amostragem para controlar o comportamento das respostas.	No
origem	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource ou OpenAI.EvalResponsesSource	Determina o que preenche o `item` namespace na fonte de dados desta execução.	Sim
tipo	enumeração	O tipo de fonte de dados de execução. Sempre `responses`. Valores possíveis: `responses`	Sim	Respostas

OpenAI.CreateEvalResponsesRunDataDataInputMessagesItemReference

Name	Tipo	Description	Obrigatório	Predefinição
item_reference	cadeia (de caracteres)		Sim
tipo	enumeração	Valores possíveis: `item_reference`	Sim

OpenAI.CreateEvalResponsesRunDataDataSourceInputMessagesTemplate

Name	Tipo	Description	Obrigatório	Predefinição
modelo	array of object ou OpenAI.EvalItem		Sim
tipo	enumeração	Valores possíveis: `template`	Sim

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Name	Tipo	Description	Obrigatório	Predefinição
esforço de raciocínio	OpenAI.ReasoningEffort	Restringe o esforço para raciocínio lógico. modelos de raciocínio. Os valores atualmente suportados são `none`, `minimal`, `low`, `medium`, `high`, e `xhigh`. Reduzindo O esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados sobre o raciocínio numa resposta. - `gpt-5.1` por defeito é `none`, que não executa raciocínio. Os valores de raciocínio suportados para `gpt-5.1` são `none`, `low`, `medium`, e `high`. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. - Todos os modelos anteriores `gpt-5.1` por defeito, para `medium` esforço de raciocínio, e não suportam `none`. - O `gpt-5-pro` modelo utiliza por defeito (e apenas suporta) `high` esforço de raciocínio. - `xhigh` é suportado para todos os modelos após `gpt-5.1-codex-max`.	No
seed	número inteiro	Um valor seed inicializa a aleatoriedade durante a amostragem.	No	42
Temperatura	number	Uma temperatura mais alta aumenta a aleatoriedade nas saídas.	No	1
enviar SMS	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		No
tools	array do OpenAI.Tool		No
top_p	number	Uma alternativa à temperatura para a amostragem do núcleo; 1.0 inclui todos os tokens.	No	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

Name	Tipo	Description	Obrigatório	Predefinição
format	OpenAI.TextResponseFormatConfiguration	Um objeto que especifica o formato que o modelo deve produzir. A configuração `{ "type": "json_schema" }` permite saídas estruturadas, o que garante que o modelo corresponderá ao esquema JSON fornecido. Saiba mais no O formato padrão é `{ "type": "text" }` sem opções adicionais. Não recomendado para gpt-4o e modelos mais recentes: Definir para `{ "type": "json_object" }` ativa o modo JSON mais antigo, que garante que a mensagem que o modelo gera é JSON válida. Ao utilizar `json_schema` é preferível para modelos que o suportem.	No

OpenAI.CreateEvalRunRequest

CreateEvalRunRequest

Name	Tipo	Description	Obrigatório
fonte_de_dados	OpenAI.CreateEvalJsonlRunDataSource ou OpenAI.CreateEvalCompletionsRunDataSource ou OpenAI.CreateEvalResponsesRunDataSource	Detalhes sobre a fonte de dados da corrida.	Sim
metadados	OpenAI.Metadata ou null		No
Nome	cadeia (de caracteres)	O nome da execução.	No

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

StoredCompletionsDataSourceConfig

Preterido em favor de LogsDataSourceConfig.

Name	Tipo	Description	Obrigatório	Predefinição
metadados	objecto	Filtros de metadados para a fonte de dados de conclusão armazenada.	No
tipo	enumeração	O tipo de fonte de dados. Sempre `stored_completions`. Valores possíveis: `stored_completions`	Sim	stored_completions

OpenAI.CustomGrammarFormatParam

Formato gramatical

Uma gramática definida pelo utilizador.

Name	Tipo	Description	Obrigatório	Predefinição
Definição	cadeia (de caracteres)	A definição gramatical.	Sim
Sintaxe	OpenAI.GrammarSyntax1		Sim
tipo	enumeração	Formato gramatical. Sempre `grammar`. Valores possíveis: `grammar`	Sim	Gramática

OpenAI.CustomTextFormatParam

Formato de texto

Texto livre e sem restrições.

Name	Tipo	Description	Obrigatório	Predefinição
tipo	enumeração	Formato de texto sem restrições. Sempre `text`. Valores possíveis: `text`	Sim	enviar SMS

OpenAI.CustomToolParam

Ferramenta personalizada

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

Name	Tipo	Description	Obrigatório	Predefinição
defer_loading	boolean	Se esta ferramenta deve ser adiada e descoberta através de pesquisa de ferramentas.	No
descrição	cadeia (de caracteres)	Descrição opcional da ferramenta personalizada, usada para fornecer mais contexto.	No
format	OpenAI.CustomToolParamFormat	O formato de entrada para a ferramenta personalizada. O padrão é texto sem restrições.	No
└─ tipo	OpenAI.CustomToolParamFormatType		Sim
Nome	cadeia (de caracteres)	O nome da ferramenta personalizada, usada para a identificar nas chamadas de ferramenta.	Sim
tipo	enumeração	O tipo da ferramenta personalizada. Sempre `custom`. Valores possíveis: `custom`	Sim	custom

OpenAI.CustomToolParamFormat

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

Discriminador para OpenAI.CustomToolParamFormat

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

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

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.CustomToolParamFormatType		Sim

OpenAI.CustomToolParamFormatType

Property	Valor
Type	cadeia (de caracteres)
Valores	`text` `grammar`

OpenAI.DetailEnum

Property	Valor
Type	cadeia (de caracteres)
Valores	`low` `high` `auto` `original`

OpenAI.DoubleClickAction

DoubleClick

Uma ação de clique duplo.

Name	Tipo	Description	Obrigatório	Predefinição
keys	array de string ou nulo		Sim
tipo	enumeração	Especifica o tipo de evento. Para uma ação de clique duplo, essa propriedade é sempre definida como `double_click`. Valores possíveis: `double_click`	Sim	double_click
x	número inteiro	A coordenada x onde ocorreu o duplo clique.	Sim
y	número inteiro	A coordenada y onde ocorreu o duplo clique.	Sim

OpenAI.DragParam

Drag

Uma ação de arrastar.

Name	Tipo	Description	Obrigatório	Predefinição
keys	array de string ou nulo		No
caminho	array do OpenAI.CoordParam	Uma matriz de coordenadas que representa o caminho da ação de arrastar. As coordenadas aparecerão como uma matriz de objetos, por exemplo `<br> [ { x: 100, y: 200 }, { x: 200, y: 300 } ]<br>`	Sim
tipo	enumeração	Especifica o tipo de evento. Para uma ação de arrastar, essa propriedade é sempre definida como `drag`. Valores possíveis: `drag`	Sim	arrastar

OpenAI.EasyInputMessage

Mensagem de entrada

Uma entrada de mensagem para o modelo com uma função que indica a adesão a uma hierarquia de instruções. As instruções dadas com a developer função ou system têm precedência sobre as instruções dadas com a user função. Presume-se que as mensagens com a assistant função tenham sido geradas pelo modelo em interações anteriores.

Name	Tipo	Description	Obrigatório
conteúdo	ou OpenAI.InputMessageContentList	Entrada de texto, imagem ou áudio no modelo, usada para gerar uma resposta. Também pode conter respostas anteriores do assistente.	Sim
fase	OpenAI.MessagePhase ou null		No
função	enumeração	A função da entrada de mensagem. Um dos `user`, `assistant`, `system`, ou `developer`. Valores possíveis: `user`, `assistant`, `system`, `developer`	Sim
estado	enumeração	O estado do item. Um dos `in_progress`, `completed`, ou `incomplete`. É preenchido quando os itens são retornados via API. Valores possíveis: `in_progress`, `completed`, `incomplete`	No
tipo	enumeração	O tipo de entrada de mensagem. Sempre `message`. Valores possíveis: `message`	Sim

OpenAI.EmptyModelParam

Tipo: objeto

OpenAI.Eval

Eval

Um objeto Eval com uma configuração de fonte de dados e critérios de teste. Um Eval representa uma tarefa para realizar na integração do seu LLM. Como:

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

Name	Tipo	Description	Obrigatório	Predefinição
criado_em	inteiro (unixtime)	O carimbo de data/hora Unix (em segundos) referente à criação da avaliação.	Sim
configuração_fonte_dados	OpenAI.EvalCustomDataSourceConfig ou OpenAI.EvalLogsDataSourceConfig ou OpenAI.EvalStoredCompletionsDataSourceConfig	Configuração das fontes de dados utilizadas nas execuções da avaliação.	Sim
id	cadeia (de caracteres)	Identificador único para a avaliação.	Sim
metadados	OpenAI.Metadata ou null		Sim
Nome	cadeia (de caracteres)	O nome da avaliação.	Sim
objecto	enumeração	O tipo de objeto. Valores possíveis: `eval`	Sim	avaliação
critérios_teste	array of OpenAI.CreateEvalLabelModelGrader ou OpenAI.EvalGraderStringCheck ou OpenAI.EvalGraderTextSimilarity ou OpenAI.EvalGraderPython ou OpenAI.EvalGraderScoreModel ou EvalGraderEndpoint	Uma lista de critérios de teste.	Sim

OpenAI.EvalApiError

EvalApiError

Um objeto que representa uma resposta de erro da API Eval.

Name	Tipo	Description	Obrigatório	Predefinição
código	cadeia (de caracteres)	O código de erro.	Sim
mensagem	cadeia (de caracteres)	A mensagem de erro.	Sim

OpenAI.EvalCustomDataSourceConfig

CustomDataSourceConfig

Um CustomDataSourceConfig que especifica o esquema do seu item e, opcionalmente, dos seus sample namespaces. O esquema de resposta define 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

Name	Tipo	Description	Obrigatório	Predefinição
esquema	objecto	O esquema JSON para os itens da fonte de dados de execução. Saiba como criar esquemas JSON aqui.	Sim
tipo	enumeração	O tipo de fonte de dados. Sempre `custom`. Valores possíveis: `custom`	Sim	custom

OpenAI.EvalGraderPython

PythonGrader

Name	Tipo	Description	Obrigatório
etiqueta_imagem	cadeia (de caracteres)	A tag de imagem a ser usada para o script python.	No
Nome	cadeia (de caracteres)	O nome do classificador.	Sim
limite_de_passagem	number	O limiar para a pontuação.	No
origem	cadeia (de caracteres)	O código-fonte do script python.	Sim
tipo	enumeração	O tipo de objeto, que é sempre `python`. Valores possíveis: `python`	Sim

OpenAI.EvalGraderScoreModel

ScoreModelGrader

Name	Tipo	Description	Obrigatório	Predefinição
dados introduzidos	array de OpenAI.EvalItem	As mensagens de entrada avaliadas pelo avaliador. Suporta blocos de texto, texto de saída, imagem de entrada e conteúdo áudio de entrada, podendo incluir cadeias de templates.	Sim
modelo	cadeia (de caracteres)	O modelo a utilizar para a avaliação.	Sim
Nome	cadeia (de caracteres)	O nome do classificador.	Sim
limite_de_passagem	number	O limiar para a pontuação.	No
intervalo	array de números	O intervalo da pontuação. O valor padrão é `[0, 1]`.	No
parâmetros_de_amostragem	OpenAI.EvalGraderScoreModelSamplingParams		No
└─ max_completions_tokens	inteiro ou nulo		No
└─ esforço_de_raciocínio	OpenAI.ReasoningEffort	Restringe o esforço para raciocínio lógico. modelos de raciocínio. Os valores atualmente suportados são `none`, `minimal`, `low`, `medium`, `high`, e `xhigh`. Reduzindo O esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados sobre o raciocínio numa resposta. - `gpt-5.1` por defeito é `none`, que não executa raciocínio. Os valores de raciocínio suportados para `gpt-5.1` são `none`, `low`, `medium`, e `high`. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. - Todos os modelos anteriores `gpt-5.1` por defeito, para `medium` esforço de raciocínio, e não suportam `none`. - O `gpt-5-pro` modelo utiliza por defeito (e apenas suporta) `high` esforço de raciocínio. - `xhigh` é suportado para todos os modelos após `gpt-5.1-codex-max`.	No
└─ sementes	inteiro ou nulo		No
└─ temperatura	Número ou nulo		No
└─ top_p	Número ou nulo		No	1
tipo	enumeração	O tipo de objeto, que é sempre `score_model`. Valores possíveis: `score_model`	Sim

OpenAI.EvalGraderScoreModelSamplingParams

Name	Tipo	Description	Obrigatório
max_completions_tokens	inteiro ou nulo		No
esforço de raciocínio	OpenAI.ReasoningEffort	Restringe o esforço para raciocínio lógico. modelos de raciocínio. Os valores atualmente suportados são `none`, `minimal`, `low`, `medium`, `high`, e `xhigh`. Reduzindo O esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados sobre o raciocínio numa resposta. - `gpt-5.1` por defeito é `none`, que não executa raciocínio. Os valores de raciocínio suportados para `gpt-5.1` são `none`, `low`, `medium`, e `high`. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. - Todos os modelos anteriores `gpt-5.1` por defeito, para `medium` esforço de raciocínio, e não suportam `none`. - O `gpt-5-pro` modelo utiliza por defeito (e apenas suporta) `high` esforço de raciocínio. - `xhigh` é suportado para todos os modelos após `gpt-5.1-codex-max`.	No
seed	inteiro ou nulo		No
Temperatura	Número ou nulo		No
top_p	Número ou nulo		No

OpenAI.EvalGraderStringCheck

StringCheckGrader

Name	Tipo	Description	Obrigatório
dados introduzidos	cadeia (de caracteres)	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Sim
Nome	cadeia (de caracteres)	O nome do classificador.	Sim
operação	enumeração	A operação de verificação de cadeia de caracteres a ser executada. Um de `eq`, `ne`, `like`, ou `ilike`. Valores possíveis: `eq`, `ne`, `like`, `ilike`	Sim
referenciar	cadeia (de caracteres)	O texto de referência. Isso pode incluir cadeias de caracteres de modelo.	Sim
tipo	enumeração	O tipo de objeto, que é sempre `string_check`. Valores possíveis: `string_check`	Sim

OpenAI.EvalGraderTextSimilarity

TextSimilarityGrader

Name	Tipo	Description	Obrigatório	Predefinição
métrica de avaliação	enumeração	A métrica de avaliação a ser usada. Um dos `cosine`, `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5` ou `rouge_l`. Valores possíveis: `cosine`, `fuzzy_match`, `bleu`, `gleumeteor`, `rouge_1rouge_2`, `rouge_3`, `rouge_4rouge_5rouge_l`	Sim
dados introduzidos	cadeia (de caracteres)	O texto que está a ser classificado.	Sim
Nome	cadeia (de caracteres)	O nome do classificador.	Sim
limite_de_passagem	number	O limiar para a pontuação.	Sim
referenciar	cadeia (de caracteres)	O texto que está a ser avaliado.	Sim
tipo	enumeração	O tipo de motoniveladora. Valores possíveis: `text_similarity`	Sim	text_similarity

OpenAI.EvalItem

Objeto de mensagem de avaliação

Name	Tipo	Description	Obrigatório
conteúdo	OpenAI.EvalItemContent	Entradas para o modelo - podem conter cadeias de templates. Suporta texto, texto de saída, imagens de entrada e áudio de entrada, seja como um único item ou como um array de itens.	Sim
função	enumeração	A função da entrada de mensagem. Um dos `user`, `assistant`, `system`, ou `developer`. Valores possíveis: `user`, `assistant`, `system`, `developer`	Sim
tipo	enumeração	O tipo de entrada de mensagem. Sempre `message`. Valores possíveis: `message`	No

OpenAI.EvalItemContent

Conteúdo de avaliação

Entradas para o modelo - podem conter cadeias de templates. Suporta texto, texto de saída, imagens de entrada e áudio de entrada, seja como um único item ou como um array de itens.

Este componente pode ser um dos seguintes:

OpenAI.EvalItemContentItem
OpenAI.EvalItemContentArray

OpenAI.EvalItemContentArray

Um conjunto de texto de entrada, texto de saída, imagem de entrada e áudio de entrada

Uma lista de entradas, cada uma das quais pode ser um texto de entrada, texto de saída, imagem de entrada ou objeto de áudio de entrada.

Array de: OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

Item de avaliação de conteúdo

Um único elemento de conteúdo: texto de entrada, texto de saída, imagem de entrada ou áudio de entrada.

Este componente pode ser um dos seguintes:

OpenAI.EvalItemContentText
OpenAI.EvalItemContentItemObject

OpenAI.EvalItemContentItemObject

Item de avaliação de conteúdo

Um único elemento de conteúdo: texto de entrada, texto de saída, imagem de entrada ou áudio de entrada.

Discriminador para OpenAI.EvalItemContentItemObject

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

Valor do tipo	Schema
`output_text`	OpenAI.EvalItemContentOutputText
`input_image`	OpenAI.EvalItemInputImage
`input_audio`	OpenAI.InputAudio
`input_text`	OpenAI.EvalItemContentItemObjectInputTextContent

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.EvalItemContentItemObjectType		Sim

OpenAI.EvalItemContentItemObjectInputTextContent

Texto de entrada

Uma entrada de texto para o modelo.

Name	Tipo	Description	Obrigatório	Predefinição
enviar SMS	cadeia (de caracteres)	A entrada de texto para o modelo.	Sim
tipo	enumeração	O tipo do item de entrada. Sempre `input_text`. Valores possíveis: `input_text`	Sim	input_text

OpenAI.EvalItemContentItemObjectType

Property	Valor
Type	cadeia (de caracteres)
Valores	`input_text` `output_text` `input_image` `input_audio`

OpenAI.EvalItemContentOutputText

Texto de saída

Uma saída de texto do modelo.

Name	Tipo	Description	Obrigatório	Predefinição
enviar SMS	cadeia (de caracteres)	A saída de texto do modelo.	Sim
tipo	enumeração	O tipo do texto de saída. Sempre `output_text`. Valores possíveis: `output_text`	Sim

OpenAI.EvalItemContentText

Entrada de texto

Uma entrada de texto para o modelo.

Tipo: string

OpenAI.EvalItemInputImage

Imagem de entrada

Um bloco de entrada de imagem usado dentro dos arrays de conteúdo do EvalItem.

Name	Tipo	Description	Obrigatório
detail	cadeia (de caracteres)	O nível de detalhe da imagem a ser enviada para o modelo. Um de `high`, `low`, ou `auto`. O valor padrão é `auto`.	No
image_url	string (uri)	A URL da imagem introduzida.	Sim
tipo	enumeração	O tipo de entrada da imagem. Sempre `input_image`. Valores possíveis: `input_image`	Sim

OpenAI.EvalJsonlFileContentSource

EvalJsonlFileContentSource

Name	Tipo	Description	Obrigatório	Predefinição
conteúdo	array of OpenAI.EvalJsonlFileContentSourceContent	O conteúdo do arquivo jsonl.	Sim
tipo	enumeração	O tipo de fonte jsonl. Sempre `file_content`. Valores possíveis: `file_content`	Sim	file_content

OpenAI.EvalJsonlFileContentSourceContent

Name	Tipo	Description	Obrigatório	Predefinição
item	objecto		Sim
amostra	objecto		No

OpenAI.EvalJsonlFileIdSource

EvalJsonlFileIdSource

Name	Tipo	Description	Obrigatório	Predefinição
id	cadeia (de caracteres)	O identificador do arquivo.	Sim
tipo	enumeração	O tipo de fonte jsonl. Sempre `file_id`. Valores possíveis: `file_id`	Sim	identificação_de_ficheiro

OpenAI.EvalList

EvalList

Um objeto que representa uma lista de avaliações.

Name	Tipo	Description	Obrigatório	Predefinição
dados	array de OpenAI.Eval	Uma matriz de objetos eval.	Sim
first_id	cadeia (de caracteres)	O identificador da primeira avaliação na matriz de dados.	Sim
tem_mais	boolean	Indica se há mais avaliações disponíveis.	Sim
last_id	cadeia (de caracteres)	O identificador da última avaliação no array de dados.	Sim
objecto	enumeração	O tipo deste objeto. É sempre definido como "lista". Valores possíveis: `list`	Sim	list

OpenAI.EvalLogsDataSourceConfig

LogsDataSourceConfig

Um LogsDataSourceConfig que define a propriedade de metadados da consulta de logs. Geralmente são metadados como usecase=chatbot ou prompt-version=v2, etc. O esquema retornado por essa configuração de fonte de dados é usado para definir quais variáveis estão disponíveis em seus evals. item e sample ambos são definidos ao usar essa configuração de fonte de dados.

Name	Tipo	Description	Obrigatório	Predefinição
metadados	OpenAI.Metadata ou null		No
esquema	objecto	O esquema JSON para os itens da fonte de dados de execução. Saiba como criar esquemas JSON aqui.	Sim
tipo	enumeração	O tipo de fonte de dados. Sempre `logs`. Valores possíveis: `logs`	Sim	registos

OpenAI.EvalResponsesSource

EvalResponsesSource

Um objeto EvalResponsesSource que descreve uma configuração de fonte de dados de execução.

Name	Tipo	Description	Obrigatório
criado_depois	inteiro ou nulo		No
criado_antes	inteiro ou nulo		No
instructions_search	string ou null		No
metadados	objeto ou nulo		No
modelo	string ou null		No
esforço de raciocínio	OpenAI.ReasoningEffort ou null		No
Temperatura	Número ou nulo		No
tools	array de string ou nulo		No
top_p	Número ou nulo		No
tipo	enumeração	O tipo de fonte de dados de execução. Sempre `responses`. Valores possíveis: `responses`	Sim
users	array de string ou nulo		No

OpenAI.EvalRun

EvalRun

Um esquema que representa uma execução de avaliação.

Name	Tipo	Description	Obrigatório	Predefinição
criado_em	inteiro (unixtime)	Carimbo de data/hora Unix (em segundos) quando o processo de avaliação foi criado.	Sim
fonte_de_dados	OpenAI.CreateEvalJsonlRunDataSource ou OpenAI.CreateEvalCompletionsRunDataSource ou OpenAI.CreateEvalResponsesRunDataSource	Informação sobre a fonte de dados da corrida.	Sim
erro	OpenAI.EvalApiError	Um objeto que representa uma resposta de erro da API Eval.	Sim
eval_id	cadeia (de caracteres)	O identificador da avaliação associada.	Sim
id	cadeia (de caracteres)	Identificador exclusivo para a execução da avaliação.	Sim
metadados	OpenAI.Metadata ou null		Sim
modelo	cadeia (de caracteres)	O modelo avaliado, se aplicável.	Sim
Nome	cadeia (de caracteres)	O nome da sessão de avaliação.	Sim
objecto	enumeração	O tipo do objeto. Sempre «eval.run». Valores possíveis: `eval.run`	Sim	eval.run
uso_por_modelo	array of OpenAI.EvalRunPerModelUsage	Estatísticas de uso para cada modelo durante a execução da avaliação.	Sim
por_resultados_dos_criterios_de_teste	array de OpenAI.EvalRunPerTestingCriteriaResults	Resultados por critério de teste aplicado durante a execução da avaliação.	Sim
report_url	string (uri)	A URL para o relatório da execução da avaliação gerada no painel de controlo da interface do utilizador.	Sim
contagem_resultados	OpenAI.EvalRunResultCounts		Sim
└─ Erro	número inteiro		Sim
└─ não conseguiu	número inteiro		Sim
└─ aprovado	número inteiro		Sim
└─ total	número inteiro		Sim
estado	cadeia (de caracteres)	O estado da execução da avaliação.	Sim

OpenAI.EvalRunList

EvalRunList

Um objeto que representa uma lista de execuções para uma avaliação.

Name	Tipo	Description	Obrigatório	Predefinição
dados	array do OpenAI.EvalRun	Uma matriz de objetos de avaliação.	Sim
first_id	cadeia (de caracteres)	O identificador da primeira execução de avaliação na matriz de dados.	Sim
tem_mais	boolean	Indica se há mais avaliações disponíveis.	Sim
last_id	cadeia (de caracteres)	O identificador da última execução eval na matriz de dados.	Sim
objecto	enumeração	O tipo deste objeto. É sempre definido como "lista". Valores possíveis: `list`	Sim	list

OpenAI.EvalRunOutputItem

EvalRunOutputItem

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

Name	Tipo	Description	Obrigatório	Predefinição
criado_em	inteiro (unixtime)	Carimbo de data/hora Unix (em segundos) quando o processo de avaliação foi criado.	Sim
item_de_fonte_de_dados	objecto	Detalhes do item da fonte de dados de entrada.	Sim
id_item_fonte_de_dados	número inteiro	O identificador do item da fonte de dados.	Sim
eval_id	cadeia (de caracteres)	O identificador do grupo de avaliação.	Sim
id	cadeia (de caracteres)	Identificador único para o item de saída do processo de avaliação.	Sim
objecto	enumeração	O tipo do objeto. Sempre "eval.run.output_item". Valores possíveis: `eval.run.output_item`	Sim	eval.run.output_item
results	array de OpenAI.EvalRunOutputItemResult	Uma lista dos resultados do avaliador para este item de saída.	Sim
run_id	cadeia (de caracteres)	O identificador da execução de avaliação associada a este item de saída.	Sim
amostra	OpenAI.EvalRunOutputItemSample		Sim
└─ erro	OpenAI.EvalApiError	Um objeto que representa uma resposta de erro da API Eval.	Sim
└─ motivo de término	cadeia (de caracteres)		Sim
└─ entrada	array de OpenAI.EvalRunOutputItemSampleInput		Sim
└─ max_completion_tokens	número inteiro		Sim
└─ modelo	cadeia (de caracteres)		Sim
└─ saída	array de OpenAI.EvalRunOutputItemSampleOutput		Sim
└─ sementes	número inteiro		Sim
└─ temperatura	number		Sim
└─ top_p	number		Sim
└─ utilização	OpenAI.EvalRunOutputItemSampleUsage		Sim
estado	cadeia (de caracteres)	O estado da execução da avaliação.	Sim

OpenAI.EvalRunOutputItemList

EvalRunOutputItemList

Um objeto que representa uma lista de itens de saída para uma execução de avaliação.

Name	Tipo	Description	Obrigatório	Predefinição
dados	array de OpenAI.EvalRunOutputItem	Um conjunto de objetos de itens de saída do eval.	Sim
first_id	cadeia (de caracteres)	O identificador do primeiro item de saída da execução de avaliação na matriz de dados.	Sim
tem_mais	boolean	Indica se existem mais itens de saída disponíveis da execução de avaliação.	Sim
last_id	cadeia (de caracteres)	O identificador do último item de saída da execução de avaliação na matriz de dados.	Sim
objecto	enumeração	O tipo deste objeto. É sempre definido como "lista". Valores possíveis: `list`	Sim	list

OpenAI.EvalRunOutputItemResult

EvalRunOutputItemResult

Um resultado de um único avaliador para um item de execução de avaliação.

Name	Tipo	Description	Obrigatório
Nome	cadeia (de caracteres)	O nome do classificador.	Sim
Aprovado	boolean	Se o avaliador considerou a saída uma passagem.	Sim
amostra	objeto ou nulo	Dados de amostra ou intermédios opcionais produzidos pelo avaliador.	No
classificação	number	A pontuação numérica produzida pelo avaliador.	Sim
tipo	cadeia (de caracteres)	O tipo de avaliador (por exemplo, "string-check-grader").	No

OpenAI.EvalRunOutputItemSample

Name	Tipo	Description	Obrigatório
erro	OpenAI.EvalApiError	Um objeto que representa uma resposta de erro da API Eval.	Sim
motivo_de_finalização	cadeia (de caracteres)		Sim
dados introduzidos	array de OpenAI.EvalRunOutputItemSampleInput		Sim
max_completion_tokens	número inteiro		Sim
modelo	cadeia (de caracteres)		Sim
saída	array de OpenAI.EvalRunOutputItemSampleOutput		Sim
seed	número inteiro		Sim
Temperatura	number		Sim
top_p	number		Sim
utilização	OpenAI.EvalRunOutputItemSampleUsage		Sim

OpenAI.EvalRunOutputItemSampleInput

Name	Tipo	Description	Obrigatório	Predefinição
conteúdo	cadeia (de caracteres)		Sim
função	cadeia (de caracteres)		Sim

OpenAI.EvalRunOutputItemSampleOutput

Name	Tipo	Description	Obrigatório	Predefinição
conteúdo	cadeia (de caracteres)		No
função	cadeia (de caracteres)		No

OpenAI.EvalRunOutputItemSampleUsage

Name	Tipo	Obrigatório
cached_tokens	número inteiro	Sim
completion_tokens	número inteiro	Sim
prompt_tokens	número inteiro	Sim
total_tokens	número inteiro	Sim

OpenAI.EvalRunPerModelUsage

Name	Tipo	Obrigatório
cached_tokens	número inteiro	Sim
completion_tokens	número inteiro	Sim
invocation_count	número inteiro	Sim
model_name	cadeia (de caracteres)	Sim
prompt_tokens	número inteiro	Sim
total_tokens	número inteiro	Sim

OpenAI.EvalRunPerTestingCriteriaResults

Name	Tipo	Obrigatório
com falhas	número inteiro	Sim
Aprovado	número inteiro	Sim
critérios_teste	cadeia (de caracteres)	Sim

OpenAI.EvalRunResultCounts

Name	Tipo	Obrigatório
erro	número inteiro	Sim
com falhas	número inteiro	Sim
Aprovado	número inteiro	Sim
total	número inteiro	Sim

OpenAI.EvalStoredCompletionsDataSourceConfig

StoredCompletionsDataSourceConfig

Preterido em favor de LogsDataSourceConfig.

Name	Tipo	Description	Obrigatório	Predefinição
metadados	OpenAI.Metadata ou null		No
esquema	objecto	O esquema JSON para os itens da fonte de dados de execução. Saiba como criar esquemas JSON aqui.	Sim
tipo	enumeração	O tipo de fonte de dados. Sempre `stored_completions`. Valores possíveis: `stored_completions`	Sim	stored_completions

OpenAI.EvalStoredCompletionsSource

StoredCompletionsRunDataSource

Uma configuração StoredCompletionsRunDataSource descrevendo um conjunto de filtros

Name	Tipo	Description	Obrigatório	Predefinição
criado_depois	inteiro ou nulo		No
criado_antes	inteiro ou nulo		No
limit	inteiro ou nulo		No
metadados	OpenAI.Metadata ou null		No
modelo	string ou null		No
tipo	enumeração	O tipo de fonte. Sempre `stored_completions`. Valores possíveis: `stored_completions`	Sim	stored_completions

OpenAI.FileCitationBody

Citação do ficheiro

Uma citação a um ficheiro.

Name	Tipo	Description	Obrigatório	Predefinição
identificação_de_ficheiro	cadeia (de caracteres)	A ID do arquivo.	Sim
filename	cadeia (de caracteres)	O nome do arquivo citado.	Sim
indexar	número inteiro	O índice do arquivo na lista de arquivos.	Sim
tipo	enumeração	O tipo de citação do arquivo. Sempre `file_citation`. Valores possíveis: `file_citation`	Sim	file_citation

OpenAI.FileInputDetail

Property	Valor
Type	cadeia (de caracteres)
Valores	`low` `high`

OpenAI.FilePath

Caminho do ficheiro

Um caminho para um arquivo.

Name	Tipo	Description	Obrigatório
identificação_de_ficheiro	cadeia (de caracteres)	A ID do arquivo.	Sim
indexar	número inteiro	O índice do arquivo na lista de arquivos.	Sim
tipo	enumeração	O tipo do caminho do arquivo. Sempre `file_path`. Valores possíveis: `file_path`	Sim

OpenAI.FileSearchTool

Pesquisa de ficheiros

Uma ferramenta que procura conteúdo relevante a partir de ficheiros carregados.

Name	Tipo	Description	Obrigatório	Predefinição
filters	OpenAI.Filters ou null		No
máximo_número_de_resultados	número inteiro	O número máximo de resultados a serem retornados. Este número deve situar-se entre 1 e 50, inclusive.	No
opções_de_classificação	OpenAI.RankingOptions		No
└─ hybrid_search	OpenAI.HybridSearchOptions	Pesos que controlam como a fusão de rank recíproca equilibra correspondências semânticas de embedding versus correspondências esparsas de palavras-chave quando a pesquisa híbrida está ativada.	No
└─ classificador	OpenAI.RankerVersionType	O classificador a ser usado para a pesquisa de arquivos.	No
└─ limiar_de_pontuação	number	O limite de pontuação para a pesquisa de ficheiros, um número entre 0 e 1. Números mais próximos de 1 tentarão retornar apenas os resultados mais relevantes, mas podem retornar menos resultados.	No
tipo	enumeração	O tipo da ferramenta de pesquisa de ficheiros. Sempre `file_search`. Valores possíveis: `file_search`	Sim	file_search
identificadores_de_armazém_de_vectores	array de strings	Os IDs do vetor armazena para pesquisar.	Sim

OpenAI.FileSearchToolCallResults

Name	Tipo	Obrigatório
attributes	OpenAI.VectorStoreFileAttributes ou null	No
identificação_de_ficheiro	cadeia (de caracteres)	No
filename	cadeia (de caracteres)	No
classificação	número (float)	No
enviar SMS	cadeia (de caracteres)	No

OpenAI.Filtros

Tipo: OpenAI.ComparisonFilter ou OpenAI.CompoundFilter

OpenAI.FunctionAndCustomToolCallOutput

Discriminador para OpenAI.FunctionandCustomToolCallOutput

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

Valor do tipo	Schema
`input_text`	OpenAI.FunçãoeFerramenta PersonalizadaChamadaSaídaTextoConteúdo
`input_image`	OpenAI.FunçãoeFerramenta PersonalizadaChamadaSaídaImageConteúdo
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.FunctionAndCustomToolCallOutputType		Sim

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Ficheiro de entrada

Uma entrada de arquivo para o modelo.

Name	Tipo	Description	Obrigatório	Predefinição
detail	OpenAI.FileInputDetail		No
file_data	cadeia (de caracteres)	O conteúdo do arquivo a ser enviado para o modelo.	No
identificação_de_ficheiro	string ou null		No
file_url	string (uri)	O URL do ficheiro a ser enviado para o modelo.	No
filename	cadeia (de caracteres)	O nome do arquivo a ser enviado para o modelo.	No
tipo	enumeração	O tipo do item de entrada. Sempre `input_file`. Valores possíveis: `input_file`	Sim	input_file

OpenAI.FunçãoeFerramenta PersonalizadaChamadaSaídaImageConteúdo

Imagem de entrada

Uma entrada de imagem para o modelo.

Name	Tipo	Description	Obrigatório	Predefinição
detail	OpenAI.ImageDetail		Sim
identificação_de_ficheiro	string ou null		No
image_url	string ou null		No
tipo	enumeração	O tipo do item de entrada. Sempre `input_image`. Valores possíveis: `input_image`	Sim	input_image

OpenAI.FunçãoeFerramenta PersonalizadaChamadaSaídaTextoConteúdo

Texto de entrada

Uma entrada de texto para o modelo.

Name	Tipo	Description	Obrigatório	Predefinição
enviar SMS	cadeia (de caracteres)	A entrada de texto para o modelo.	Sim
tipo	enumeração	O tipo do item de entrada. Sempre `input_text`. Valores possíveis: `input_text`	Sim	input_text

OpenAI.FunctionAndCustomToolCallOutputType

Property	Valor
Type	cadeia (de caracteres)
Valores	`input_text` `input_image` `input_file`

OpenAI.FunctionCallItemStatus

Property	Valor
Type	cadeia (de caracteres)
Valores	`in_progress` `completed` `incomplete`

OpenAI.FunctionObject

Name	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função.	No
Nome	cadeia (de caracteres)	O nome da função a ser chamada. Deve ser a-z, A-Z, 0-9, ou conter sublinhados e traços, com um comprimento máximo de 64.	Sim
parameters	OpenAI.FunctionParameters	Os parâmetros que as funções aceitam, descritos como um objeto de esquema JSON. Consulte a referência do Esquema JSON para documentação sobre o formato. Omitir `parameters` define uma função com uma lista de parâmetros vazia.	No
rigoroso	Booleano ou nulo		No

OpenAI.FunctionParameters

Os parâmetros que as funções aceitam, descritos como um objeto de esquema JSON. Consulte a referência do Esquema JSON para documentação sobre o formato. Omitir parameters define uma função com uma lista de parâmetros vazia.

Tipo: objeto

OpenAI.FunctionShellActionParam

Ação de projéteis

Comandos e limites que descrevem como executar a chamada à ferramenta shell.

Name	Tipo	Description	Obrigatório
comandos	array de strings	Ordenei comandos shell para o ambiente de execução ser executado.	Sim
max_output_length	inteiro ou nulo		No
timeout_ms (tempo limite em milissegundos)	inteiro ou nulo		No

OpenAI.FunctionShellCallItemParamEnvironment

O ambiente para executar os comandos shell.

Discriminador para OpenAI.FunctionShellCallItemParamEnvironment

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

Valor do tipo	Schema
`local`	OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.FunctionShellCallItemParamEnvironmentType		Sim

OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

Name	Tipo	Description	Obrigatório	Predefinição
container_id	cadeia (de caracteres)	O ID do contentor referido.	Sim
tipo	enumeração	Faz referência a um contentor criado com o endpoint /v1/containers Valores possíveis: `container_reference`	Sim	container_reference

OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam

Name	Tipo	Description	Obrigatório	Predefinição
competências	array de OpenAI.LocalSkillParam	Uma lista opcional de competências. Restrições: máximoItens: 200	No
tipo	enumeração	Usa um ambiente informático local. Valores possíveis: `local`	Sim	local

OpenAI.FunctionShellCallItemParamEnvironmentType

Property	Valor
Type	cadeia (de caracteres)
Valores	`local` `container_reference`

OpenAI.FunctionShellCallItemStatus

Estado da chamada shell

Valores de estado reportados para chamadas de ferramentas shell.

Property	Valor
Type	cadeia (de caracteres)
Valores	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputContentParam

Conteúdo de saída do shell

Capturei stdout e stderr para uma parte da saída de uma chamada de ferramenta shell.

Name	Tipo	Description	Obrigatório
Resultado	OpenAI.FunctionShellCallOutputOutcomeParam	O resultado de saída ou tempo de espera associado a esta chamada shell.	Sim
└─ tipo	OpenAI.FunctionShellCallOutputOutcomeParamType		Sim
Stderr	cadeia (de caracteres)	Capturei a saída do stderr para a chamada shell. Restrições: maxComprimento: 10485760	Sim
stdout	cadeia (de caracteres)	Capturei a saída do stdout para a chamada de shell. Restrições: maxComprimento: 10485760	Sim

OpenAI.FunctionShellCallOutputExitOutcomeParam

Resultado de saída de chamadas shell

Indica que os comandos shell terminaram e devolveram um código de saída.

Name	Tipo	Description	Obrigatório	Predefinição
exit_code	número inteiro	O código de saída devolvido pelo processo shell.	Sim
tipo	enumeração	O tipo de resultado. Sempre `exit`. Valores possíveis: `exit`	Sim	sair

OpenAI.FunctionShellCallOutputOutcomeParam

Resultado da chamada shell

O resultado de saída ou tempo de espera associado a esta chamada shell.

Discriminador para OpenAI.FunctionShellCallOutputOutcomeParam

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

Valor do tipo	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutcomeParaparam
`exit`	OpenAI.FunctionShellCallOutputExitOutcomeParam

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.FunctionShellCallOutputOutcomeParamType		Sim

OpenAI.FunctionShellCallOutputOutcomeParamType

Property	Valor
Type	cadeia (de caracteres)
Valores	`timeout` `exit`

OpenAI.FunctionShellCallOutputTimeoutcomeParaparam

Resultado do timeout da chamada shell

Indica que a chamada shell excedeu o limite de tempo configurado.

Name	Tipo	Description	Obrigatório	Predefinição
tipo	enumeração	O tipo de resultado. Sempre `timeout`. Valores possíveis: `timeout`	Sim	timeout

OpenAI.FunctionShellToolParam

Ferramenta de concha

Uma ferramenta que permite ao modelo executar comandos de shell.

Name	Tipo	Description	Obrigatório	Predefinição
ambiente	OpenAI.FunctionShellToolParamEnvironment ou null		No
tipo	enumeração	O tipo da ferramenta de carapaça. Sempre `shell`. Valores possíveis: `shell`	Sim	shell

OpenAI.FunctionShellToolParamEnvironment

Discriminador para OpenAI.FunctionShellToolParamEnvironment

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

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

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.FunctionShellToolParamEnvironmentType		Sim

OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam

Name	Tipo	Description	Obrigatório	Predefinição
container_id	cadeia (de caracteres)	O ID do contentor referido.	Sim
tipo	enumeração	Faz referência a um contentor criado com o endpoint /v1/containers Valores possíveis: `container_reference`	Sim	container_reference

OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam

Name	Tipo	Description	Obrigatório	Predefinição
competências	array de OpenAI.LocalSkillParam	Uma lista opcional de competências. Restrições: máximoItens: 200	No
tipo	enumeração	Usa um ambiente informático local. Valores possíveis: `local`	Sim	local

OpenAI.FunctionShellToolParamEnvironmentType

Property	Valor
Type	cadeia (de caracteres)
Valores	`container_auto` `local` `container_reference`

OpenAI.FunctionTool

Função

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

Name	Tipo	Description	Obrigatório	Predefinição
defer_loading	boolean	Se esta função é diferida e carregada via pesquisa de ferramentas.	No
descrição	string ou null		No
Nome	cadeia (de caracteres)	O nome da função a ser chamada.	Sim
parameters	objeto ou nulo		Sim
rigoroso	Booleano ou nulo		Sim
tipo	enumeração	O tipo da ferramenta de função. Sempre `function`. Valores possíveis: `function`	Sim	função

OpenAI.FunctionToolParam

Name	Tipo	Description	Obrigatório	Predefinição
defer_loading	boolean	Se esta função deve ser adiada e descoberta através de pesquisa de ferramentas.	No
descrição	string ou null		No
Nome	cadeia (de caracteres)	Restrições: minComprimento: 1, máximoComprimento: 128, padrão: `^[a-zA-Z0-9_-]+$`	Sim
parameters	OpenAI.EmptyModelParam ou null		No
rigoroso	Booleano ou nulo		No
tipo	enumeração	Valores possíveis: `function`	Sim	função

OpenAI.GrammarSyntax1

Property	Valor
Type	cadeia (de caracteres)
Valores	`lark` `regex`

OpenAI.HybridSearchOptions

Name	Tipo	Description	Obrigatório	Predefinição
embedding_weight	number	O peso do embedding na fusão de classificação recíproca.	Sim
text_weight	number	O peso do texto na fusão de classificação recíproca.	Sim

OpenAI.ImageDetail

Property	Valor
Type	cadeia (de caracteres)
Valores	`low` `high` `auto` `original`

OpenAI.ImageGenActionEnum

Property	Valor
Type	cadeia (de caracteres)
Valores	`generate` `edit` `auto`

OpenAI.ImageGenTool

Ferramenta de geração de imagens

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

Modelos válidos:

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

Name	Tipo	Description	Obrigatório	Predefinição
ação	OpenAI.ImageGenActionEnum		No
em segundo plano	enumeração	Tipo de plano de fundo para a imagem gerada. Um dos `transparent`, `opaque`, ou `auto`. Padrão: `auto`. Valores possíveis: `transparent`, `opaque`, `auto`	No	automóvel
input_fidelity	OpenAI.InputFidelity ou nulo		No
máscara_da_imagem_de_entrada	OpenAI.ImageGenToolInputImageMask		No
└─ id_do_arquivo	cadeia (de caracteres)		No
└─ image_url	string (uri)		No
modelo	string (ver modelos válidos abaixo)		No
Moderação	enumeração	Nível de moderação para a imagem gerada. Padrão: `auto`. Valores possíveis: `auto`, `low`	No	automóvel
compressão_de_saída	número inteiro	Nível de compressão para a imagem de saída. Padrão: 100. Restrições: mínimo: 0, máximo: 100	No	100
formato_de_saida	enumeração	O formato de saída da imagem gerada. Um dos `png`, `webp`, ou `jpeg`. Padrão: `png`. Valores possíveis: `png`, `webp`, `jpeg`	No	png
imagens parciais	número inteiro	Número de imagens parciais para gerar no modo de streaming, de 0 (valor padrão) a 3. Restrições: mínimo: 0, máximo: 3	No
qualidade	enumeração	A qualidade da imagem gerada. Um dos `low`, `medium`, `high`, ou `auto`. Padrão: `auto`. Valores possíveis: `low`, `medium`, `high`, `auto`	No	automóvel
size	string (ver modelos válidos abaixo)	O tamanho das imagens geradas. Para `gpt-image-2` e `gpt-image-2-2026-04-21`, resoluções arbitrárias são suportadas como `WIDTHxHEIGHT` cadeias, por exemplo `1536x864`. A largura e a altura devem ser ambas divisíveis por 16 e a razão de aspeto solicitada deve estar entre 1:3 e 3:1. As resoluções acima `2560x1440` são experimentais, e a resolução máxima suportada é `3840x2160`. O tamanho solicitado deve também satisfazer os limites atuais de píxeis e bordas do modelo. Os tamanhos `1024x1024`padrão , `1536x1024`, e `1024x1536` são suportados pelos modelos de imagem GPT; `auto` é suportado para modelos que permitem o dimensionamento automático. Para `dall-e-2`, use um dos `256x256`, `512x512`, ou `1024x1024`. Para `dall-e-3`, use um dos `1024x1024`, `1792x1024`, ou `1024x1792`.	No
tipo	enumeração	O tipo da ferramenta de geração de imagem. Sempre `image_generation`. Valores possíveis: `image_generation`	Sim	image_generation

OpenAI.ImageGenToolInputImageMask

Name	Tipo	Description	Obrigatório	Predefinição
identificação_de_ficheiro	cadeia (de caracteres)		No
image_url	string (uri)		No

OpenAI.InlineSkillParam

Name	Tipo	Description	Obrigatório	Predefinição
descrição	cadeia (de caracteres)	A descrição da habilidade.	Sim
Nome	cadeia (de caracteres)	O nome da habilidade.	Sim
origem	OpenAI.InlineSkillSourceParam	Carga útil de competência em linha	Sim
└─ dados	cadeia (de caracteres)	Pacote zip de habilidades codificado em base64. Restrições: minComprimento: 1, máximoComprimento: 70254592	Sim
└─ media_type	enumeração	O tipo de media da carga útil de competência inline. Deve ser `application/zip`. Valores possíveis: `application/zip`	Sim	application/zip
└─ tipo	enumeração	O tipo da fonte de habilidades inline. Deve ser `base64`. Valores possíveis: `base64`	Sim	base64
tipo	enumeração	Define uma competência inline para este pedido. Valores possíveis: `inline`	Sim	inline

OpenAI.InlineSkillSourceParam

Carga útil de competência em linha

Name	Tipo	Description	Obrigatório	Predefinição
dados	cadeia (de caracteres)	Pacote zip de habilidades codificado em base64. Restrições: minComprimento: 1, máximoComprimento: 70254592	Sim
media_type	enumeração	O tipo de media da carga útil de competência inline. Deve ser `application/zip`. Valores possíveis: `application/zip`	Sim	application/zip
tipo	enumeração	O tipo da fonte de habilidades inline. Deve ser `base64`. Valores possíveis: `base64`	Sim	base64

OpenAI.InputAudio

Áudio de entrada

Uma entrada de áudio para o modelo.

Name	Tipo	Description	Obrigatório	Predefinição
input_audio	OpenAI.InputÁudioInputAudio		Sim
tipo	enumeração	O tipo do item de entrada. Sempre `input_audio`. Valores possíveis: `input_audio`	Sim

OpenAI.InputÁudioInputAudio

Name	Tipo	Description	Obrigatório	Predefinição
dados	cadeia (de caracteres)		Sim
format	enumeração	Valores possíveis: `mp3`, `wav`	Sim

OpenAI.InputContent

Discriminador para OpenAI.InputContent

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

Valor do tipo	Schema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputConteúdoInputImageContent
`input_file`	OpenAI.InputContentInputInputFileContent

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.InputContentType		Sim

OpenAI.InputContentInputInputFileContent

Ficheiro de entrada

Uma entrada de arquivo para o modelo.

Name	Tipo	Description	Obrigatório	Predefinição
detail	OpenAI.FileInputDetail		No
file_data	cadeia (de caracteres)	O conteúdo do arquivo a ser enviado para o modelo.	No
identificação_de_ficheiro	string ou null		No
file_url	string (uri)	O URL do ficheiro a ser enviado para o modelo.	No
filename	cadeia (de caracteres)	O nome do arquivo a ser enviado para o modelo.	No
tipo	enumeração	O tipo do item de entrada. Sempre `input_file`. Valores possíveis: `input_file`	Sim	input_file

OpenAI.InputConteúdoInputImageContent

Imagem de entrada

Uma entrada de imagem para o modelo.

Name	Tipo	Description	Obrigatório	Predefinição
detail	OpenAI.ImageDetail		Sim
identificação_de_ficheiro	string ou null		No
image_url	string ou null		No
tipo	enumeração	O tipo do item de entrada. Sempre `input_image`. Valores possíveis: `input_image`	Sim	input_image

OpenAI.InputContentInputTextContent

Texto de entrada

Uma entrada de texto para o modelo.

Name	Tipo	Description	Obrigatório	Predefinição
enviar SMS	cadeia (de caracteres)	A entrada de texto para o modelo.	Sim
tipo	enumeração	O tipo do item de entrada. Sempre `input_text`. Valores possíveis: `input_text`	Sim	input_text

OpenAI.InputContentType

Property	Valor
Type	cadeia (de caracteres)
Valores	`input_text` `input_image` `input_file`

OpenAI.InputFidelity

Controle quanto esforço o modelo irá exercer para corresponder ao estilo e características, especialmente características faciais, das imagens de entrada. Este parâmetro é suportado apenas para gpt-image-1 e gpt-image-1.5 modelos posteriores, não suportados para gpt-image-1-mini. Suporta high e low. O valor padrão é low.

Property	Valor
Type	cadeia (de caracteres)
Valores	`high` `low`

OpenAI.InputFileContentParam

Ficheiro de entrada

Uma entrada de arquivo para o modelo.

Name	Tipo	Description	Obrigatório	Predefinição
detail	OpenAI.FileInputDetail		No
file_data	string ou null		No
identificação_de_ficheiro	string ou null		No
file_url	string ou null		No
filename	string ou null		No
tipo	enumeração	O tipo do item de entrada. Sempre `input_file`. Valores possíveis: `input_file`	Sim	input_file

OpenAI.InputImageContentParamAutoParam

Imagem de entrada

Uma entrada de imagem para o modelo. Aprenda sobre entradas de imagem

Name	Tipo	Description	Obrigatório	Predefinição
detail	OpenAI.DetailEnum ou null		No
identificação_de_ficheiro	string ou null		No
image_url	string ou null		No
tipo	enumeração	O tipo do item de entrada. Sempre `input_image`. Valores possíveis: `input_image`	Sim	input_image

OpenAI.InputItem

Um item que representa parte do contexto para a resposta a ser gerada pelo modelo. Pode conter texto, imagens e entradas de áudio, bem como respostas anteriores de assistentes e saídas de chamadas de ferramenta.

Discriminador para OpenAI.InputItem

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

Valor do tipo	Schema
`message`	OpenAI.EasyInputMessage
`item_reference`	OpenAI.ItemReferenceParam
`output_message`	OpenAI.InputItemOutputMessage
`file_search_call`	OpenAI.InputItemFicheiroSearchToolCall
`computer_call`	OpenAI.InputItemComputerToolCall
`computer_call_output`	OpenAI.InputItemComputerCallOutputItemParam
`web_search_call`	OpenAI.InputItemWebSearchToolCall
`function_call`	OpenAI.InputItemFunctionToolCall
`function_call_output`	OpenAI.InputItemFunctionCallOutputItemParam
`tool_search_call`	OpenAI.InputItemToolSearchCallItemParam
`tool_search_output`	OpenAI.InputItemToolSearchOutputItemParam
`reasoning`	OpenAI.InputItemReasoningItem
`compaction`	OpenAI.InputItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.InputItemImageGenToolCall
`code_interpreter_call`	OpenAI.InputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.InputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.InputItemLocalShellToolCallOutput
`shell_call`	OpenAI.InputItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.InputItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.InputItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.InputItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.InputItemMcpListTools
`mcp_approval_request`	OpenAI.InputItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.InputItemMcpAprovaçãoResposta
`mcp_call`	OpenAI.InputItemMcpToolCall
`custom_tool_call_output`	OpenAI.InputItemCustomToolCallOutput
`custom_tool_call`	OpenAI.InputItemCustomToolCall
`tool_approval_response`	AzureToolApprovalResponse

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.InputItemType		Sim

OpenAI.InputItemApplyPatchToolCallItemParam

Aplicar chamada de ferramenta de patch

Uma chamada de ferramenta que representa um pedido para criar, eliminar ou atualizar ficheiros usando diferentes patches.

Name	Tipo	Description	Obrigatório	Predefinição
call_id	cadeia (de caracteres)	O ID único da chamada à ferramenta de aplicação do patch gerada pelo modelo. Restrições: minComprimento: 1, máximoComprimento: 64	Sim
id	string ou null		No
operação	OpenAI.ApplyPatchOperationParam	Uma das operações create_file, delete_file ou update_file fornecidas à ferramenta apply_patch.	Sim
└─ tipo	OpenAI.ApplyPatchOperationParamType		Sim
estado	OpenAI.ApplyPatchCallStatusParam	Valores de estado reportados para chamadas apply_patch ferramentas.	Sim
tipo	enumeração	O tipo do artigo. Sempre `apply_patch_call`. Valores possíveis: `apply_patch_call`	Sim	apply_patch_call

OpenAI.InputItemApplyPatchToolCallOutputItemParam

Aplicar a saída da chamada de ferramenta de patch

A saída transmitida emitida por uma chamada de ferramenta apply patch.

Name	Tipo	Description	Obrigatório	Predefinição
call_id	cadeia (de caracteres)	O ID único da chamada à ferramenta de aplicação do patch gerada pelo modelo. Restrições: minComprimento: 1, máximoComprimento: 64	Sim
id	string ou null		No
saída	string ou null		No
estado	OpenAI.ApplyPatchCallOutputStatusParam	Valores de resultado reportados para apply_patch saídas de chamadas de ferramenta.	Sim
tipo	enumeração	O tipo do artigo. Sempre `apply_patch_call_output`. Valores possíveis: `apply_patch_call_output`	Sim	apply_patch_call_output

OpenAI.InputItemCodeInterpreterToolCall

Chamada de ferramenta de interpretador de código

Uma chamada de ferramenta para executar código.

Name	Tipo	Description	Obrigatório	Predefinição
código	string ou null		Sim
container_id	cadeia (de caracteres)	A ID do contêiner usado para executar o código.	Sim
id	cadeia (de caracteres)	O ID exclusivo da chamada da ferramenta de interpretação de código.	Sim
outputs	array de OpenAI.CodeInterpreterOutputLogs ou OpenAI.CodeInterpreterOutputImage ou null		Sim
estado	enumeração	O estado da chamada da ferramenta intérprete de código. Os valores válidos são `in_progress`, `completed`, `incomplete`, `interpreting`, e `failed`. Valores possíveis: `in_progress`, `completed`, `incomplete`, `interpreting`, , `failed`	Sim
tipo	enumeração	O tipo de chamada da ferramenta de interpretação de código. Sempre `code_interpreter_call`. Valores possíveis: `code_interpreter_call`	Sim	code_interpreter_call

OpenAI.InputItemCompactionSummaryItemParam

Item de compactação

Um item de compactação gerado pela v1/responses/compact API.

Name	Tipo	Description	Obrigatório	Predefinição
encrypted_content	cadeia (de caracteres)	O conteúdo encriptado do resumo da compactação. Restrições: maxComprimento: 10485760	Sim
id	string ou null		No
tipo	enumeração	O tipo do artigo. Sempre `compaction`. Valores possíveis: `compaction`	Sim	Compactação

OpenAI.InputItemComputerCallOutputItemParam

Saída de chamada de ferramenta informática

A saída de uma chamada de ferramenta de computador.

Name	Tipo	Description	Obrigatório	Predefinição
acknowledged_safety_checks	array de OpenAI.ComputerCallSafetyCheckParam ou null		No
call_id	cadeia (de caracteres)	O ID da chamada de ferramenta de computador que produziu a saída. Restrições: minComprimento: 1, máximoComprimento: 64	Sim
id	string ou null		No
saída	OpenAI.ComputerScreenshotImage	Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.	Sim
estado	OpenAI.FunctionCallItemStatus ou null		No
tipo	enumeração	O tipo de saída da chamada da ferramenta do computador. Sempre `computer_call_output`. Valores possíveis: `computer_call_output`	Sim	computer_call_output

OpenAI.InputItemComputerToolCall

Chamada de ferramenta informática

Uma chamada de ferramenta para uma ferramenta de uso de computador.

Name	Tipo	Description	Obrigatório	Predefinição
ação	OpenAI.ComputerAction		No
actions	OpenAI.ComputerActionList	Ações agrupadas achatadas para `computer_use`. Cada ação inclui um `type` campos discriminadores e específicos de ação.	No
call_id	cadeia (de caracteres)	Um identificador usado ao responder a uma solicitação da ferramenta com resultados.	Sim
id	cadeia (de caracteres)	O identificador exclusivo da chamada do computador.	Sim
pending_safety_checks	array de OpenAI.ComputerCallSafetyCheckParam	As verificações de segurança pendentes para a chamada do computador.	Sim
estado	enumeração	O estado do item. Um dos `in_progress`, `completed`, ou `incomplete`. É preenchido quando os itens são retornados via API. Valores possíveis: `in_progress`, `completed`, `incomplete`	Sim
tipo	enumeração	O tipo da chamada do computador. Sempre `computer_call`. Valores possíveis: `computer_call`	Sim	computer_call

OpenAI.InputItemCustomToolCall

Chamada de ferramenta personalizada

Uma chamada a uma ferramenta personalizada criada pelo modelo.

Name	Tipo	Description	Obrigatório
call_id	cadeia (de caracteres)	Um identificador usado para mapear esta chamada de ferramenta personalizada para uma saída de chamada de ferramenta.	Sim
id	cadeia (de caracteres)	O ID único da ferramenta personalizada chama na plataforma OpenAI.	No
dados introduzidos	cadeia (de caracteres)	A entrada para a chamada de ferramenta personalizada gerada pelo modelo.	Sim
Nome	cadeia (de caracteres)	O nome da ferramenta personalizada que está a ser chamada.	Sim
espaço de nomes	cadeia (de caracteres)	O namespace da ferramenta personalizada que está a ser chamada.	No
tipo	enumeração	O tipo de chamada de ferramenta personalizada. Sempre `custom_tool_call`. Valores possíveis: `custom_tool_call`	Sim

OpenAI.InputItemCustomToolCallOutput

Saída personalizada de chamadas de ferramenta

A saída de uma chamada de ferramenta personalizada do teu código, a ser enviada de volta para o modelo.

Name	Tipo	Description	Obrigatório
call_id	cadeia (de caracteres)	O ID da chamada era usado para mapear esta saída de chamada de ferramenta personalizada para uma chamada de ferramenta personalizada.	Sim
id	cadeia (de caracteres)	O ID único da saída da chamada de ferramenta personalizada na plataforma OpenAI.	No
saída	string ou array de OpenAI.FunctionAndCustomToolCallOutput	A saída da chamada de ferramenta personalizada gerada pelo teu código. Pode ser uma cadeia de caracteres ou uma lista de conteúdos de saída.	Sim
tipo	enumeração	O tipo de saída da chamada de ferramenta personalizada. Sempre `custom_tool_call_output`. Valores possíveis: `custom_tool_call_output`	Sim

OpenAI.InputItemFicheiroSearchToolCall

Chamada de ferramenta de pesquisa de ficheiros

Os resultados de uma chamada de ferramenta de pesquisa de arquivos.

Name	Tipo	Description	Obrigatório
id	cadeia (de caracteres)	A ID única da chamada da ferramenta de pesquisa de ficheiros.	Sim
queries	array de strings	As consultas usadas para procurar arquivos.	Sim
results	array de OpenAI.FileSearchToolCallResults ou null		No
estado	enumeração	O status da chamada da ferramenta de pesquisa de arquivos. Um dos `in_progress`, `searching`, `incomplete` ou `failed`, Valores possíveis: `in_progress`, `searching`, `completed`, `incomplete`, , `failed`	Sim
tipo	enumeração	O tipo de chamada da ferramenta de pesquisa de ficheiros. Sempre `file_search_call`. Valores possíveis: `file_search_call`	Sim

OpenAI.InputItemFunctionCallOutputItemParam

Saída da chamada da ferramenta de função

A saída de uma chamada de ferramenta funcional.

Name	Tipo	Description	Obrigatório	Predefinição
call_id	cadeia (de caracteres)	O ID exclusivo da chamada da ferramenta funcional gerada pelo modelo. Restrições: minComprimento: 1, máximoComprimento: 64	Sim
id	string ou null		No
saída	cadeia ou array de OpenAI.InputTextContentParam ou OpenAI.InputImageContentParamAutoParam ou OpenAI.InputFileContentParam	Saída de texto, imagem ou ficheiro da chamada de ferramenta funcional.	Sim
estado	OpenAI.FunctionCallItemStatus ou null		No
tipo	enumeração	O tipo da saída de chamada da ferramenta de função. Sempre `function_call_output`. Valores possíveis: `function_call_output`	Sim	function_call_output

OpenAI.InputItemFunctionShellCallItemParam

Chamada de ferramenta shell

Uma ferramenta que representa um pedido para executar um ou mais comandos shell.

Name	Tipo	Description	Obrigatório	Predefinição
ação	OpenAI.FunctionShellActionParam	Comandos e limites que descrevem como executar a chamada à ferramenta shell.	Sim
└─ comandos	array de strings	Ordenei comandos shell para o ambiente de execução ser executado.	Sim
└─ max_output_length	inteiro ou nulo		No
└─ timeout_ms	inteiro ou nulo		No
call_id	cadeia (de caracteres)	O ID único da chamada da ferramenta shell gerada pelo modelo. Restrições: minComprimento: 1, máximoComprimento: 64	Sim
ambiente	OpenAI.FunctionShellCallItemParamEnvironment ou null		No
id	string ou null		No
estado	OpenAI.FunctionShellCallItemStatus ou null		No
tipo	enumeração	O tipo do artigo. Sempre `shell_call`. Valores possíveis: `shell_call`	Sim	shell_call

OpenAI.InputItemFunctionShellCallOutputItemParam

Saída da chamada de ferramenta shell

Os itens de saída transmitidos por uma ferramenta shell chamam.

Name	Tipo	Description	Obrigatório	Predefinição
call_id	cadeia (de caracteres)	O ID único da chamada da ferramenta shell gerada pelo modelo. Restrições: minComprimento: 1, máximoComprimento: 64	Sim
id	string ou null		No
max_output_length	inteiro ou nulo		No
saída	array de OpenAI.FunctionShellCallOutputContentParam	Capturaram blocos da produção stdout e stderr, juntamente com os seus resultados associados.	Sim
estado	OpenAI.FunctionShellCallItemStatus ou null		No
tipo	enumeração	O tipo do artigo. Sempre `shell_call_output`. Valores possíveis: `shell_call_output`	Sim	shell_call_output

OpenAI.InputItemFunctionToolCall

Chamada de ferramenta de função

Uma chamada de ferramenta para executar uma função.

Name	Tipo	Description	Obrigatório
arguments	cadeia (de caracteres)	Uma cadeia de caracteres JSON dos argumentos a serem passados para a função.	Sim
call_id	cadeia (de caracteres)	O ID exclusivo da chamada da ferramenta funcional gerada pelo modelo.	Sim
id	String (só leitura)	O ID único da chamada da ferramenta de função.	Sim
Nome	cadeia (de caracteres)	O nome da função a ser executada.	Sim
espaço de nomes	cadeia (de caracteres)	O namespace da função a executar.	No
estado	enumeração	O estado do item. Um dos `in_progress`, `completed`, ou `incomplete`. É preenchido quando os itens são retornados via API. Valores possíveis: `in_progress`, `completed`, `incomplete`	No
tipo	enumeração	O tipo de chamada da ferramenta funcional. Sempre `function_call`. Valores possíveis: `function_call`	Sim

OpenAI.InputItemImageGenToolCall

Chamada de geração de imagem

Um pedido de geração de imagem feito pelo modelo.

Name	Tipo	Description	Obrigatório
id	cadeia (de caracteres)	O ID único da chamada de geração de imagem.	Sim
result	string ou null		Sim
estado	enumeração	O estado da chamada de geração de imagem. Valores possíveis: `in_progress`, `completed`, `generating`, `failed`	Sim
tipo	enumeração	O tipo de chamada de geração de imagem. Sempre `image_generation_call`. Valores possíveis: `image_generation_call`	Sim

OpenAI.InputItemLocalShellToolCall

Chamada local de shell

Uma chamada de ferramenta para executar um comando no shell local.

Name	Tipo	Description	Obrigatório
ação	OpenAI.LocalShellExecAction	Execute um comando shell no servidor.	Sim
call_id	cadeia (de caracteres)	A ID exclusiva da chamada de ferramenta de shell local gerada pelo modelo.	Sim
id	cadeia (de caracteres)	O ID único da chamada local de shell.	Sim
estado	enumeração	O estado do chamado local de shell. Valores possíveis: `in_progress`, `completed`, `incomplete`	Sim
tipo	enumeração	O tipo de chamada local de shell. Sempre `local_shell_call`. Valores possíveis: `local_shell_call`	Sim

OpenAI.InputItemLocalShellToolCallOutput

Saída local da chamada shell

A saída de uma chamada de ferramenta shell local.

Name	Tipo	Description	Obrigatório
id	cadeia (de caracteres)	A ID exclusiva da chamada de ferramenta de shell local gerada pelo modelo.	Sim
saída	cadeia (de caracteres)	Uma cadeia de caracteres JSON da saída da chamada da ferramenta shell local.	Sim
estado	string ou null		No
tipo	enumeração	O tipo da ferramenta local de shell chama output. Sempre `local_shell_call_output`. Valores possíveis: `local_shell_call_output`	Sim

OpenAI.InputItemMcpApprovalRequest

Pedido de aprovação do MCP

Um pedido de aprovação humana de uma invocação de ferramenta.

Name	Tipo	Description	Obrigatório
arguments	cadeia (de caracteres)	Uma cadeia de argumentos JSON para a ferramenta.	Sim
id	cadeia (de caracteres)	O ID único do pedido de aprovação.	Sim
Nome	cadeia (de caracteres)	O nome da ferramenta a ser executada.	Sim
rótulo de servidor	cadeia (de caracteres)	O rótulo do servidor MCP que faz a solicitação.	Sim
tipo	enumeração	O tipo do artigo. Sempre `mcp_approval_request`. Valores possíveis: `mcp_approval_request`	Sim

OpenAI.InputItemMcpAprovaçãoResposta

Resposta de aprovação do MCP

Uma resposta a uma solicitação de aprovação de MCP.

Name	Tipo	Description	Obrigatório
approval_request_id	cadeia (de caracteres)	O identificador do pedido de aprovação ao qual se está a responder.	Sim
approve	boolean	Se o pedido foi aprovado.	Sim
id	string ou null		No
reason	string ou null		No
tipo	enumeração	O tipo do artigo. Sempre `mcp_approval_response`. Valores possíveis: `mcp_approval_response`	Sim

OpenAI.InputItemMcpListTools

Ferramentas de listas MCP

Uma lista de ferramentas disponíveis em um servidor MCP.

Name	Tipo	Description	Obrigatório
erro	OpenAI.RealtimeMCPError		No
id	cadeia (de caracteres)	O ID único da lista.	Sim
rótulo de servidor	cadeia (de caracteres)	O rótulo do servidor MCP.	Sim
tools	array de OpenAI.MCPListToolsTool	As ferramentas disponíveis no servidor.	Sim
tipo	enumeração	O tipo do artigo. Sempre `mcp_list_tools`. Valores possíveis: `mcp_list_tools`	Sim

OpenAI.InputItemMcpToolCall

Chamada de ferramenta MCP

Uma invocação de uma ferramenta em um servidor MCP.

Name	Tipo	Description	Obrigatório
approval_request_id	string ou null		No
arguments	cadeia (de caracteres)	Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta.	Sim
erro	OpenAI.RealtimeMCPError		No
id	cadeia (de caracteres)	O ID único da chamada de ferramenta.	Sim
Nome	cadeia (de caracteres)	O nome da ferramenta que foi executada.	Sim
saída	string ou null		No
rótulo de servidor	cadeia (de caracteres)	O rótulo do servidor MCP que executa a ferramenta.	Sim
estado	OpenAI.MCPToolCallStatus		No
tipo	enumeração	O tipo do artigo. Sempre `mcp_call`. Valores possíveis: `mcp_call`	Sim

OpenAI.InputItemOutputMessage

Mensagem de saída

Uma mensagem de saída do modelo.

Name	Tipo	Description	Obrigatório
conteúdo	array de OpenAI.OutputMessageContent	O conteúdo da mensagem de saída.	Sim
id	cadeia (de caracteres)	O ID exclusivo da mensagem de saída.	Sim
fase	OpenAI.MessagePhase ou null		No
função	enumeração	A função da mensagem de saída. Sempre `assistant`. Valores possíveis: `assistant`	Sim
estado	enumeração	O estado da entrada de mensagem. Um dos `in_progress`, `completed`, ou `incomplete`. Preenchido quando os itens de entrada são retornados via API. Valores possíveis: `in_progress`, `completed`, `incomplete`	Sim
tipo	enumeração	O tipo da mensagem de saída. Sempre `message`. Valores possíveis: `output_message`	Sim

OpenAI.InputItemReasoningItem

Reasoning

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

Name	Tipo	Description	Obrigatório
conteúdo	array de OpenAI.ReasoningTextContent	Texto de raciocínio.	No
encrypted_content	string ou null		No
id	cadeia (de caracteres)	O identificador exclusivo do conteúdo do raciocínio.	Sim
estado	enumeração	O estado do item. Um dos `in_progress`, `completed`, ou `incomplete`. É preenchido quando os itens são retornados via API. Valores possíveis: `in_progress`, `completed`, `incomplete`	No
resumo	array de OpenAI.ResumoTextoConteúdo	Conteúdo resumido do raciocínio.	Sim
tipo	enumeração	O tipo do objeto. Sempre `reasoning`. Valores possíveis: `reasoning`	Sim

OpenAI.InputItemToolSearchCallItemParam

Name	Tipo	Description	Obrigatório	Predefinição
arguments	OpenAI.EmptyModelParam		Sim
call_id	string ou null		No
execução	OpenAI.ToolSearchExecutionType		No
id	string ou null		No
estado	OpenAI.FunctionCallItemStatus ou null		No
tipo	enumeração	O tipo de item. Sempre `tool_search_call`. Valores possíveis: `tool_search_call`	Sim	tool_search_call

OpenAI.InputItemToolSearchOutputItemParam

Name	Tipo	Description	Obrigatório	Predefinição
call_id	string ou null		No
execução	OpenAI.ToolSearchExecutionType		No
id	string ou null		No
estado	OpenAI.FunctionCallItemStatus ou null		No
tools	array do OpenAI.Tool	As definições de ferramentas carregadas são devolvidas pelo resultado da pesquisa da ferramenta.	Sim
tipo	enumeração	O tipo de item. Sempre `tool_search_output`. Valores possíveis: `tool_search_output`	Sim	tool_search_output

OpenAI.InputItemType

Property Valor

Type cadeia (de caracteres)

Valores message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
tool_search_call
tool_search_output
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
custom_tool_call_output
custom_tool_call
item_reference
tool_approval_response

OpenAI.InputItemWebSearchToolCall

Chamada de ferramenta de pesquisa web

Os resultados de uma ferramenta de pesquisa web chamam.

Name	Tipo	Description	Obrigatório
ação	OpenAI.WebSearchActionSearch ou OpenAI.WebSearchActionOpenPage ou OpenAI.WebSearchActionFind	Um objeto que descreve a ação específica realizada nesta chamada de pesquisa web. Inclui detalhes sobre como o modelo utilizou a web (pesquisa, open_page, find_in_page).	Sim
id	cadeia (de caracteres)	O ID único da ferramenta de pesquisa web chama.	Sim
estado	enumeração	O status da chamada da ferramenta de pesquisa na web. Valores possíveis: `in_progress`, `searching`, `completed`, `failed`	Sim
tipo	enumeração	O tipo da ferramenta de pesquisa web chamada. Sempre `web_search_call`. Valores possíveis: `web_search_call`	Sim

OpenAI.InputMessageContentList

Lista de conteúdos de itens de entrada

Uma lista de um ou vários itens de entrada para o modelo, contendo diferentes tipos de conteúdo.

Variedade de: OpenAI.InputContent

OpenAI.InputTextContentParam

Texto de entrada

Uma entrada de texto para o modelo.

Name	Tipo	Description	Obrigatório	Predefinição
enviar SMS	cadeia (de caracteres)	A entrada de texto para o modelo. Restrições: maxComprimento: 10485760	Sim
tipo	enumeração	O tipo do item de entrada. Sempre `input_text`. Valores possíveis: `input_text`	Sim	input_text

OpenAI.ItemReferenceParam

Referência do item

Um identificador interno para um item a ser referenciado.

Name	Tipo	Description	Obrigatório	Predefinição
id	cadeia (de caracteres)	A ID do item a ser referenciado.	Sim
tipo	enumeração	O tipo de item a ser referenciado. Sempre `item_reference`. Valores possíveis: `item_reference`	Sim	item_reference

OpenAI.KeyPressAction

KeyPress

Uma coleção de pressionamentos de teclas que o modelo gostaria de realizar.

Name	Tipo	Description	Obrigatório	Predefinição
keys	array de strings	A combinação de teclas que o modelo está solicitando para ser pressionada. Esta é uma matriz de cadeias de caracteres, cada uma representando uma chave.	Sim
tipo	enumeração	Especifica o tipo de evento. Para uma ação de pressionamento de teclas, essa propriedade é sempre definida como `keypress`. Valores possíveis: `keypress`	Sim	Pressionar teclas

OpenAI.LocalShellExecAction

Ação local do executivo shell

Execute um comando shell no servidor.

Name	Tipo	Description	Obrigatório	Predefinição
command	array de strings	O comando a ser executado.	Sim
env	objecto	Variáveis de ambiente a serem definidas para o comando.	Sim
timeout_ms (tempo limite em milissegundos)	inteiro ou nulo		No
tipo	enumeração	O tipo de ação do shell local. Sempre `exec`. Valores possíveis: `exec`	Sim	exec
utilizador	string ou null		No
diretório_de_trabalho	string ou null		No

OpenAI.LocalShellToolParam

Ferramenta local de concha

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

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

OpenAI.LocalSkillParam

Name	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)	A descrição da habilidade.	Sim
Nome	cadeia (de caracteres)	O nome da habilidade.	Sim
caminho	cadeia (de caracteres)	O caminho para o diretório que contém a habilidade.	Sim

OpenAI.LogProb

Probabilidade logarítmica

A probabilidade logarítmica de um token.

Name	Tipo	Obrigatório
bytes	array de inteiros	Sim
logprob	number	Sim
token	cadeia (de caracteres)	Sim
top_logprobs	array de OpenAI.TopLogProb	Sim

OpenAI.MCPListToolsTool

Ferramenta de listas MCP

Uma ferramenta disponível em um servidor MCP.

Name	Tipo	Description	Obrigatório
annotations	OpenAI.MCPListToolsToolAnnotations ou null		No
descrição	string ou null		No
input_schema	OpenAI.MCPListToolsToolInputSchema		Sim
Nome	cadeia (de caracteres)	O nome da ferramenta.	Sim

OpenAI.MCPListToolsToolAnnotations

Tipo: objeto

OpenAI.MCPListToolsToolInputSchema

Tipo: objeto

OpenAI.MCPTool

Ferramenta MCP

Dê ao modelo acesso a ferramentas adicionais por meio de servidores MCP (Model Context Protocol) remotos.

Name	Tipo	Description	Obrigatório
ferramentas permitidas	array de string ou OpenAI.MCPToolFilter ou null		No
autorização	cadeia (de caracteres)	Um token de acesso OAuth que pode ser usado com um servidor MCP remoto, seja com um URL de servidor MCP personalizado ou um conector de serviço. A aplicação deve gerir o fluxo de autorização OAuth e fornecer o token aqui.	No
connector_id	enumeração	Identificador para conectores de serviço, como os disponíveis no ChatGPT. Um dos `server_url` ou `connector_id` que deve ser providenciado. Saiba mais sobre o serviço Conectores aqui. Os valores atualmente suportados `connector_id` são: - Dropbox: `connector_dropbox` - Gmail: `connector_gmail` - Google Calendar: `connector_googlecalendar` - Google Drive: `connector_googledrive` - Microsoft Teams:`connector_microsoftteams` - Outlook Calendário: `connector_outlookcalendar` - Outlook Email:`connector_outlookemail` - SharePoint:`connector_sharepoint` Valores possíveis: `connector_dropbox`, `connector_gmail`, `connector_googlecalendar`, `connector_googledrive`, `connector_microsoftteams`, `connector_outlookcalendar`, `connector_outlookemail`, `connector_sharepoint`	No
defer_loading	boolean	Se esta ferramenta MCP é adiada e descoberta através de pesquisa de ferramentas.	No
headers	objeto ou nulo		No
requer_aprovação	OpenAI.MCPToolRequireApproval ou string ou null		No
server_description	cadeia (de caracteres)	Descrição opcional do servidor MCP, usada para fornecer mais contexto.	No
rótulo de servidor	cadeia (de caracteres)	Um rótulo para este servidor MCP, usado para identificá-lo em chamadas de ferramentas.	Sim
URL do servidor	string (uri)	A URL do servidor MCP. Um dos `server_url` ou `connector_id` deve ser fornecido.	No
tipo	enumeração	O tipo da ferramenta MCP. Sempre `mcp`. Valores possíveis: `mcp`	Sim

OpenAI.MCPToolCallStatus

Property	Valor
Type	cadeia (de caracteres)
Valores	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

Filtro de ferramenta MCP

Um objeto filtro para especificar quais as ferramentas permitidas.

Name	Tipo	Description	Obrigatório	Predefinição
read_only	boolean	Indica se uma ferramenta modifica dados ou se é apenas de leitura. Se um O servidor MCP é anotado com `readOnlyHint`, Vai corresponder a este filtro.	No
tool_names	array de strings	Lista de nomes de ferramentas permitidas.	No

OpenAI.MCPToolRequireApproval

Name	Tipo	Description	Obrigatório	Predefinição
Sempre	OpenAI.MCPToolFilter	Um objeto filtro para especificar quais as ferramentas permitidas.	No
nunca	OpenAI.MCPToolFilter	Um objeto filtro para especificar quais as ferramentas permitidas.	No

OpenAI.MessageContent

Uma parte de conteúdo que constitui um item de entrada ou saída.

Discriminador para OpenAI.MessageContent

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

Valor do tipo	Schema
`text`	OpenAI.TextContent
`computer_screenshot`	OpenAI.ComputerScreenshotContent
`input_text`	OpenAI.MessageContentInputTextContent
`output_text`	OpenAI.MessageContentOutputTextContent
`reasoning_text`	OpenAI.MensagemRaciocínioConteúdoTextoConteúdo
`refusal`	OpenAI.MessageContentRefusalContent
`input_image`	OpenAI.MessageContentInputImageContent
`input_file`	OpenAI.MessageContentInputFileContent
`summary_text`	OpenAI.ResumoTextoConteúdo

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.MessageContentType		Sim

OpenAI.MessageContentInputFileContent

Ficheiro de entrada

Uma entrada de arquivo para o modelo.

Name	Tipo	Description	Obrigatório	Predefinição
detail	OpenAI.FileInputDetail		No
file_data	cadeia (de caracteres)	O conteúdo do arquivo a ser enviado para o modelo.	No
identificação_de_ficheiro	string ou null		No
file_url	string (uri)	O URL do ficheiro a ser enviado para o modelo.	No
filename	cadeia (de caracteres)	O nome do arquivo a ser enviado para o modelo.	No
tipo	enumeração	O tipo do item de entrada. Sempre `input_file`. Valores possíveis: `input_file`	Sim	input_file

OpenAI.MessageContentInputImageContent

Imagem de entrada

Uma entrada de imagem para o modelo.

Name	Tipo	Description	Obrigatório	Predefinição
detail	OpenAI.ImageDetail		Sim
identificação_de_ficheiro	string ou null		No
image_url	string ou null		No
tipo	enumeração	O tipo do item de entrada. Sempre `input_image`. Valores possíveis: `input_image`	Sim	input_image

OpenAI.MessageContentInputTextContent

Texto de entrada

Uma entrada de texto para o modelo.

Name	Tipo	Description	Obrigatório	Predefinição
enviar SMS	cadeia (de caracteres)	A entrada de texto para o modelo.	Sim
tipo	enumeração	O tipo do item de entrada. Sempre `input_text`. Valores possíveis: `input_text`	Sim	input_text

OpenAI.MessageContentOutputTextContent

Texto de saída

Uma saída de texto do modelo.

Name	Tipo	Description	Obrigatório	Predefinição
annotations	array do OpenAI.Annotation	As anotações sobre a saída de texto.	Sim
Logprobs	array do OpenAI.LogProb		Sim
enviar SMS	cadeia (de caracteres)	A saída de texto do modelo.	Sim
tipo	enumeração	O tipo do texto de saída. Sempre `output_text`. Valores possíveis: `output_text`	Sim	output_text

OpenAI.MensagemRaciocínioConteúdoTextoConteúdo

Texto de raciocínio

Texto de raciocínio do modelo.

Name	Tipo	Description	Obrigatório	Predefinição
enviar SMS	cadeia (de caracteres)	O texto de raciocínio do modelo.	Sim
tipo	enumeração	O tipo do texto de raciocínio. Sempre `reasoning_text`. Valores possíveis: `reasoning_text`	Sim	reasoning_text

OpenAI.MessageContentRefusalContent

Refusal

Uma recusa do modelo.

Name	Tipo	Description	Obrigatório	Predefinição
refusal	cadeia (de caracteres)	A explicação da recusa a partir do modelo.	Sim
tipo	enumeração	O tipo de recusa. Sempre `refusal`. Valores possíveis: `refusal`	Sim	refusal

OpenAI.MessageContentType

Property	Valor
Type	cadeia (de caracteres)
Valores	`input_text` `output_text` `text` `summary_text` `reasoning_text` `refusal` `input_image` `computer_screenshot` `input_file`

OpenAI.MessagePhase

Rotula uma assistant mensagem como comentário intermédio (commentary) ou como resposta final (final_answer). Para modelos como gpt-5.3-codex e outros, ao enviar pedidos de seguimento, preserva e reenvia a fase de todas as mensagens do assistente — a sua perda pode degradar o desempenho. Não é usado para mensagens de utilizador.

Property	Valor
Type	cadeia (de caracteres)
Valores	`commentary` `final_answer`

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 via API ou o painel. As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.

Tipo: objeto

OpenAI.MoveParam

Move

Uma ação de movimento do mouse.

Name	Tipo	Description	Obrigatório	Predefinição
keys	array de string ou nulo		No
tipo	enumeração	Especifica o tipo de evento. Para uma ação de movimentação, essa propriedade é sempre definida como `move`. Valores possíveis: `move`	Sim	move
x	número inteiro	A coordenada x para a qual mover.	Sim
y	número inteiro	A coordenada y para a qual mover.	Sim

OpenAI.NamespaceToolParam

Namespace

Agrupa a função/ferramentas personalizadas num namespace partilhado.

Name	Tipo	Description	Obrigatório	Predefinição
descrição	cadeia (de caracteres)	Uma descrição do espaço de nomes mostrado ao modelo. Restrições: minComprimento: 1	Sim
Nome	cadeia (de caracteres)	O nome do namespace usado nas chamadas de ferramentas (por exemplo, `crm`). Restrições: minComprimento: 1	Sim
tools	array de OpenAI.FunctionToolParam ou OpenAI.CustomToolParam	As funções/ferramentas personalizadas disponíveis dentro deste namespace. Restrições: minItens: 1	Sim
tipo	enumeração	O tipo da ferramenta. Sempre `namespace`. Valores possíveis: `namespace`	Sim	espaço de nomes

OpenAI.OutputMessageContent

Discriminador para OpenAI.OutputMessageContent

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

Valor do tipo	Schema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.OutputMessageContentType		Sim

OpenAI.OutputMessageContentOutputTextContent

Texto de saída

Uma saída de texto do modelo.

Name	Tipo	Description	Obrigatório	Predefinição
annotations	array do OpenAI.Annotation	As anotações sobre a saída de texto.	Sim
Logprobs	array do OpenAI.LogProb		Sim
enviar SMS	cadeia (de caracteres)	A saída de texto do modelo.	Sim
tipo	enumeração	O tipo do texto de saída. Sempre `output_text`. Valores possíveis: `output_text`	Sim	output_text

OpenAI.OutputMessageContentRefusalContent

Refusal

Uma recusa do modelo.

Name	Tipo	Description	Obrigatório	Predefinição
refusal	cadeia (de caracteres)	A explicação da recusa a partir do modelo.	Sim
tipo	enumeração	O tipo de recusa. Sempre `refusal`. Valores possíveis: `refusal`	Sim	refusal

OpenAI.OutputMessageContentType

Property	Valor
Type	cadeia (de caracteres)
Valores	`output_text` `refusal`

OpenAI.RankerVersionType

Property	Valor
Type	cadeia (de caracteres)
Valores	`auto` `default-2024-11-15`

Opções de Classificação da OpenAI

Name	Tipo	Description	Obrigatório
hybrid_search	OpenAI.HybridSearchOptions		No
└─ embedding_weight	number	O peso do embedding na fusão de classificação recíproca.	Sim
└─ text_weight	number	O peso do texto na fusão de classificação recíproca.	Sim
classificador	OpenAI.RankerVersionType		No
limiar_de_pontuação	number	O limite de pontuação para a pesquisa de ficheiros, um número entre 0 e 1. Números mais próximos de 1 tentarão retornar apenas os resultados mais relevantes, mas podem retornar menos resultados.	No

OpenAI.RealtimeMCPError

Discriminador para OpenAI.RealtimeMCPError

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

Valor do tipo	Schema
`protocol_error`	OpenAI.RealtimeMCPProtocolError
`tool_execution_error`	OpenAI.RealtimeMCPToolExecutionError
`http_error`	OpenAI.RealtimeMCPHTTPError

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.RealtimeMcpErrorType		Sim

OpenAI.RealtimeMCPHTTPError

Erro HTTP MCP em tempo real

Name	Tipo	Description	Obrigatório
código	número inteiro		Sim
mensagem	cadeia (de caracteres)		Sim
tipo	enumeração	Valores possíveis: `http_error`	Sim

OpenAI.RealtimeMCPProtocolError

Erro do protocolo MCP em tempo real

Name	Tipo	Description	Obrigatório
código	número inteiro		Sim
mensagem	cadeia (de caracteres)		Sim
tipo	enumeração	Valores possíveis: `protocol_error`	Sim

OpenAI.RealtimeMCPToolExecutionError

Erro de execução da ferramenta MCP em tempo real

Name	Tipo	Description	Obrigatório	Predefinição
mensagem	cadeia (de caracteres)		Sim
tipo	enumeração	Valores possíveis: `tool_execution_error`	Sim

OpenAI.RealtimeMcpErrorType

Property	Valor
Type	cadeia (de caracteres)
Valores	`protocol_error` `tool_execution_error` `http_error`

OpenAI.ReasoningEffort

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

gpt-5.1 por defeito é none, que não executa raciocínio. Os valores de raciocínio suportados para gpt-5.1 são none, low, medium, e high. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1.
Todos os modelos anteriores gpt-5.1 ao padrão de medium esforço de raciocínio, e não suportam none.
O gpt-5-pro modelo utiliza por defeito (e apenas suporta) high o esforço de raciocínio.
xhigh é suportado para todos os modelos após gpt-5.1-codex-max.

Property	Valor
Description	Restringe o esforço para raciocínio lógico. modelos de raciocínio. Os valores atualmente suportados são `none`, `minimal`, `low`, `medium`, `high`, e `xhigh`. Reduzindo O esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados sobre o raciocínio numa resposta. - `gpt-5.1` por defeito é `none`, que não executa raciocínio. Os valores de raciocínio suportados para `gpt-5.1` são `none`, `low`, `medium`, e `high`. As chamadas de ferramenta são suportadas para todos os valores de raciocínio no gpt-5.1. - Todos os modelos anteriores `gpt-5.1` por defeito, para `medium` esforço de raciocínio, e não suportam `none`. - O `gpt-5-pro` modelo utiliza por defeito (e apenas suporta) `high` esforço de raciocínio. - `xhigh` é suportado para todos os modelos após `gpt-5.1-codex-max`.
Type	cadeia (de caracteres)
Valores	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

Texto de raciocínio

Texto de raciocínio do modelo.

Name	Tipo	Description	Obrigatório	Predefinição
enviar SMS	cadeia (de caracteres)	O texto de raciocínio do modelo.	Sim
tipo	enumeração	O tipo do texto de raciocínio. Sempre `reasoning_text`. Valores possíveis: `reasoning_text`	Sim	reasoning_text

OpenAI.ResponseFormatJsonObject

Objeto JSON

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

OpenAI.ResponseFormatJsonSchema

Esquema JSON

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

Name	Tipo	Description	Obrigatório
esquema_json	OpenAI.ResponseFormatJsonSchemaJsonSchema		Sim
└─ Descrição	cadeia (de caracteres)		No
└─ nome	cadeia (de caracteres)		Sim
└─ esquema	OpenAI.ResponseFormatJsonSchemaSchema	O esquema para o formato de resposta, descrito como um objeto de esquema JSON. Saiba como criar esquemas JSON aqui.	No
└─ rigoroso	Booleano ou nulo		No
tipo	enumeração	O tipo de formato de resposta que está sendo definido. Sempre `json_schema`. Valores possíveis: `json_schema`	Sim

OpenAI.ResponseFormatJsonSchemaJsonSchema

Name	Tipo	Description	Obrigatório
descrição	cadeia (de caracteres)		No
Nome	cadeia (de caracteres)		Sim
esquema	OpenAI.ResponseFormatJsonSchemaSchema	O esquema para o formato de resposta, descrito como um objeto de esquema JSON. Saiba como criar esquemas JSON aqui.	No
rigoroso	Booleano ou nulo		No

OpenAI.ResponseFormatJsonSchemaSchema

Esquema JSON

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

Tipo: objeto

OpenAI.ResponseFormatText

Texto

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

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

OpenAI.ScreenshotParam

Screenshot

Uma ação de captura de tela.

Name	Tipo	Description	Obrigatório	Predefinição
tipo	enumeração	Especifica o tipo de evento. Para uma ação de captura de tela, essa propriedade é sempre definida como `screenshot`. Valores possíveis: `screenshot`	Sim	captura de ecrã

OpenAI.ScrollParam

Scroll

Uma ação de rolagem.

Name	Tipo	Description	Obrigatório	Predefinição
keys	array de string ou nulo		No
scroll_x	número inteiro	A distância de rolagem horizontal.	Sim
scroll_y	número inteiro	A distância de rolagem vertical.	Sim
tipo	enumeração	Especifica o tipo de evento. Para uma ação de rolagem, essa propriedade é sempre definida como `scroll`. Valores possíveis: `scroll`	Sim	Pergaminho
x	número inteiro	A coordenada x onde ocorreu a rolagem.	Sim
y	número inteiro	A coordenada y onde ocorreu a rolagem.	Sim

OpenAI.SearchContentType

Property	Valor
Type	cadeia (de caracteres)
Valores	`text` `image`

OpenAI.SearchContextSizeT

Property	Valor
Type	cadeia (de caracteres)
Valores	`low` `medium` `high`

OpenAI.SkillReferenceParam

Name	Tipo	Description	Obrigatório	Predefinição
skill_id	cadeia (de caracteres)	O ID da competência referida. Restrições: minComprimento: 1, máximoComprimento: 64	Sim
tipo	enumeração	Faz referência a uma habilidade criada com o endpoint /v1/skills. Valores possíveis: `skill_reference`	Sim	skill_reference
versão	cadeia (de caracteres)	Versão opcional de habilidade. Use um número inteiro positivo ou 'mais recente'. Omitir por defeito.	No

OpenAI.ResumoTextoConteúdo

Texto resumo

Um texto resumo do modelo.

Name	Tipo	Description	Obrigatório	Predefinição
enviar SMS	cadeia (de caracteres)	Um resumo da saída do raciocínio do modelo até agora.	Sim
tipo	enumeração	O tipo do objeto. Sempre `summary_text`. Valores possíveis: `summary_text`	Sim	summary_text

OpenAI.TextContent

Conteúdo do Texto

Um conteúdo textual.

Name	Tipo	Description	Obrigatório	Predefinição
enviar SMS	cadeia (de caracteres)		Sim
tipo	enumeração	Valores possíveis: `text`	Sim	enviar SMS

OpenAI.TextResponseFormatConfiguration

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

O formato padrão é { "type": "text" } sem opções adicionais. Não recomendado para gpt-4o e modelos mais recentes: Configurar para { "type": "json_object" } ativar o modo JSON mais antigo, que garante que a mensagem gerada pelo modelo é JSON válida. O uso json_schema é preferível para modelos que o suportam.

Discriminador para OpenAI.TextResponseFormatConfiguration

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

Valor do tipo	Schema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextoFormatoRespostaConfiguraçãoRespostaFormatoTexto
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.TextResponseFormatConfigurationType		Sim

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Objeto JSON

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

OpenAI.TextoFormatoRespostaConfiguraçãoRespostaFormatoTexto

Texto

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

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

OpenAI.TextResponseFormatConfigurationType

Property	Valor
Type	cadeia (de caracteres)
Valores	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

Esquema JSON

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

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

OpenAI.Tool

Uma ferramenta que pode ser usada para gerar uma resposta.

Discriminador para OpenAI.Tool

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

Valor do tipo	Schema
`code_interpreter`	OpenAI.CodeInterpreterTool
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search`	OpenAI.WebSearchTool
`mcp`	OpenAI.MCPTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellToolParam
`shell`	OpenAI.FunctionShellToolParam
`custom`	OpenAI.CustomToolParam
`web_search_preview`	OpenAI.WebSearchPreviewTool
`apply_patch`	OpenAI.ApplyPatchToolParam
`computer`	OpenAI.ComputerTool
`namespace`	OpenAI.NamespaceToolParam
`tool_search`	OpenAI.ToolSearchToolParam

Name	Tipo	Description	Obrigatório	Predefinição
tipo	OpenAI.ToolType		Sim

OpenAI.ToolSearchExecutionType

Property	Valor
Type	cadeia (de caracteres)
Valores	`server` `client`

OpenAI.ToolSearchToolParam

Ferramenta de pesquisa de ferramentas

Configuração de pesquisa de ferramentas hospedadas ou BYOT para ferramentas diferidas.

Name	Tipo	Description	Obrigatório	Predefinição
descrição	string ou null		No
execução	OpenAI.ToolSearchExecutionType		No
parameters	OpenAI.EmptyModelParam ou null		No
tipo	enumeração	O tipo da ferramenta. Sempre `tool_search`. Valores possíveis: `tool_search`	Sim	tool_search

OpenAI.ToolType

Property	Valor
Type	cadeia (de caracteres)
Valores	`function` `file_search` `computer` `computer_use_preview` `web_search` `mcp` `code_interpreter` `image_generation` `local_shell` `shell` `custom` `namespace` `tool_search` `web_search_preview` `apply_patch`

OpenAI.TopLogProb

Probabilidade logarítmica superior

A probabilidade máxima do log de um token.

Name	Tipo	Obrigatório
bytes	array de inteiros	Sim
logprob	number	Sim
token	cadeia (de caracteres)	Sim

OpenAI.TypeParam

Type

Uma ação para digitar texto.

Name	Tipo	Description	Obrigatório	Predefinição
enviar SMS	cadeia (de caracteres)	O texto a ser digitado.	Sim
tipo	enumeração	Especifica o tipo de evento. Para uma ação de tipo, essa propriedade é sempre definida como `type`. Valores possíveis: `type`	Sim	tipo

OpenAI.UrlCitationBody

Citação URL

Uma citação para um recurso da Web usado para gerar uma resposta de modelo.

Name	Tipo	Description	Obrigatório	Predefinição
end_index	número inteiro	O índice do último caractere da citação de URL na mensagem.	Sim
start_index	número inteiro	O índice do primeiro caractere da citação de URL na mensagem.	Sim
Título	cadeia (de caracteres)	O título do recurso Web.	Sim
tipo	enumeração	O tipo de citação de URL. Sempre `url_citation`. Valores possíveis: `url_citation`	Sim	url_citation
url	string (uri)	O URL do recurso Web.	Sim

OpenAI.VectorStoreFileAttributes

Tipo: objeto

OpenAI.WaitParam

Wait

Uma ação de espera.

Name	Tipo	Description	Obrigatório	Predefinição
tipo	enumeração	Especifica o tipo de evento. Para uma ação de espera, esta propriedade é sempre definida como `wait`. Valores possíveis: `wait`	Sim	wait

OpenAI.WebSearchActionPesquisar

Encontrar ação

Tipo de ação "find_in_page": Procura um padrão dentro de uma página carregada.

Name	Tipo	Description	Obrigatório
padrão	cadeia (de caracteres)	O padrão ou texto a ser pesquisado dentro da página.	Sim
tipo	enumeração	O tipo de ação. Valores possíveis: `find_in_page`	Sim
url	string (uri)	A URL da página onde se procurou o padrão.	Sim

OpenAI.WebSearchActionOpenPage

Abrir Página Ação

Tipo de ação "open_page" - Abre um URL específico dos resultados da pesquisa.

Name	Tipo	Description	Obrigatório	Predefinição
tipo	enumeração	O tipo de ação. Valores possíveis: `open_page`	Sim
url	string ou null	O URL aberto pelo modelo.	No

OpenAI.WebSearchActionSearch

Ação de pesquisa

Tipo de ação "pesquisar" - Executa uma consulta de pesquisa na Web.

Name	Tipo	Description	Obrigatório
queries	array de strings	As consultas de pesquisa.	No
consulta	string (descontinuada)	[DEPRECIADO] A consulta de pesquisa.	Sim
sources	array de OpenAI.WebSearchActionSearchSources	As fontes usadas na busca.	No
tipo	enumeração	O tipo de ação. Valores possíveis: `search`	Sim

OpenAI.WebSearchActionSearchSources

Name	Tipo	Description	Obrigatório	Predefinição
tipo	enumeração	Valores possíveis: `url`	Sim
url	string (uri)		Sim

OpenAI.WebSearchAproximaçãoLocalização

Localização aproximada na pesquisa web

A localização aproximada do utilizador.

Name	Tipo	Description	Obrigatório	Predefinição
Cidade	string ou null		No
país	string ou null		No
região	string ou null		No
timezone	string ou null		No
tipo	enumeração	O tipo de aproximação de localização. Sempre `approximate`. Valores possíveis: `approximate`	Sim	aproximado

OpenAI.WebSearchPreviewTool

Pré-visualização da pesquisa web

Nota: web_search ainda não está disponível através do Azure OpenAI.

Name	Tipo	Description	Obrigatório	Predefinição
search_content_types	array de OpenAI.SearchContentType		No
tamanho_do_contexto_de_pesquisa	OpenAI.SearchContextSizeT		No
tipo	enumeração	O tipo da ferramenta de pesquisa na Web. Um de `web_search_preview` ou `web_search_preview_2025_03_11`. Valores possíveis: `web_search_preview`	Sim	web_search_preview
localização_do_utilizador	OpenAI.ApproximateLocation ou null		No

OpenAI.WebSearchTool

Pesquisa na Web

Nota: web_search ainda não está disponível através do Azure OpenAI.

Name	Tipo	Description	Obrigatório	Predefinição
filters	OpenAI.WebSearchToolFilters ou null		No
tamanho_do_contexto_de_pesquisa	enumeração	Orientação de alto nível para a quantidade de espaço na janela de contexto a ser usada para a pesquisa. Um de `low`, `medium`, ou `high`. `medium` é o padrão. Valores possíveis: `low`, `medium`, `high`	No	meio
tipo	enumeração	O tipo da ferramenta de pesquisa na Web. Um de `web_search` ou `web_search_2025_08_26`. Valores possíveis: `web_search`	Sim	pesquisa_web
localização_do_utilizador	OpenAI.WebSearchApproximateLocation ou null		No

OpenAI.WebSearchToolFilters

Name	Tipo	Description	Obrigatório	Predefinição
allowed_domains	array de string ou nulo		No

Last updated on 2026-07-10