Azure OpenAI respostas

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)

Criar resposta

POST {endpoint}/openai/v1/responses

Cria uma resposta de modelo.

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
em segundo plano	Booleano ou nulo		No
context_management	array de OpenAI.ContextManagementParam ou null	Configuração de gestão de contexto para este pedido.	No
conversa	OpenAI.ConversationParam ou null		No
include	array de OpenAI.IncludeEnum ou null		No
dados introduzidos	OpenAI.InputParam	Entradas de texto, imagem ou arquivo no modelo, usadas para gerar uma resposta. Saiba mais: - Entradas e saídas de texto - Entradas de imagem - Entradas de ficheiros - Estado de conversa - Chamada de função	No
instructions	string ou null		No
max_output_tokens	inteiro ou nulo		No
max_tool_calls	inteiro ou nulo		No
metadados	OpenAI.Metadata ou null		No
modelo	cadeia (de caracteres)	ID de modelo usado para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma vasta gama de modelos com diferentes capacidades e desempenhos características e faixas de preço. Consulte o guia de modelos para consultar e comparar os modelos disponíveis.	No
chamadas_de_ferramentas_em_paralelo	Booleano ou nulo		No
previous_response_id	string ou null		No
avisar	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis.	No
prompt_cache_key	cadeia (de caracteres)	Usado pela OpenAI para armazenar em cache respostas a pedidos semelhantes para otimizar as suas taxas de acesso. Substitui o `user` campo.	No
prompt_cache_retention	string ou null		No
reasoning	OpenAI.Raciocínio ou nulo		No
safety_identifier	cadeia (de caracteres)	Um identificador estável usado para ajudar a detetar utilizadores da sua aplicação que possam estar a violar as políticas de utilização da OpenAI. Os IDs devem ser uma cadeia que identifique de forma única cada utilizador, com um comprimento máximo de 64 caracteres. Recomendamos que faça hash no nome de utilizador ou endereço de email deles, para evitar que nos enviem qualquer informação identificativa. Restrições: maxComprimento: 64	No
armazenar	Booleano ou nulo		No
fluxo	Booleano ou nulo		No
stream_options	OpenAI.ResponseStreamOptions ou null		No
Temperatura	Número ou nulo		No
enviar SMS	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas Estruturadas	No
tool_choice	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. As duas categorias de ferramentas que você pode fornecer ao modelo são: - Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o funcionalidades do modelo, como pesquisa de arquivos. - Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame seu próprio código.	No
top_logprobs	inteiro ou nulo		No
top_p	Número ou nulo		No
truncation	string ou null		No
utilizador	string (descontinuada)	Este campo está a ser substituído por `safety_identifier` e `prompt_cache_key`. Use `prompt_cache_key` antes para manter as otimizações de cache. Um identificador estável para os seus utilizadores finais. Usado para aumentar as taxas de acerto na cache ao fazer melhor bucketing de pedidos semelhantes e para ajudar a OpenAI a detetar e prevenir abusos.	No

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	objecto
text/event-stream	objecto

Name	Tipo	Description	Obrigatório	Predefinição
em segundo plano	Booleano ou nulo		No
concluído_em	string ou null		No
content_filters	array of AzureContentFilterForResponsesAPI	O filtro de conteúdo resulta do RAI.	No
conversa	OpenAI.ConversationReference ou null		No
criado_em	inteiro (unixtime)	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Sim
erro	OpenAI.ResponseError ou null		Sim
id	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Sim
incomplete_details	OpenAI.ResponseIncompleteDetails ou null		Sim
instructions	string ou array de OpenAI.InputItem ou null		Sim
max_output_tokens	inteiro ou nulo		No
max_tool_calls	inteiro ou nulo		No
metadados	OpenAI.Metadata ou null		No
modelo	cadeia (de caracteres)	ID de modelo usado para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma vasta gama de modelos com diferentes capacidades e desempenhos características e faixas de preço. Consulte o guia de modelos para consultar e comparar os modelos disponíveis.	No
objecto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Sim
saída	array do OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Sim
output_text	string ou null		No
chamadas_de_ferramentas_em_paralelo	boolean	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
previous_response_id	string ou null		No
avisar	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis.	No
prompt_cache_key	cadeia (de caracteres)	Usado pela OpenAI para armazenar em cache respostas a pedidos semelhantes para otimizar as suas taxas de acesso. Substitui o `user` campo.	No
prompt_cache_retention	string ou null		No
reasoning	OpenAI.Raciocínio ou nulo		No
safety_identifier	cadeia (de caracteres)	Um identificador estável usado para ajudar a detetar utilizadores da sua aplicação que possam estar a violar as políticas de utilização da OpenAI. Os IDs devem ser uma cadeia que identifique de forma única cada utilizador, com um comprimento máximo de 64 caracteres. Recomendamos que faça hash no nome de utilizador ou endereço de email deles, para evitar que nos enviem qualquer informação identificativa. Restrições: maxComprimento: 64	No
estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
Temperatura	Número ou nulo		No
enviar SMS	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas Estruturadas	No
tool_choice	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. Suportamos as seguintes categorias de ferramentas: - Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. - Ferramentas MCP: Integrações com sistemas de terceiros através de servidores MCP personalizados ou conectores pré-definidos como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame o seu próprio código com argumentos fortemente tipados e saídas. Saiba mais sobre função a chamar. Também podes usar Ferramentas personalizadas para chamar o seu próprio código.	No
top_logprobs	inteiro ou nulo		No
top_p	Número ou nulo		No
truncation	string ou null		No
utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
utilizador	string (descontinuada)	Este campo está a ser substituído por `safety_identifier` e `prompt_cache_key`. Use `prompt_cache_key` antes para manter as otimizações de cache. Um identificador estável para os seus utilizadores finais. Usado para aumentar as taxas de acerto na cache ao fazer melhor bucketing de pedidos semelhantes e para ajudar a OpenAI a detetar e prevenir abusos.	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.

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.

Examples

Exemplo

Criar uma resposta de modelo

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

Obter resposta

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

Recupera uma resposta do modelo com a ID fornecida.

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.
response_id	caminho	Sim	cadeia (de caracteres)
incluir[]	consulta	No	matriz	Campos adicionais a incluir na resposta. Consulte o parâmetro include para criação de Resposta acima para mais informações.
fluxo	consulta	No	boolean	Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente à medida que são gerados usando eventos enviados pelo servidor. Serialização: explode: false
starting_after	consulta	No	inteiro (int32)	O número de sequência do evento após o qual começar a transmitir. Serialização: explode: false
include_obfuscation	consulta	No	boolean	Quando verdadeiro, a ofuscação do fluxo será ativada. A ofuscação de fluxo adiciona caracteres aleatórios a um campo em eventos delta em streaming, para normalizar os tamanhos da carga útil como uma mitigação contra certos ataques de canal lateral. Esses campos de ofuscação são incluídos por padrão, mas adicionam uma pequena quantidade de sobrecarga ao fluxo de dados. Você pode definir `include_obfuscation` como false para otimizar a largura de banda se confiar nos links de rede entre seu aplicativo e a API OpenAI. 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	objecto

Name	Tipo	Description	Obrigatório	Predefinição
em segundo plano	Booleano ou nulo		No
concluído_em	string ou null		No
content_filters	array of AzureContentFilterForResponsesAPI	O filtro de conteúdo resulta do RAI.	No
conversa	OpenAI.ConversationReference ou null		No
criado_em	inteiro (unixtime)	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Sim
erro	OpenAI.ResponseError ou null		Sim
id	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Sim
incomplete_details	OpenAI.ResponseIncompleteDetails ou null		Sim
instructions	string ou array de OpenAI.InputItem ou null		Sim
max_output_tokens	inteiro ou nulo		No
max_tool_calls	inteiro ou nulo		No
metadados	OpenAI.Metadata ou null		No
modelo	cadeia (de caracteres)	ID de modelo usado para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma vasta gama de modelos com diferentes capacidades e desempenhos características e faixas de preço. Consulte o guia de modelos para consultar e comparar os modelos disponíveis.	No
objecto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Sim
saída	array do OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Sim
output_text	string ou null		No
chamadas_de_ferramentas_em_paralelo	boolean	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
previous_response_id	string ou null		No
avisar	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis.	No
prompt_cache_key	cadeia (de caracteres)	Usado pela OpenAI para armazenar em cache respostas a pedidos semelhantes para otimizar as suas taxas de acesso. Substitui o `user` campo.	No
prompt_cache_retention	string ou null		No
reasoning	OpenAI.Raciocínio ou nulo		No
safety_identifier	cadeia (de caracteres)	Um identificador estável usado para ajudar a detetar utilizadores da sua aplicação que possam estar a violar as políticas de utilização da OpenAI. Os IDs devem ser uma cadeia que identifique de forma única cada utilizador, com um comprimento máximo de 64 caracteres. Recomendamos que faça hash no nome de utilizador ou endereço de email deles, para evitar que nos enviem qualquer informação identificativa. Restrições: maxComprimento: 64	No
estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
Temperatura	Número ou nulo		No
enviar SMS	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas Estruturadas	No
tool_choice	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. Suportamos as seguintes categorias de ferramentas: - Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. - Ferramentas MCP: Integrações com sistemas de terceiros através de servidores MCP personalizados ou conectores pré-definidos como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame o seu próprio código com argumentos fortemente tipados e saídas. Saiba mais sobre função a chamar. Também podes usar Ferramentas personalizadas para chamar o seu próprio código.	No
top_logprobs	inteiro ou nulo		No
top_p	Número ou nulo		No
truncation	string ou null		No
utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
utilizador	string (descontinuada)	Este campo está a ser substituído por `safety_identifier` e `prompt_cache_key`. Use `prompt_cache_key` antes para manter as otimizações de cache. Um identificador estável para os seus utilizadores finais. Usado para aumentar as taxas de acerto na cache ao fazer melhor bucketing de pedidos semelhantes e para ajudar a OpenAI a detetar e prevenir abusos.	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.

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.

Apagar resposta

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

Exclui uma resposta por 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.
response_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	enumeração	Valores possíveis: `True`	Sim
id	cadeia (de caracteres)		Sim
objecto	enumeração	Valores possíveis: `response.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.

Cancelar resposta

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

Cancela a resposta de um modelo com o ID indicado. Apenas respostas criadas com o parâmetro de fundo definido como true podem ser canceladas.

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.
response_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	Predefinição
em segundo plano	Booleano ou nulo		No
concluído_em	string ou null		No
content_filters	array of AzureContentFilterForResponsesAPI	O filtro de conteúdo resulta do RAI.	No
conversa	OpenAI.ConversationReference ou null		No
criado_em	inteiro (unixtime)	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Sim
erro	OpenAI.ResponseError ou null		Sim
id	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Sim
incomplete_details	OpenAI.ResponseIncompleteDetails ou null		Sim
instructions	string ou array de OpenAI.InputItem ou null		Sim
max_output_tokens	inteiro ou nulo		No
max_tool_calls	inteiro ou nulo		No
metadados	OpenAI.Metadata ou null		No
modelo	cadeia (de caracteres)	ID de modelo usado para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma vasta gama de modelos com diferentes capacidades e desempenhos características e faixas de preço. Consulte o guia de modelos para consultar e comparar os modelos disponíveis.	No
objecto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Sim
saída	array do OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Sim
output_text	string ou null		No
chamadas_de_ferramentas_em_paralelo	boolean	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
previous_response_id	string ou null		No
avisar	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis.	No
prompt_cache_key	cadeia (de caracteres)	Usado pela OpenAI para armazenar em cache respostas a pedidos semelhantes para otimizar as suas taxas de acesso. Substitui o `user` campo.	No
prompt_cache_retention	string ou null		No
reasoning	OpenAI.Raciocínio ou nulo		No
safety_identifier	cadeia (de caracteres)	Um identificador estável usado para ajudar a detetar utilizadores da sua aplicação que possam estar a violar as políticas de utilização da OpenAI. Os IDs devem ser uma cadeia que identifique de forma única cada utilizador, com um comprimento máximo de 64 caracteres. Recomendamos que faça hash no nome de utilizador ou endereço de email deles, para evitar que nos enviem qualquer informação identificativa. Restrições: maxComprimento: 64	No
estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
Temperatura	Número ou nulo		No
enviar SMS	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas Estruturadas	No
tool_choice	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. Suportamos as seguintes categorias de ferramentas: - Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. - Ferramentas MCP: Integrações com sistemas de terceiros através de servidores MCP personalizados ou conectores pré-definidos como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame o seu próprio código com argumentos fortemente tipados e saídas. Saiba mais sobre função a chamar. Também podes usar Ferramentas personalizadas para chamar o seu próprio código.	No
top_logprobs	inteiro ou nulo		No
top_p	Número ou nulo		No
truncation	string ou null		No
utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
utilizador	string (descontinuada)	Este campo está a ser substituído por `safety_identifier` e `prompt_cache_key`. Use `prompt_cache_key` antes para manter as otimizações de cache. Um identificador estável para os seus utilizadores finais. Usado para aumentar as taxas de acerto na cache ao fazer melhor bucketing de pedidos semelhantes e para ajudar a OpenAI a detetar e prevenir abusos.	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.

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.

Listar itens de entrada

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

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

Parâmetros de URI

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.
response_id	caminho	Sim	cadeia (de caracteres)
limit	consulta	No	inteiro (int32)	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o o padrão é 20. Serialização: explode: false
order	consulta	No	cadeia (de caracteres) Valores possíveis: `asc`, `desc`	Ordem de classificação pela marcação `created_at` de data e hora dos objetos. `asc` por ordem crescente e`desc` por ordem decrescente. Serialização: explode: false
depois	consulta	No	cadeia (de caracteres)	Um cursor para uso na paginação. `after` é um ID de objeto que define o seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada subsequente pode incluir after=obj_foo para obter a próxima página da lista. Serialização: explode: false
antes	consulta	No	cadeia (de caracteres)	Um cursor para uso na paginação. `before` é um ID de objeto que define o seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu a chamada subsequente pode incluir before=obj_foo para obter a página anterior da lista. 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.ResponseItemList

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`

AzureContentFilterBlocklistResult

Uma coleção de resultados de filtragem verdadeiros/falsos para listas de bloqueio personalizadas configuradas.

Name	Tipo	Description	Obrigatório	Predefinição
details	array de objetos	Os pares de IDs individuais da lista de bloqueio e se eles resultaram em uma ação de filtragem.	No
filtered	boolean	Um valor que indica se alguma das listas de bloqueio detalhadas resultou em uma ação de filtragem.	Sim

AzureContentFilterCompletionTextSpan

Uma representação de um segmento de texto de conclusão conforme utilizado nos resultados do filtro de conteúdo do Azure OpenAI.

Name	Tipo	Description	Obrigatório	Predefinição
completion_end_offset	inteiro (int32)	Deslocamento do primeiro ponto de código UTF32 que é excluído da extensão. Este campo é sempre igual a completion_start_offset para intervalos vazios. Este campo é sempre maior do que completion_start_offset para intervalos não vazios.	Sim
completion_start_offset	inteiro (int32)	Deslocamento do ponto de código UTF32 que inicia a extensão.	Sim

AzureContentFilterCompletionTextSpanDetectionResult

Name	Tipo	Description	Obrigatório
details	array of AzureContentFilterCompletionTextSpan	Informações detalhadas sobre os segmentos de texto de conclusão detetados.	Sim
detected	boolean	Se a categoria de conteúdo rotulada foi detetada no conteúdo.	Sim
filtered	boolean	Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim

AzureContentFilterCustomTopicResult

Uma coleção de resultados de filtragem verdadeiros/falsos para tópicos personalizados configurados.

Name	Tipo	Description	Obrigatório	Predefinição
details	array de objetos	Os pares de IDs de tópico individuais e se eles são detetados.	No
filtered	boolean	Um valor que indica se algum dos tópicos detalhados resultou em uma ação de filtragem.	Sim

AzureContentFilterDetectionResult

Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detetado e se o conteúdo foi filtrado.

Name	Tipo	Description	Obrigatório	Predefinição
detected	boolean	Se a categoria de conteúdo rotulada foi detetada no conteúdo.	Sim
filtered	boolean	Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim

AzureContentFilterForResponsesAPI

Name	Tipo	Description	Obrigatório
bloqueado	boolean	Indique se a resposta está bloqueada.	Sim
content_filter_offsets	AzureContentFilterResultOffsets		Sim
content_filter_results	AzureContentFilterResultsForResponsesAPI		Sim
└─ listas_de_bloqueio_personalizadas	AzureContentFilterBlocklistResult	Uma coleção de resultados de filtragem binária para listas de bloqueio personalizadas configuradas.	No
└─ temas_personalizados	AzureContentFilterCustomTopicResult	Uma coleção de resultados de filtragem binária para tópicos personalizados configurados.	No
└─ erro	objecto	Se presente, detalhes sobre um erro que impediu a filtragem de conteúdo de concluir sua avaliação.	No
└─ código	inteiro (int32)	Um código distinto, legível por máquina, associado ao erro.	Sim
└─ mensagem	cadeia (de caracteres)	Uma mensagem legível por humanos associada ao erro.	Sim
└─ ódio	AzureContentFilterSeverityResult	Uma categoria de filtro de conteúdo que pode referir-se a qualquer conteúdo que ataque ou use de forma pejorativa ou discriminatória linguagem com referência a uma pessoa ou grupo de identidade com base em certos atributos diferenciadores desses grupos incluindo, mas não se limitando a, raça, etnia, nacionalidade, identidade e expressão de género, orientação sexual, religião, estatuto de imigração, condição de capacidade, aparência pessoal e tamanho corporal.	No
└─ ataque indireto	AzureContentFilterDetectionResult	Um resultado de deteção que descreve ataques a sistemas alimentados por modelos de IA generativa que podem acontecer sempre Uma aplicação processa informação que não foi diretamente criada nem pelo programador da aplicação nem por O utilizador.	No
└─ Desbloqueio (jailbreak)	AzureContentFilterDetectionResult	Um resultado de deteção que descreve ataques de injeção por prompt do utilizador, onde utilizadores maliciosos exploram deliberadamente vulnerabilidades do sistema para provocar comportamentos não autorizados por parte do LLM. Isto pode levar a conteúdos inadequados geração ou violações de restrições impostas pelo sistema.	Sim
└─ personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Um resultado de deteção que descreve correspondências com Informação Pessoal Identificável com subcategorias configuráveis.	No
└─ palavrões	AzureContentFilterDetectionResult	Um resultado de deteção que identifica se está presente linguagem grosseira, vulgar ou de outra forma de objeção no contente.	No
└─ protected_material_code	objecto	Um resultado de deteção que descreve uma correspondência com o código licenciado ou outro material de origem protegido.	No
└─ citação	objecto	Se disponível, os detalhes da citação descrevendo a licença associada e sua localização.	No
└─ URL	string (uri)	O URL associado à licença.	No
└─ licença	cadeia (de caracteres)	O nome ou identificador da licença associada à deteção.	No
└─ Detetado	boolean	Se a categoria de conteúdo rotulada foi detetada no conteúdo.	Sim
└─ filtrado	boolean	Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
└─ protected_material_text	AzureContentFilterDetectionResult	Um resultado de deteção que descreve uma correspondência contra texto protegido por direitos de autor ou outro estatuto.	No
└─ autolesão	AzureContentFilterSeverityResult	Uma categoria de filtro de conteúdo que descreve linguagem relacionada com ações físicas destinadas a magoar, ferir intencionalmente, Danificar o corpo ou suicidar-se.	No
└─ sexual	AzureContentFilterSeverityResult	Uma categoria de filtro de conteúdo para linguagem relacionada com órgãos anatómicos e genitais, relações românticas, atos retratado em termos eróticos ou carinhosos, gravidez, atos sexuais físicos, incluindo aqueles retratados como um agressão ou um ato sexual violento forçado contra a própria vontade, prostituição, pornografia e abuso.	No
└─ task_adherence	AzureContentFilterDetectionResult	Um resultado de deteção que indica se o fluxo de execução ainda cumpre o plano.	Sim
└─ ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
└─ violência	AzureContentFilterSeverityResult	Uma categoria de filtro de conteúdo para linguagem relacionada com ações físicas destinadas a ferir, ferir, danificar ou matar alguém ou algo; descreve armas, armas e entidades relacionadas, como fabricantes, associações, legislação, e assim sucessivamente.	No
source_type	cadeia (de caracteres)	O nome do tipo de origem da mensagem.	Sim
tool_call_id	cadeia (de caracteres)	O ID da chamada de ferramenta associada a este filtro de conteúdo resulta, se aplicável.	No

AzureFiltroDeConteúdoResultadoDeInformaçãoPessoalmenteIdentificável

Um resultado de deteção de filtro de conteúdo para Informações Pessoalmente Identificáveis que inclui extensões de risco.

Name	Tipo	Description	Obrigatório
detected	boolean	Se a categoria de conteúdo rotulada foi detetada no conteúdo.	Sim
filtered	boolean	Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
redacted_text	cadeia (de caracteres)	O texto editado com informações de PII removidas ou mascaradas.	No
subcategorias	array de AzurePiiSubCategoryResult	Resultados detalhados para cada subcategoria(s) PIIHarm.	No

AzureContentFilterResultOffsets

Name	Tipo	Obrigatório
check_offset	inteiro (int32)	Sim
end_offset	inteiro (int32)	Sim
start_offset	inteiro (int32)	Sim

AzureContentFilterResultsForResponsesAPI

Name	Tipo	Description	Obrigatório
custom_blocklists	AzureContentFilterBlocklistResult	Uma coleção de resultados de filtragem verdadeiros/falsos para listas de bloqueio personalizadas configuradas.	No
└─ detalhes	array de objetos	Os pares de IDs individuais da lista de bloqueio e se eles resultaram em uma ação de filtragem.	No
└─ filtrado	boolean	Um valor que indica se a lista de bloqueio produziu uma ação de filtragem.	Sim
└─ ID	cadeia (de caracteres)	O ID da lista de bloqueio personalizada avaliado.	Sim
└─ filtrado	boolean	Um valor que indica se alguma das listas de bloqueio detalhadas resultou em uma ação de filtragem.	Sim
tópicos_personalizados	AzureContentFilterCustomTopicResult	Uma coleção de resultados de filtragem verdadeiros/falsos para tópicos personalizados configurados.	No
└─ detalhes	array de objetos	Os pares de IDs de tópico individuais e se eles são detetados.	No
└─ Detetado	boolean	Um valor que indica se o tema é detetado.	Sim
└─ ID	cadeia (de caracteres)	O ID do tema personalizado avaliado.	Sim
└─ filtrado	boolean	Um valor que indica se algum dos tópicos detalhados resultou em uma ação de filtragem.	Sim
erro	objecto	Se presente, detalhes sobre um erro que impediu a filtragem de conteúdo de concluir sua avaliação.	No
└─ código	inteiro (int32)	Um código distinto, legível por máquina, associado ao erro.	Sim
└─ mensagem	cadeia (de caracteres)	Uma mensagem legível por humanos associada ao erro.	Sim
hate	AzureContentFilterSeverityResult	Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual a qualidade. O nível de severidade do conteúdo foi avaliado de acordo com a configuração do filtro de conteúdo para a categoria.	No
└─ filtrado	boolean	Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
└─ gravidade	enumeração	A gravidade rotulada do conteúdo. Valores possíveis: `safe`, `low`, `medium`, `high`	Sim
indirect_attack	AzureContentFilterDetectionResult	Um item rotulado do resultado do filtro de conteúdo que indica se o conteúdo foi detetado e filtrado.	No
└─ Detetado	boolean	Se a categoria de conteúdo rotulada foi detetada no conteúdo.	Sim
└─ filtrado	boolean	Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
jailbreak	AzureContentFilterDetectionResult	Um item rotulado do resultado do filtro de conteúdo que indica se o conteúdo foi detetado e filtrado.	Sim
└─ Detetado	boolean	Se a categoria de conteúdo rotulada foi detetada no conteúdo.	Sim
└─ filtrado	boolean	Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
informação pessoal identificável	AzureContentFilterPersonallyIdentifiableInformationResult	Um resultado de deteção de filtro de conteúdo para Informações Pessoalmente Identificáveis que inclui extensões de risco.	No
└─ redacted_text	cadeia (de caracteres)	O texto editado com informações de PII removidas ou mascaradas.	No
└─ sub_categorias	array de AzurePiiSubCategoryResult	Resultados detalhados para cada subcategoria(s) PIIHarm.	No
profanity	AzureContentFilterDetectionResult	Um item rotulado do resultado do filtro de conteúdo que indica se o conteúdo foi detetado e filtrado.	No
└─ Detetado	boolean	Se a categoria de conteúdo rotulada foi detetada no conteúdo.	Sim
└─ filtrado	boolean	Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
protected_material_code	objecto	Um resultado de deteção que descreve uma correspondência com o código licenciado ou outro material de origem protegido.	No
└─ citação	objecto	Se disponível, os detalhes da citação descrevendo a licença associada e sua localização.	No
└─ URL	string (uri)	O URL associado à licença.	No
└─ licença	cadeia (de caracteres)	O nome ou identificador da licença associada à deteção.	No
└─ Detetado	boolean	Se a categoria de conteúdo rotulada foi detetada no conteúdo.	Sim
└─ filtrado	boolean	Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
protected_material_text	AzureContentFilterDetectionResult	Um item rotulado do resultado do filtro de conteúdo que indica se o conteúdo foi detetado e filtrado.	No
└─ Detetado	boolean	Se a categoria de conteúdo rotulada foi detetada no conteúdo.	Sim
└─ filtrado	boolean	Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
self_harm	AzureContentFilterSeverityResult	Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual a qualidade. O nível de severidade do conteúdo foi avaliado de acordo com a configuração do filtro de conteúdo para a categoria.	No
└─ filtrado	boolean	Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
└─ gravidade	enumeração	A gravidade rotulada do conteúdo. Valores possíveis: `safe`, `low`, `medium`, `high`	Sim
sexual	AzureContentFilterSeverityResult	Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual a qualidade. O nível de severidade do conteúdo foi avaliado de acordo com a configuração do filtro de conteúdo para a categoria.	No
└─ filtrado	boolean	Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
└─ gravidade	enumeração	A gravidade rotulada do conteúdo. Valores possíveis: `safe`, `low`, `medium`, `high`	Sim
task_adherence	AzureContentFilterDetectionResult	Um item rotulado do resultado do filtro de conteúdo que indica se o conteúdo foi detetado e filtrado.	Sim
└─ Detetado	boolean	Se a categoria de conteúdo rotulada foi detetada no conteúdo.	Sim
└─ filtrado	boolean	Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
violence	AzureContentFilterSeverityResult	Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual a qualidade. O nível de severidade do conteúdo foi avaliado de acordo com a configuração do filtro de conteúdo para a categoria.	No
└─ filtrado	boolean	Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
└─ gravidade	enumeração	A gravidade rotulada do conteúdo. Valores possíveis: `safe`, `low`, `medium`, `high`	Sim

AzureContentFilterSeverityResult

Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.

Name	Tipo	Description	Obrigatório	Predefinição
filtered	boolean	Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
severity	enumeração	A gravidade rotulada do conteúdo. Valores possíveis: `safe`, `low`, `medium`, `high`	Sim

AzurePiiSubCategoryResult

Detalhes do resultado para cada PIIHarmSubCategory(s).

Name	Tipo	Description	Obrigatório
detected	boolean	Se a subcategoria de conteúdo rotulado foi detetada no conteúdo.	Sim
filtered	boolean	Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo para essa subcategoria.	Sim
redigido	boolean	Se o conteúdo foi editado para esta subcategoria.	Sim
sub_category	cadeia (de caracteres)	A Subcategoria PIIHarm que foi avaliada.	Sim

AzureToolApprovalRequest

Azure tool approval request

Um pedido de aprovação da ferramenta Azure na saída de resposta.

Name	Tipo	Description	Obrigatório
arguments	cadeia (de caracteres)	Uma cadeia de argumentos JSON para a ferramenta.	Sim
call_id	cadeia (de caracteres)	O ID da chamada de ferramenta que requer aprovação.	Sim
id	cadeia (de caracteres)	O ID único do pedido de aprovação.	Sim
etiqueta	cadeia (de caracteres)	O rótulo da ferramenta (por exemplo, 'remote_functions').	Sim
Nome	cadeia (de caracteres)	O nome da função da ferramenta (por exemplo, 'output_binding').	Sim
tipo	enumeração	O tipo do artigo. Sempre `tool_approval_request`. Valores possíveis: `tool_approval_request`	Sim

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

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

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

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

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

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

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

Instrução que descreve como criar um ficheiro através da ferramenta apply_patch.

Name	Tipo	Description	Obrigatório	Predefinição
Diff	cadeia (de caracteres)	É difícil candidatar-se.	Sim
caminho	cadeia (de caracteres)	Caminho do ficheiro a criar.	Sim
tipo	enumeração	Crie um novo ficheiro com o diff fornecido. Valores possíveis: `create_file`	Sim	create_file

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

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

Instrução que descreve como eliminar um ficheiro através da ferramenta apply_patch.

Name	Tipo	Description	Obrigatório	Predefinição
caminho	cadeia (de caracteres)	Caminho do ficheiro a eliminar.	Sim
tipo	enumeração	Apaga o ficheiro especificado. Valores possíveis: `delete_file`	Sim	delete_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.ApplyPatchFileOperation

Aplicar operação de patch

Uma das operações create_file, delete_file ou update_file aplicada via apply_patch.

Discriminador para OpenAI.ApplyPatchFileOperation

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

Valor do tipo	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

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

OpenAI.ApplyPatchFileOperationType

Property	Valor
Type	cadeia (de caracteres)
Valores	`create_file` `delete_file` `update_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.ApplyPatchUpdateFileOperation

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

Instrução que descreve como atualizar um ficheiro através da ferramenta apply_patch.

Name	Tipo	Description	Obrigatório	Predefinição
Diff	cadeia (de caracteres)	É difícil candidatar-se.	Sim
caminho	cadeia (de caracteres)	Caminho do ficheiro para atualizar.	Sim
tipo	enumeração	Atualize um ficheiro existente com o diferencial fornecido. Valores possíveis: `update_file`	Sim	update_file

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

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

Referência do Contentor

Representa um contentor criado com /v1/containers.

Name	Tipo	Description	Obrigatório	Predefinição
container_id	cadeia (de caracteres)		Sim
tipo	enumeração	O tipo de ambiente. Sempre `container_reference`. Valores possíveis: `container_reference`	Sim	container_reference

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

Name	Tipo	Description	Obrigatório	Predefinição
compact_threshold	inteiro ou nulo		No
tipo	cadeia (de caracteres)	O tipo de entrada de gestão de contexto. Atualmente, apenas a 'compactação' é suportada.	Sim

OpenAI.ConversationParam

A conversa a que esta resposta pertence. Os itens desta conversa são antecidados input_items para este pedido de resposta. Os itens de entrada e itens de saída desta resposta são automaticamente adicionados a esta conversa após a conclusão desta resposta.

Este componente pode ser um dos seguintes:

string
OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

Objeto de conversa

A conversa a que esta resposta pertence.

Name	Tipo	Description	Obrigatório	Predefinição
id	cadeia (de caracteres)	A identidade única da conversa.	Sim

OpenAI.ConversationReference

Conversação

A conversa a que esta resposta pertencia. Itens de entrada e de saída desta resposta foram automaticamente adicionados a esta conversa.

Name	Tipo	Description	Obrigatório	Predefinição
id	cadeia (de caracteres)	O ID único da conversa a que esta resposta estava associada.	Sim

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

Name	Tipo	Description	Obrigatório
em segundo plano	Booleano ou nulo		No
context_management	array de OpenAI.ContextManagementParam ou null	Configuração de gestão de contexto para este pedido.	No
conversa	OpenAI.ConversationParam ou null		No
include	array de OpenAI.IncludeEnum ou null		No
dados introduzidos	OpenAI.InputParam	Entradas de texto, imagem ou arquivo no modelo, usadas para gerar uma resposta. Saiba mais: - Entradas e saídas de texto - Entradas de imagem - Entradas de ficheiros - Estado de conversa - Chamada de função	No
instructions	string ou null		No
max_output_tokens	inteiro ou nulo		No
max_tool_calls	inteiro ou nulo		No
metadados	OpenAI.Metadata ou null		No
modelo	cadeia (de caracteres)	ID de modelo usado para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma vasta gama de modelos com diferentes capacidades e desempenhos características e faixas de preço. Consulte o guia de modelos para consultar e comparar os modelos disponíveis.	No
chamadas_de_ferramentas_em_paralelo	Booleano ou nulo		No
previous_response_id	string ou null		No
avisar	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis.	No
prompt_cache_key	cadeia (de caracteres)	Usado pela OpenAI para armazenar em cache respostas a pedidos semelhantes para otimizar as suas taxas de acesso. Substitui o `user` campo.	No
prompt_cache_retention	string ou null		No
reasoning	OpenAI.Raciocínio ou nulo		No
safety_identifier	cadeia (de caracteres)	Um identificador estável usado para ajudar a detetar utilizadores da sua aplicação que possam estar a violar as políticas de utilização da OpenAI. Os IDs devem ser uma cadeia que identifique de forma única cada utilizador, com um comprimento máximo de 64 caracteres. Recomendamos que faça hash no nome de utilizador ou endereço de email deles, para evitar que nos enviem qualquer informação identificativa. Restrições: maxComprimento: 64	No
armazenar	Booleano ou nulo		No
fluxo	Booleano ou nulo		No
stream_options	OpenAI.ResponseStreamOptions ou null		No
Temperatura	Número ou nulo		No
enviar SMS	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas Estruturadas	No
tool_choice	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. As duas categorias de ferramentas que você pode fornecer ao modelo são: - Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o funcionalidades do modelo, como pesquisa de arquivos. - Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame seu próprio código.	No
top_logprobs	inteiro ou nulo		No
top_p	Número ou nulo		No
truncation	string ou null		No
utilizador	string (descontinuada)	Este campo está a ser substituído por `safety_identifier` e `prompt_cache_key`. Use `prompt_cache_key` antes para manter as otimizações de cache. Um identificador estável para os seus utilizadores finais. Usado para aumentar as taxas de acerto na cache ao fazer melhor bucketing de pedidos semelhantes e para ajudar a OpenAI a detetar e prevenir abusos.	No

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

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

OpenAI.FunctionCallStatus

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

OpenAI.FunctionShellAction

Ação executiva da Shell

Executa um comando shell.

Name	Tipo	Obrigatório
Comandos	array de strings	Sim
max_output_length	inteiro ou nulo	Sim
timeout_ms (tempo limite em milissegundos)	inteiro ou nulo	Sim

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

Discriminador para OpenAI.FunctionShellCallEnvironment

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

Valor do tipo	Schema
`local`	OpenAI.LocalEnvironmentResource
`container_reference`	OpenAI.ContainerReferenceResource

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

OpenAI.FunctionShellCallEnvironmentType

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

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

Conteúdo de saída das chamadas de shell

O conteúdo de uma ferramenta shell chama a saída que foi emitida.

Name	Tipo	Description	Obrigatório
criado_por	cadeia (de caracteres)	O identificador do ator que criou o item.	No
Resultado	OpenAI.FunçãoShellChamadaSaídaResultado	Representa ou um resultado de saída (com um código de saída) ou um resultado de timeout para um bloco de saída de chamada shell.	Sim
└─ tipo	OpenAI.FunctionShellCallOutputOutcomeType		Sim
Stderr	cadeia (de caracteres)	A saída padrão de erro que foi capturada.	Sim
stdout	cadeia (de caracteres)	A saída padrão que foi capturada.	Sim

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.FunçãoChamadaSaídaSaídaResultado

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	Sair do código do processo shell.	Sim
tipo	enumeração	O tipo de resultado. Sempre `exit`. Valores possíveis: `exit`	Sim	sair

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.FunçãoShellChamadaSaídaResultado

Resultado da chamada shell

Representa ou um resultado de saída (com um código de saída) ou um resultado de timeout para um bloco de saída de chamada shell.

Discriminador para OpenAI.FunçãoShellChamadaSaídaResultado

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

Valor do tipo	Schema
`timeout`	OpenAI.FunçãoShellChamadaSaídaTempoSaídaResultado
`exit`	OpenAI.FunçãoChamadaSaídaSaídaResultado

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

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

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

OpenAI.FunctionShellCallOutputStatusEnum

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

OpenAI.FunçãoShellChamadaSaídaTempoSaídaResultado

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

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

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

Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Os valores atualmente suportados são:

web_search_call.results: Inclua os resultados de pesquisa da ferramenta de pesquisa web chamada.
web_search_call.action.sources: Inclua as fontes da chamada da ferramenta de pesquisa web.
code_interpreter_call.outputs: Inclui as saídas da execução de código python em itens de chamada da ferramenta interpretadora de código.
computer_call_output.output.image_url: Inclua URLs de imagens dos resultados da chamada no computador.
file_search_call.results: Inclua os resultados da ferramenta de pesquisa de arquivos na chamada de pesquisa.
message.input_image.image_url: Inclua URLs de imagem da mensagem de entrada.
message.output_text.logprobs: Inclua logprobs com as mensagens do assistente.
reasoning.encrypted_content: Inclui uma versão criptografada de tokens de raciocínio nas saídas de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em diálogos de várias interações ao utilizar a API de Respostas em modo sem estado (como quando o parâmetro store é definido como false ou quando uma organização está inscrita no programa de retenção de dados zero).

Property	Valor
Description	Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Os valores atualmente suportados são: - `web_search_call.results`: Inclua os resultados de pesquisa da ferramenta de pesquisa web chamada. - `web_search_call.action.sources`: Inclua as fontes da chamada da ferramenta de pesquisa web. - `code_interpreter_call.outputs`: Inclui as saídas da execução de código python em itens de chamada da ferramenta interpretadora de código. - `computer_call_output.output.image_url`: Inclua URLs de imagens da saída de chamada do computador. - `file_search_call.results`: Inclua nos resultados da pesquisa a chamada à ferramenta de pesquisa de arquivos. - `message.input_image.image_url`: Inclua urls de imagem da mensagem de entrada. - `message.output_text.logprobs`: Inclua logprobs com mensagens do assistente. - `reasoning.encrypted_content`: Inclui uma versão criptografada de tokens de raciocínio nas saídas de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em diálogos de várias interações ao utilizar a API de Respostas em modo sem estado (como quando o parâmetro `store` é definido como `false` ou quando uma organização está inscrita no programa de retenção de dados zero).
Type	cadeia (de caracteres)
Valores	`file_search_call.results` `web_search_call.results` `web_search_call.action.sources` `message.input_image.image_url` `computer_call_output.output.image_url` `code_interpreter_call.outputs` `reasoning.encrypted_content` `message.output_text.logprobs`

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

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

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.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
razão	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.InputParam

Entradas de texto, imagem ou arquivo no modelo, usadas para gerar uma resposta. Saiba mais:

Entradas e saídas de texto
Entradas de imagem
Entradas de ficheiro
Estado da conversação
Chamada de função

Este componente pode ser um dos seguintes:

string
array

OpenAI.InputTextContent

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

Item de conteúdo usado para gerar uma resposta.

Discriminador de OpenAI.ItemResource

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

Valor do tipo	Schema
`message`	OpenAI.ItemResourceInputMessage
`output_message`	OpenAI.ItemResourceOutputMessage
`file_search_call`	OpenAI.ItemResourceFileSearchToolCall
`computer_call`	OpenAI.ItemResourceComputerToolCall
`computer_call_output`	OpenAI.ItemResourceComputerToolCallOutput
`web_search_call`	OpenAI.ItemResourceWebSearchToolCall
`function_call`	OpenAI.ItemResourceFunctionToolCall
`function_call_output`	OpenAI.ItemResourceFunctionToolCallOutput
`tool_search_call`	OpenAI.ItemResourceToolSearchCall
`tool_search_output`	OpenAI.ItemResourceToolSearchOutput
`reasoning`	OpenAI.ItemResourceReasoningItem
`compaction`	OpenAI.ItemResourceCompactionBody
`image_generation_call`	OpenAI.ItemResourceImageGenToolCall
`code_interpreter_call`	OpenAI.ItemResourceCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemResourceLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemResourceLocalShellToolCallOutput
`shell_call`	OpenAI.ItemResourceFunctionShellCall
`shell_call_output`	OpenAI.ItemResourceFunctionShellCallOutput
`apply_patch_call`	OpenAI.ItemResourceApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ItemResourceApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ItemResourceMcpListTools
`mcp_approval_request`	OpenAI.ItemResourceMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemResourceMcpApprovalResponseResource
`mcp_call`	OpenAI.ItemResourceMcpToolCall
`custom_tool_call`	OpenAI.ItemResourceCustomToolCallResource
`custom_tool_call_output`	OpenAI.ItemResourceCustomToolCallOutputResource

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

OpenAI.ItemResourceApplyPatchToolCall

Aplicar chamada de ferramenta de patch

Uma chamada de ferramenta que aplica diferenciais de ficheiros criando, eliminando ou atualizando ficheiros.

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.	Sim
criado_por	cadeia (de caracteres)	O ID da entidade que criou esta ferramenta chama.	No
id	cadeia (de caracteres)	O ID único da ferramenta de aplicação de patch chama. Preenchido quando este item é retornado via API.	Sim
operação	OpenAI.ApplyPatchFileOperation	Uma das operações create_file, delete_file ou update_file aplicada via apply_patch.	Sim
└─ tipo	OpenAI.ApplyPatchFileOperationType		Sim
estado	OpenAI.ApplyPatchCallStatus		Sim
tipo	enumeração	O tipo do artigo. Sempre `apply_patch_call`. Valores possíveis: `apply_patch_call`	Sim	apply_patch_call

OpenAI.ItemResourceApplyPatchToolCallOutput

Aplicar a saída da chamada de ferramenta de patch

A saída 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.	Sim
criado_por	cadeia (de caracteres)	O ID da entidade que criou esta ferramenta chama a saída.	No
id	cadeia (de caracteres)	O ID único da saída da chamada da ferramenta apply patch. Preenchido quando este item é retornado via API.	Sim
saída	string ou null		No
estado	OpenAI.ApplyPatchCallOutputStatus		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.ItemResourceCodeInterpreterToolCall

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

Item de compactação

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

Name	Tipo	Description	Obrigatório	Predefinição
criado_por	cadeia (de caracteres)	O identificador do ator que criou o item.	No
encrypted_content	cadeia (de caracteres)	O conteúdo encriptado produzido por compactação.	Sim
id	cadeia (de caracteres)	O ID único do item de compactação.	Sim
tipo	enumeração	O tipo do artigo. Sempre `compaction`. Valores possíveis: `compaction`	Sim	Compactação

OpenAI.ItemResourceComputerToolCall

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

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	As verificações de segurança comunicadas pela API que foram reconhecidas pelo desenvolvedor.	No
call_id	cadeia (de caracteres)	O ID da chamada de ferramenta de computador que produziu a saída.	Sim
id	String (só leitura)	O ID da saída da chamada da ferramenta de computador.	Sim
saída	OpenAI.ComputerScreenshotImage	Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.	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`	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.ItemResourceCustomToolCallOutputResource

RespostaCustomToolCallOutputItem

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
criado_por	cadeia (de caracteres)	O identificador do ator que criou o item.	No
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
estado	OpenAI.FunctionCallOutputStatusEnum		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.ItemResourceCustomToolCallResource

RespostaToolCustomCallItem

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
criado_por	cadeia (de caracteres)	O identificador do ator que criou o item.	No
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
estado	OpenAI.FunctionCallStatus		Sim
tipo	enumeração	O tipo de chamada de ferramenta personalizada. Sempre `custom_tool_call`. Valores possíveis: `custom_tool_call`	Sim

OpenAI.ItemResourceFileSearchToolCall

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

Chamada de ferramenta shell

Uma chamada de ferramenta que executa um ou mais comandos de shell num ambiente gerido.

Name	Tipo	Description	Obrigatório	Predefinição
ação	OpenAI.FunctionShellAction	Executa um comando shell.	Sim
└─ comandos	array de strings		Sim
└─ max_output_length	inteiro ou nulo		Sim
└─ timeout_ms	inteiro ou nulo		Sim
call_id	cadeia (de caracteres)	O ID único da chamada da ferramenta shell gerada pelo modelo.	Sim
criado_por	cadeia (de caracteres)	O ID da entidade que criou esta ferramenta chama.	No
ambiente	OpenAI.FunctionShellCallEnvironment ou null		Sim
id	cadeia (de caracteres)	O ID único da chamada da ferramenta shell. Preenchido quando este item é retornado via API.	Sim
estado	OpenAI.FunctionShellCallStatus		Sim
tipo	enumeração	O tipo do artigo. Sempre `shell_call`. Valores possíveis: `shell_call`	Sim	shell_call

OpenAI.ItemResourceFunctionShellCallOutput

Saída de chamada de shell

A saída de uma chamada de ferramenta shell que foi emitida.

Name	Tipo	Description	Obrigatório	Predefinição
call_id	cadeia (de caracteres)	O ID único da chamada da ferramenta shell gerada pelo modelo.	Sim
criado_por	cadeia (de caracteres)	O identificador do ator que criou o item.	No
id	cadeia (de caracteres)	O ID único da saída da chamada shell. Preenchido quando este item é retornado via API.	Sim
max_output_length	inteiro ou nulo		Sim
saída	array de OpenAI.FunctionShellCallOutputContent	Um array de conteúdos de saída de chamadas de shell	Sim
estado	OpenAI.FunctionShellCallOutputStatusEnum		Sim
tipo	enumeração	O tipo de saída da chamada shell. Sempre `shell_call_output`. Valores possíveis: `shell_call_output`	Sim	shell_call_output

OpenAI.ItemResourceFunctionToolCall

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

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

A saída de uma chamada de ferramenta funcional.

Name	Tipo	Description	Obrigatório
call_id	cadeia (de caracteres)	O ID exclusivo da chamada da ferramenta funcional gerada pelo modelo.	Sim
id	String (só leitura)	O identificador exclusivo da saída de chamada da ferramenta de função. Populado quando este item é devolvido via API.	Sim
saída	string ou array de OpenAI.FunctionAndCustomToolCallOutput	A saída da chamada de função gerada pelo teu código. Pode ser uma cadeia de caracteres ou uma lista de conteúdos de saída.	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 da saída de chamada da ferramenta de função. Sempre `function_call_output`. Valores possíveis: `function_call_output`	Sim

OpenAI.ItemResourceImageGenToolCall

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

Mensagem de entrada

Name	Tipo	Description	Obrigatório	Predefinição
conteúdo	OpenAI.InputMessageContentList	Uma lista de um ou vários itens de entrada para o modelo, contendo conteúdos diferentes types.	Sim
id	String (só leitura)	O ID exclusivo da mensagem de entrada.	Sim
função	enumeração	A função da entrada de mensagem. Um de `user`, `system`, ou `developer`. Valores possíveis: `user`, `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 definido como `message`. Valores possíveis: `message`	Sim	mensagem

OpenAI.ItemResourceLocalShellToolCall

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

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

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

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	cadeia (de caracteres)	O ID único da resposta de aprovação	Sim
razão	string ou null		No
tipo	enumeração	O tipo do artigo. Sempre `mcp_approval_response`. Valores possíveis: `mcp_approval_response`	Sim

OpenAI.ItemResourceMcpListTools

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

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

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

Reasoning

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

Name	Tipo	Description	Obrigatório	Predefinição
arguments		Argumentos usados para a chamada de pesquisa de ferramenta.	Sim
call_id	string ou null		Sim
criado_por	cadeia (de caracteres)	O identificador do ator que criou o item.	No
execução	OpenAI.ToolSearchExecutionType		Sim
id	cadeia (de caracteres)	O ID único do item de pesquisa de ferramenta.	Sim
estado	OpenAI.FunctionCallStatus		Sim
tipo	enumeração	O tipo do artigo. Sempre `tool_search_call`. Valores possíveis: `tool_search_call`	Sim	tool_search_call

OpenAI.ItemResourceToolSearchOutput

Name	Tipo	Description	Obrigatório	Predefinição
call_id	string ou null		Sim
criado_por	cadeia (de caracteres)	O identificador do ator que criou o item.	No
execução	OpenAI.ToolSearchExecutionType		Sim
id	cadeia (de caracteres)	O ID único do item de pesquisa da ferramenta.	Sim
estado	OpenAI.FunctionCallOutputStatusEnum		Sim
tools	array do OpenAI.Tool	As definições de ferramentas carregadas são devolvidas pela pesquisa de ferramentas.	Sim
tipo	enumeração	O tipo do artigo. Sempre `tool_search_output`. Valores possíveis: `tool_search_output`	Sim	tool_search_output

OpenAI.ItemResourceType

Property Valor

Type cadeia (de caracteres)

OpenAI.ItemResourceWebSearchToolCall

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

Ambiente Local

Representa a utilização de um ambiente local para realizar ações de shell.

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

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

Discriminador para OpenAI.OutputContent

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

Valor do tipo	Schema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent
`reasoning_text`	OpenAI.OutputContentReasoningTextContent

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

OpenAI.OutputContentOutputTextContent

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

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

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

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

OpenAI.OutputItem

Discriminador para OpenAI.OutputItem

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

Valor do tipo	Schema
`output_message`	OpenAI.OutputItemOutputMessageOutput
`file_search_call`	OpenAI.OutputItemFicheiroPesquisaFerramenta
`function_call`	OpenAI.OutputItemFunctionToolCall
`function_call_output`	OpenAI.OutputItemFunctionToolCallOutput
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`computer_call_output`	OpenAI.OutputItemComputerToolCallOutput
`reasoning`	OpenAI.SaídaItemRaciocínioItem
`tool_search_call`	OpenAI.OutputItemToolSearchCall
`tool_search_output`	OpenAI.OutputItemToolSearchOutput
`compaction`	OpenAI.OutputItemCompactionBody
`image_generation_call`	OpenAI.OutputItemImageGenToolCall
`code_interpreter_call`	OpenAI.OutputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.OutputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.OutputItemLocalShellToolCallOutput
`shell_call`	OpenAI.OutputItemFunctionShellCall
`shell_call_output`	OpenAI.OutputItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.OutputItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.OutputItemApplyPatchToolCallOutput
`mcp_call`	OpenAI.OutputItemMcpToolCall
`mcp_list_tools`	OpenAI.OutputItemMcpListTools
`mcp_approval_request`	OpenAI.OutputItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.OutputItemMcpApprovalResponseResource
`custom_tool_call`	OpenAI.OutputItemCustomToolCallResource
`custom_tool_call_output`	OpenAI.OutputItemCustomToolCallOutputResource
`tool_approval_request`	AzureToolApprovalRequest

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

OpenAI.OutputItemApplyPatchToolCall

Aplicar chamada de ferramenta de patch

Uma chamada de ferramenta que aplica diferenciais de ficheiros criando, eliminando ou atualizando ficheiros.

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.	Sim
criado_por	cadeia (de caracteres)	O ID da entidade que criou esta ferramenta chama.	No
id	cadeia (de caracteres)	O ID único da ferramenta de aplicação de patch chama. Preenchido quando este item é retornado via API.	Sim
operação	OpenAI.ApplyPatchFileOperation	Uma das operações create_file, delete_file ou update_file aplicada via apply_patch.	Sim
└─ tipo	OpenAI.ApplyPatchFileOperationType		Sim
estado	OpenAI.ApplyPatchCallStatus		Sim
tipo	enumeração	O tipo do artigo. Sempre `apply_patch_call`. Valores possíveis: `apply_patch_call`	Sim	apply_patch_call

OpenAI.OutputItemApplyPatchToolCallOutput

Aplicar a saída da chamada de ferramenta de patch

A saída 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.	Sim
criado_por	cadeia (de caracteres)	O ID da entidade que criou esta ferramenta chama a saída.	No
id	cadeia (de caracteres)	O ID único da saída da chamada da ferramenta apply patch. Preenchido quando este item é retornado via API.	Sim
saída	string ou null		No
estado	OpenAI.ApplyPatchCallOutputStatus		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.OutputItemCodeInterpreterToolCall

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

Item de compactação

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

Name	Tipo	Description	Obrigatório	Predefinição
criado_por	cadeia (de caracteres)	O identificador do ator que criou o item.	No
encrypted_content	cadeia (de caracteres)	O conteúdo encriptado produzido por compactação.	Sim
id	cadeia (de caracteres)	O ID único do item de compactação.	Sim
tipo	enumeração	O tipo do artigo. Sempre `compaction`. Valores possíveis: `compaction`	Sim	Compactação

OpenAI.OutputItemComputerToolCall

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

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	As verificações de segurança comunicadas pela API que foram reconhecidas pelo desenvolvedor.	No
call_id	cadeia (de caracteres)	O ID da chamada de ferramenta de computador que produziu a saída.	Sim
id	String (só leitura)	O ID da saída da chamada da ferramenta de computador.	Sim
saída	OpenAI.ComputerScreenshotImage	Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.	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`	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.OutputItemCustomToolCallOutputResource

RespostaCustomToolCallOutputItem

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
criado_por	cadeia (de caracteres)	O identificador do ator que criou o item.	No
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
estado	OpenAI.FunctionCallOutputStatusEnum		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.OutputItemCustomToolCallResource

RespostaToolCustomCallItem

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
criado_por	cadeia (de caracteres)	O identificador do ator que criou o item.	No
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
estado	OpenAI.FunctionCallStatus		Sim
tipo	enumeração	O tipo de chamada de ferramenta personalizada. Sempre `custom_tool_call`. Valores possíveis: `custom_tool_call`	Sim

OpenAI.OutputItemFicheiroPesquisaFerramenta

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

Chamada de ferramenta shell

Uma chamada de ferramenta que executa um ou mais comandos de shell num ambiente gerido.

Name	Tipo	Description	Obrigatório	Predefinição
ação	OpenAI.FunctionShellAction	Executa um comando shell.	Sim
└─ comandos	array de strings		Sim
└─ max_output_length	inteiro ou nulo		Sim
└─ timeout_ms	inteiro ou nulo		Sim
call_id	cadeia (de caracteres)	O ID único da chamada da ferramenta shell gerada pelo modelo.	Sim
criado_por	cadeia (de caracteres)	O ID da entidade que criou esta ferramenta chama.	No
ambiente	OpenAI.FunctionShellCallEnvironment ou null		Sim
id	cadeia (de caracteres)	O ID único da chamada da ferramenta shell. Preenchido quando este item é retornado via API.	Sim
estado	OpenAI.FunctionShellCallStatus		Sim
tipo	enumeração	O tipo do artigo. Sempre `shell_call`. Valores possíveis: `shell_call`	Sim	shell_call

OpenAI.OutputItemFunctionShellCallOutput

Saída de chamada de shell

A saída de uma chamada de ferramenta shell que foi emitida.

Name	Tipo	Description	Obrigatório	Predefinição
call_id	cadeia (de caracteres)	O ID único da chamada da ferramenta shell gerada pelo modelo.	Sim
criado_por	cadeia (de caracteres)	O identificador do ator que criou o item.	No
id	cadeia (de caracteres)	O ID único da saída da chamada shell. Preenchido quando este item é retornado via API.	Sim
max_output_length	inteiro ou nulo		Sim
saída	array de OpenAI.FunctionShellCallOutputContent	Um array de conteúdos de saída de chamadas de shell	Sim
estado	OpenAI.FunctionShellCallOutputStatusEnum		Sim
tipo	enumeração	O tipo de saída da chamada shell. Sempre `shell_call_output`. Valores possíveis: `shell_call_output`	Sim	shell_call_output

OpenAI.OutputItemFunctionToolCall

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

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

A saída de uma chamada de ferramenta funcional.

Name	Tipo	Description	Obrigatório
call_id	cadeia (de caracteres)	O ID exclusivo da chamada da ferramenta funcional gerada pelo modelo.	Sim
id	String (só leitura)	O identificador exclusivo da saída de chamada da ferramenta de função. Populado quando este item é devolvido via API.	Sim
saída	string ou array de OpenAI.FunctionAndCustomToolCallOutput	A saída da chamada de função gerada pelo teu código. Pode ser uma cadeia de caracteres ou uma lista de conteúdos de saída.	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 da saída de chamada da ferramenta de função. Sempre `function_call_output`. Valores possíveis: `function_call_output`	Sim

OpenAI.OutputItemImageGenToolCall

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

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

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

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

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	cadeia (de caracteres)	O ID único da resposta de aprovação	Sim
razão	string ou null		No
tipo	enumeração	O tipo do artigo. Sempre `mcp_approval_response`. Valores possíveis: `mcp_approval_response`	Sim

OpenAI.OutputItemMcpListTools

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

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

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.SaídaItemRaciocínioItem

Reasoning

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

Name	Tipo	Description	Obrigatório	Predefinição
arguments		Argumentos usados para a chamada de pesquisa de ferramenta.	Sim
call_id	string ou null		Sim
criado_por	cadeia (de caracteres)	O identificador do ator que criou o item.	No
execução	OpenAI.ToolSearchExecutionType		Sim
id	cadeia (de caracteres)	O ID único do item de pesquisa de ferramenta.	Sim
estado	OpenAI.FunctionCallStatus		Sim
tipo	enumeração	O tipo do artigo. Sempre `tool_search_call`. Valores possíveis: `tool_search_call`	Sim	tool_search_call

OpenAI.OutputItemToolSearchOutput

Name	Tipo	Description	Obrigatório	Predefinição
call_id	string ou null		Sim
criado_por	cadeia (de caracteres)	O identificador do ator que criou o item.	No
execução	OpenAI.ToolSearchExecutionType		Sim
id	cadeia (de caracteres)	O ID único do item de pesquisa da ferramenta.	Sim
estado	OpenAI.FunctionCallOutputStatusEnum		Sim
tools	array do OpenAI.Tool	As definições de ferramentas carregadas são devolvidas pela pesquisa de ferramentas.	Sim
tipo	enumeração	O tipo do artigo. Sempre `tool_search_output`. Valores possíveis: `tool_search_output`	Sim	tool_search_output

OpenAI.OutputItemType

Property Valor

Type cadeia (de caracteres)

Valores output_message
file_search_call
function_call
function_call_output
web_search_call
computer_call
computer_call_output
reasoning
tool_search_call
tool_search_output
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_call
mcp_list_tools
mcp_approval_request
mcp_approval_response
custom_tool_call
custom_tool_call_output
tool_approval_request

OpenAI.OutputItemWebSearchToolCall

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

Referência a um modelo de prompt e as suas variáveis.

Name	Tipo	Description	Obrigatório
id	cadeia (de caracteres)	O identificador exclusivo do modelo de prompt a ser usado.	Sim
variables	OpenAI.ResponsePromptVariables ou null		No
versão	string ou null		No

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

Reasoning

Apenas modelos GPT-5 e O-Series Opções de configuração para modelos de raciocínio.

Name	Tipo	Description	Obrigatório
effort	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
generate_summary	string ou null		No
resumo	string ou null		No

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

O objeto resposta

Name	Tipo	Description	Obrigatório	Predefinição
em segundo plano	Booleano ou nulo		No
concluído_em	string ou null		No
content_filters	array of AzureContentFilterForResponsesAPI	O filtro de conteúdo resulta do RAI.	No
conversa	OpenAI.ConversationReference ou null		No
criado_em	inteiro (unixtime)	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Sim
erro	OpenAI.ResponseError ou null		Sim
id	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Sim
incomplete_details	OpenAI.ResponseIncompleteDetails ou null		Sim
instructions	string ou array de OpenAI.InputItem ou null		Sim
max_output_tokens	inteiro ou nulo		No
max_tool_calls	inteiro ou nulo		No
metadados	OpenAI.Metadata ou null		No
modelo	cadeia (de caracteres)	ID de modelo usado para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma vasta gama de modelos com diferentes capacidades e desempenhos características e faixas de preço. Consulte o guia de modelos para consultar e comparar os modelos disponíveis.	No
objecto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Sim
saída	array do OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Sim
output_text	string ou null		No
chamadas_de_ferramentas_em_paralelo	boolean	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
previous_response_id	string ou null		No
avisar	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis.	No
prompt_cache_key	cadeia (de caracteres)	Usado pela OpenAI para armazenar em cache respostas a pedidos semelhantes para otimizar as suas taxas de acesso. Substitui o `user` campo.	No
prompt_cache_retention	string ou null		No
reasoning	OpenAI.Raciocínio ou nulo		No
safety_identifier	cadeia (de caracteres)	Um identificador estável usado para ajudar a detetar utilizadores da sua aplicação que possam estar a violar as políticas de utilização da OpenAI. Os IDs devem ser uma cadeia que identifique de forma única cada utilizador, com um comprimento máximo de 64 caracteres. Recomendamos que faça hash no nome de utilizador ou endereço de email deles, para evitar que nos enviem qualquer informação identificativa. Restrições: maxComprimento: 64	No
estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
Temperatura	Número ou nulo		No
enviar SMS	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas Estruturadas	No
tool_choice	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. Suportamos as seguintes categorias de ferramentas: - Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. - Ferramentas MCP: Integrações com sistemas de terceiros através de servidores MCP personalizados ou conectores pré-definidos como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame o seu próprio código com argumentos fortemente tipados e saídas. Saiba mais sobre função a chamar. Também podes usar Ferramentas personalizadas para chamar o seu próprio código.	No
top_logprobs	inteiro ou nulo		No
top_p	Número ou nulo		No
truncation	string ou null		No
utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
utilizador	string (descontinuada)	Este campo está a ser substituído por `safety_identifier` e `prompt_cache_key`. Use `prompt_cache_key` antes para manter as otimizações de cache. Um identificador estável para os seus utilizadores finais. Usado para aumentar as taxas de acerto na cache ao fazer melhor bucketing de pedidos semelhantes e para ajudar a OpenAI a detetar e prevenir abusos.	No

OpenAI.ResponseAudioDeltaEvent

Emitido quando há uma resposta de áudio parcial.

Name	Tipo	Description	Obrigatório
delta	cadeia (de caracteres)	Uma porção de dados de áudio da resposta codificados em Base64. Restrições: codificação: base64	Sim
sequence_number	número inteiro	Um número de sequência para esta parte da resposta do fluxo.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.audio.delta`. Valores possíveis: `response.audio.delta`	Sim

OpenAI.ResponseAudioDoneEvent

Emitido quando a resposta de áudio é concluída.

Name	Tipo	Description	Obrigatório	Predefinição
sequence_number	número inteiro	O número de sequência do delta.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.audio.done`. Valores possíveis: `response.audio.done`	Sim

OpenAI.ResponseAudioTranscriptDeltaEvent

Emitido quando há uma transcrição parcial do áudio.

Name	Tipo	Description	Obrigatório
delta	cadeia (de caracteres)	A transcrição parcial da resposta de áudio.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.audio.transcript.delta`. Valores possíveis: `response.audio.transcript.delta`	Sim

OpenAI.ResponseAudioTranscriptDoneEvento

Emitido quando a transcrição completa do áudio é concluída.

Name	Tipo	Description	Obrigatório	Predefinição
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.audio.transcript.done`. Valores possíveis: `response.audio.transcript.done`	Sim

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Emitido quando um trecho de código parcial é transmitido pelo interpretador de código.

Name	Tipo	Description	Obrigatório
delta	cadeia (de caracteres)	O trecho de código parcial a ser transmitido pelo interpretador de código.	Sim
item_id	cadeia (de caracteres)	O identificador exclusivo do item de chamada da ferramenta de interpretação de código.	Sim
output_index	número inteiro	O índice do item de saída na resposta para a qual o código está sendo transmitido.	Sim
sequence_number	número inteiro	O número de sequência deste evento era usado para ordenar os eventos de streaming.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.code_interpreter_call_code.delta`. Valores possíveis: `response.code_interpreter_call_code.delta`	Sim

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Emitido quando o trecho de código é finalizado pelo interpretador de código.

Name	Tipo	Description	Obrigatório
código	cadeia (de caracteres)	A saída final do trecho de código pelo interpretador de código.	Sim
item_id	cadeia (de caracteres)	O identificador exclusivo do item de chamada da ferramenta de interpretação de código.	Sim
output_index	número inteiro	O índice do item de saída na resposta para a qual o código é finalizado.	Sim
sequence_number	número inteiro	O número de sequência deste evento era usado para ordenar os eventos de streaming.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.code_interpreter_call_code.done`. Valores possíveis: `response.code_interpreter_call_code.done`	Sim

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Emitido quando a chamada do interpretador de código é concluída.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O identificador exclusivo do item de chamada da ferramenta de interpretação de código.	Sim
output_index	número inteiro	O índice do item de saída na resposta para a qual a chamada do interpretador de código é concluída.	Sim
sequence_number	número inteiro	O número de sequência deste evento era usado para ordenar os eventos de streaming.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.code_interpreter_call.completed`. Valores possíveis: `response.code_interpreter_call.completed`	Sim

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Emitido quando uma chamada de interpretador de código está em andamento.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O identificador exclusivo do item de chamada da ferramenta de interpretação de código.	Sim
output_index	número inteiro	O índice do item de saída na resposta para a qual a chamada do interpretador de código está em andamento.	Sim
sequence_number	número inteiro	O número de sequência deste evento era usado para ordenar os eventos de streaming.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.code_interpreter_call.in_progress`. Valores possíveis: `response.code_interpreter_call.in_progress`	Sim

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Emitido quando o interpretador de código está interpretando ativamente o trecho de código.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O identificador exclusivo do item de chamada da ferramenta de interpretação de código.	Sim
output_index	número inteiro	O índice do item de saída na resposta para a qual o interpretador de código está interpretando código.	Sim
sequence_number	número inteiro	O número de sequência deste evento era usado para ordenar os eventos de streaming.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.code_interpreter_call.interpreting`. Valores possíveis: `response.code_interpreter_call.interpreting`	Sim

OpenAI.ResponseCompletedEvent

Emitido quando a resposta do modelo está completa.

Name	Tipo	Description	Obrigatório	Predefinição
response	OpenAI.Response		Sim
└─ Antecedentes	Booleano ou nulo		No
└─ completed_at	string ou nulo (unixTimestamp)		No
└─ content_filters	array of AzureContentFilterForResponsesAPI	O filtro de conteúdo resulta do RAI.	No
└─ Conversa	OpenAI.ConversationReference ou null		No
└─ created_at	inteiro (unixtime)	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Sim
└─ erro	OpenAI.ResponseError ou null		Sim
└─ ID	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Sim
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails ou null		Sim
└─ instruções	string ou array de OpenAI.InputItem ou null		Sim
└─ max_output_tokens (limite máximo de tokens de saída)	inteiro ou nulo		No
└─ número_máximo_de_chamadas_da_ferramenta	inteiro ou nulo		No
└─ metadados	OpenAI.Metadata ou null		No
└─ modelo	cadeia (de caracteres)	ID de modelo usado para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma vasta gama de modelos com diferentes capacidades e desempenhos características e faixas de preço. Consulte o guia de modelos para consultar e comparar os modelos disponíveis.	No
└─ objeto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Sim
└─ saída	array do OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Sim
└─ texto_de_saida	string ou null		No
└─ chamadas_de_ferramentas_em_paralelo	boolean	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
└─ ID_de_resposta_anterior	string ou null		No
└─ Prompt	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis.	No
└─ prompt_cache_key	cadeia (de caracteres)	Usado pela OpenAI para armazenar em cache respostas a pedidos semelhantes para otimizar as suas taxas de acesso. Substitui o `user` campo.	No
└─ prompt_cache_retention	string ou null		No
└─ raciocínio	OpenAI.Raciocínio ou nulo		No
└─ safety_identifier	cadeia (de caracteres)	Um identificador estável usado para ajudar a detetar utilizadores da sua aplicação que possam estar a violar as políticas de utilização da OpenAI. Os IDs devem ser uma cadeia que identifique de forma única cada utilizador, com um comprimento máximo de 64 caracteres. Recomendamos que faça hash no nome de utilizador ou endereço de email deles, para evitar que nos enviem qualquer informação identificativa. Restrições: maxComprimento: 64	No
└─ estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└─ temperatura	Número ou nulo		No	1
└─ texto	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas Estruturadas	No
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
└─ Ferramentas	OpenAI.ToolsArray	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. Suportamos as seguintes categorias de ferramentas: - Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. - Ferramentas MCP: Integrações com sistemas de terceiros através de servidores MCP personalizados ou conectores pré-definidos como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame o seu próprio código com argumentos fortemente tipados e saídas. Saiba mais sobre função a chamar. Também podes usar Ferramentas personalizadas para chamar o seu próprio código.	No
└─ top_logprobs	inteiro ou nulo		No
└─ top_p	Número ou nulo		No	1
└─ truncamento	string ou null		No	desactivado
└─ utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ utilizador	string (descontinuada)	Este campo está a ser substituído por `safety_identifier` e `prompt_cache_key`. Use `prompt_cache_key` antes para manter as otimizações de cache. Um identificador estável para os seus utilizadores finais. Usado para aumentar as taxas de acerto na cache ao fazer melhor bucketing de pedidos semelhantes e para ajudar a OpenAI a detetar e prevenir abusos.	No
sequence_number	número inteiro	O número de série para este evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.completed`. Valores possíveis: `response.completed`	Sim

OpenAI.ResponseContentPartAddedEvent

Emitido quando uma nova parte de conteúdo é adicionada.

Name	Tipo	Description	Obrigatório
content_index	número inteiro	O índice da parte de conteúdo que foi adicionada.	Sim
item_id	cadeia (de caracteres)	A ID do item de saída ao qual a parte de conteúdo foi adicionada.	Sim
output_index	número inteiro	O índice do item de saída ao qual a parte de conteúdo foi adicionada.	Sim
part	OpenAI.OutputContent		Sim
└─ tipo	OpenAI.OutputContentType		Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.content_part.added`. Valores possíveis: `response.content_part.added`	Sim

OpenAI.ResponseContentPartDoneEvent

Emitido quando uma parte do conteúdo é concluída.

Name	Tipo	Description	Obrigatório
content_index	número inteiro	O índice do conteúdo da parte que está concluída.	Sim
item_id	cadeia (de caracteres)	A ID do item de saída ao qual a parte de conteúdo foi adicionada.	Sim
output_index	número inteiro	O índice do item de saída ao qual a parte de conteúdo foi adicionada.	Sim
part	OpenAI.OutputContent		Sim
└─ tipo	OpenAI.OutputContentType		Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.content_part.done`. Valores possíveis: `response.content_part.done`	Sim

OpenAI.ResponseCreatedEvent

Um evento que é emitido quando uma resposta é criada.

Name	Tipo	Description	Obrigatório	Predefinição
response	OpenAI.Response		Sim
└─ Antecedentes	Booleano ou nulo		No
└─ completed_at	string ou nulo (unixTimestamp)		No
└─ content_filters	array of AzureContentFilterForResponsesAPI	O filtro de conteúdo resulta do RAI.	No
└─ Conversa	OpenAI.ConversationReference ou null		No
└─ created_at	inteiro (unixtime)	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Sim
└─ erro	OpenAI.ResponseError ou null		Sim
└─ ID	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Sim
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails ou null		Sim
└─ instruções	string ou array de OpenAI.InputItem ou null		Sim
└─ max_output_tokens (limite máximo de tokens de saída)	inteiro ou nulo		No
└─ número_máximo_de_chamadas_da_ferramenta	inteiro ou nulo		No
└─ metadados	OpenAI.Metadata ou null		No
└─ modelo	cadeia (de caracteres)	ID de modelo usado para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma vasta gama de modelos com diferentes capacidades e desempenhos características e faixas de preço. Consulte o guia de modelos para consultar e comparar os modelos disponíveis.	No
└─ objeto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Sim
└─ saída	array do OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Sim
└─ texto_de_saida	string ou null		No
└─ chamadas_de_ferramentas_em_paralelo	boolean	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
└─ ID_de_resposta_anterior	string ou null		No
└─ Prompt	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis.	No
└─ prompt_cache_key	cadeia (de caracteres)	Usado pela OpenAI para armazenar em cache respostas a pedidos semelhantes para otimizar as suas taxas de acesso. Substitui o `user` campo.	No
└─ prompt_cache_retention	string ou null		No
└─ raciocínio	OpenAI.Raciocínio ou nulo		No
└─ safety_identifier	cadeia (de caracteres)	Um identificador estável usado para ajudar a detetar utilizadores da sua aplicação que possam estar a violar as políticas de utilização da OpenAI. Os IDs devem ser uma cadeia que identifique de forma única cada utilizador, com um comprimento máximo de 64 caracteres. Recomendamos que faça hash no nome de utilizador ou endereço de email deles, para evitar que nos enviem qualquer informação identificativa. Restrições: maxComprimento: 64	No
└─ estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└─ temperatura	Número ou nulo		No	1
└─ texto	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas Estruturadas	No
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
└─ Ferramentas	OpenAI.ToolsArray	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. Suportamos as seguintes categorias de ferramentas: - Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. - Ferramentas MCP: Integrações com sistemas de terceiros através de servidores MCP personalizados ou conectores pré-definidos como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame o seu próprio código com argumentos fortemente tipados e saídas. Saiba mais sobre função a chamar. Também podes usar Ferramentas personalizadas para chamar o seu próprio código.	No
└─ top_logprobs	inteiro ou nulo		No
└─ top_p	Número ou nulo		No	1
└─ truncamento	string ou null		No	desactivado
└─ utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ utilizador	string (descontinuada)	Este campo está a ser substituído por `safety_identifier` e `prompt_cache_key`. Use `prompt_cache_key` antes para manter as otimizações de cache. Um identificador estável para os seus utilizadores finais. Usado para aumentar as taxas de acerto na cache ao fazer melhor bucketing de pedidos semelhantes e para ajudar a OpenAI a detetar e prevenir abusos.	No
sequence_number	número inteiro	O número de série para este evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.created`. Valores possíveis: `response.created`	Sim

OpenAI.ResponseCustomToolCallInputDeltaEvent

ResponseCustomToolCallInputDelta

Evento que representa um delta (atualização parcial) na entrada de uma chamada de ferramenta personalizada.

Name	Tipo	Description	Obrigatório
delta	cadeia (de caracteres)	Os dados de entrada incrementais (delta) para a ferramenta personalizada chamam.	Sim
item_id	cadeia (de caracteres)	Identificador único para o item API associado a este evento.	Sim
output_index	número inteiro	O índice da saída a que este delta se aplica.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O identificador do tipo de evento. Valores possíveis: `response.custom_tool_call_input.delta`	Sim

OpenAI.ResponseCustomToolCallInputDoneEvento

RespostaFerramenta PersonalizadaChamadaInputFeita

Evento que indica que a entrada para uma chamada de ferramenta personalizada está concluída.

Name	Tipo	Description	Obrigatório
dados introduzidos	cadeia (de caracteres)	Os dados de entrada completos para a chamada de ferramenta personalizada.	Sim
item_id	cadeia (de caracteres)	Identificador único para o item API associado a este evento.	Sim
output_index	número inteiro	O índice da saída a que este evento se aplica.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O identificador do tipo de evento. Valores possíveis: `response.custom_tool_call_input.done`	Sim

OpenAI.ResponseError

Um objeto de erro retornado quando o modelo não consegue gerar uma resposta.

Name	Tipo	Description	Obrigatório	Predefinição
código	OpenAI.ResponseErrorCode	O código de erro para a resposta.	Sim
mensagem	cadeia (de caracteres)	Uma descrição do erro legível por humanos.	Sim

OpenAI.ResponseErrorCode

O código de erro para a resposta.

Property	Valor
Type	cadeia (de caracteres)
Valores	`server_error` `rate_limit_exceeded` `invalid_prompt` `vector_store_timeout` `invalid_image` `invalid_image_format` `invalid_base64_image` `invalid_image_url` `image_too_large` `image_too_small` `image_parse_error` `image_content_policy_violation` `invalid_image_mode` `image_file_too_large` `unsupported_image_media_type` `empty_image_file` `failed_to_download_image` `image_file_not_found`

OpenAI.ResponseErrorEvent

Emitido quando ocorre um erro.

Name	Tipo	Description	Obrigatório
código	string ou null		Sim
mensagem	cadeia (de caracteres)	A mensagem de erro.	Sim
param	string ou null		Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `error`. Valores possíveis: `error`	Sim

OpenAI.ResponseFailedEvent

Um evento que é emitido quando uma resposta falha.

Name	Tipo	Description	Obrigatório	Predefinição
response	OpenAI.Response		Sim
└─ Antecedentes	Booleano ou nulo		No
└─ completed_at	string ou nulo (unixTimestamp)		No
└─ content_filters	array of AzureContentFilterForResponsesAPI	O filtro de conteúdo resulta do RAI.	No
└─ Conversa	OpenAI.ConversationReference ou null		No
└─ created_at	inteiro (unixtime)	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Sim
└─ erro	OpenAI.ResponseError ou null		Sim
└─ ID	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Sim
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails ou null		Sim
└─ instruções	string ou array de OpenAI.InputItem ou null		Sim
└─ max_output_tokens (limite máximo de tokens de saída)	inteiro ou nulo		No
└─ número_máximo_de_chamadas_da_ferramenta	inteiro ou nulo		No
└─ metadados	OpenAI.Metadata ou null		No
└─ modelo	cadeia (de caracteres)	ID de modelo usado para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma vasta gama de modelos com diferentes capacidades e desempenhos características e faixas de preço. Consulte o guia de modelos para consultar e comparar os modelos disponíveis.	No
└─ objeto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Sim
└─ saída	array do OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Sim
└─ texto_de_saida	string ou null		No
└─ chamadas_de_ferramentas_em_paralelo	boolean	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
└─ ID_de_resposta_anterior	string ou null		No
└─ Prompt	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis.	No
└─ prompt_cache_key	cadeia (de caracteres)	Usado pela OpenAI para armazenar em cache respostas a pedidos semelhantes para otimizar as suas taxas de acesso. Substitui o `user` campo.	No
└─ prompt_cache_retention	string ou null		No
└─ raciocínio	OpenAI.Raciocínio ou nulo		No
└─ safety_identifier	cadeia (de caracteres)	Um identificador estável usado para ajudar a detetar utilizadores da sua aplicação que possam estar a violar as políticas de utilização da OpenAI. Os IDs devem ser uma cadeia que identifique de forma única cada utilizador, com um comprimento máximo de 64 caracteres. Recomendamos que faça hash no nome de utilizador ou endereço de email deles, para evitar que nos enviem qualquer informação identificativa. Restrições: maxComprimento: 64	No
└─ estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└─ temperatura	Número ou nulo		No	1
└─ texto	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas Estruturadas	No
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
└─ Ferramentas	OpenAI.ToolsArray	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. Suportamos as seguintes categorias de ferramentas: - Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. - Ferramentas MCP: Integrações com sistemas de terceiros através de servidores MCP personalizados ou conectores pré-definidos como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame o seu próprio código com argumentos fortemente tipados e saídas. Saiba mais sobre função a chamar. Também podes usar Ferramentas personalizadas para chamar o seu próprio código.	No
└─ top_logprobs	inteiro ou nulo		No
└─ top_p	Número ou nulo		No	1
└─ truncamento	string ou null		No	desactivado
└─ utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ utilizador	string (descontinuada)	Este campo está a ser substituído por `safety_identifier` e `prompt_cache_key`. Use `prompt_cache_key` antes para manter as otimizações de cache. Um identificador estável para os seus utilizadores finais. Usado para aumentar as taxas de acerto na cache ao fazer melhor bucketing de pedidos semelhantes e para ajudar a OpenAI a detetar e prevenir abusos.	No
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.failed`. Valores possíveis: `response.failed`	Sim

OpenAI.ResponseFileSearchCallCompletedEvent

Emitido quando uma chamada de pesquisa de arquivo é concluída (resultados encontrados).

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O ID do item de saída para o qual a chamada de pesquisa de arquivo é iniciada.	Sim
output_index	número inteiro	O índice do item de saída em que é iniciada a chamada de pesquisa no arquivo.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.file_search_call.completed`. Valores possíveis: `response.file_search_call.completed`	Sim

OpenAI.ResponseFileSearchCallInProgressEvent

Emitido quando uma chamada de pesquisa de arquivo é iniciada.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O ID do item de saída para o qual a chamada de pesquisa de arquivo é iniciada.	Sim
output_index	número inteiro	O índice do item de saída em que é iniciada a chamada de pesquisa no arquivo.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.file_search_call.in_progress`. Valores possíveis: `response.file_search_call.in_progress`	Sim

OpenAI.ResponseFileSearchCallSearchingEvent

Emitido quando uma pesquisa de arquivo está sendo pesquisada no momento.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O ID do item de saída para o qual a chamada de pesquisa de arquivo é iniciada.	Sim
output_index	número inteiro	O índice do item de saída que a chamada de pesquisa de arquivo está pesquisando.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.file_search_call.searching`. Valores possíveis: `response.file_search_call.searching`	Sim

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

Emitido quando há um delta parcial de argumentos de chamada de função.

Name	Tipo	Description	Obrigatório
delta	cadeia (de caracteres)	Os argumentos delta de chamada de função que são adicionados.	Sim
item_id	cadeia (de caracteres)	A ID do item de saída ao qual o delta de argumentos de chamada de função é adicionado.	Sim
output_index	número inteiro	O índice do item de saída ao qual é somado o delta dos argumentos de chamada de função.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.function_call_arguments.delta`. Valores possíveis: `response.function_call_arguments.delta`	Sim

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Emitido quando os argumentos de chamada de função são finalizados.

Name	Tipo	Description	Obrigatório
arguments	cadeia (de caracteres)	Os argumentos de chamada de função.	Sim
item_id	cadeia (de caracteres)	O identificador do item.	Sim
Nome	cadeia (de caracteres)	O nome da função que foi chamada.	Sim
output_index	número inteiro	O índice do item de saída.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	Valores possíveis: `response.function_call_arguments.done`	Sim

OpenAI.ResponseImageGenCallCompletedEvent

RespostaImageGenCallCompletedEventConcluído

Emitido quando uma chamada de ferramenta de geração de imagem é concluída e a imagem final está disponível.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O identificador exclusivo do item de geração de imagem que está sendo processado.	Sim
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre 'response.image_generation_call.completed'. Valores possíveis: `response.image_generation_call.completed`	Sim

OpenAI.ResponseImageGenCallGeneratingEvent

ResponseImageGenCallGeneratingEvent

Emitido quando uma chamada de ferramenta de geração de imagem está gerando ativamente uma imagem (estado intermediário).

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O identificador exclusivo do item de geração de imagem que está sendo processado.	Sim
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Sim
sequence_number	número inteiro	O número de sequência do item de geração de imagem que está a ser processado.	Sim
tipo	enumeração	O tipo de evento. Sempre 'response.image_generation_call.gerando'. Valores possíveis: `response.image_generation_call.generating`	Sim

OpenAI.ResponseImageGenCallInProgressEvent

RespostaImageGChamadaEmProgressoEvento

Emitido quando uma chamada de ferramenta de geração de imagem está em andamento.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O identificador exclusivo do item de geração de imagem que está sendo processado.	Sim
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Sim
sequence_number	número inteiro	O número de sequência do item de geração de imagem que está a ser processado.	Sim
tipo	enumeração	O tipo de evento. Sempre 'response.image_generation_call.in_progress'. Valores possíveis: `response.image_generation_call.in_progress`	Sim

OpenAI.ResponseImageGenCallPartialImageEvent

RespostaImageGeChamadaTPartialImageEvent

Emitido quando uma imagem parcial está disponível durante o streaming de geração de imagem.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O identificador exclusivo do item de geração de imagem que está sendo processado.	Sim
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Sim
partial_image_b64	cadeia (de caracteres)	Dados de imagem parciais codificados em Base64, adequados para renderização como uma imagem.	Sim
partial_image_index	número inteiro	índice baseado em 0 para a imagem parcial (backend é baseado em 1, mas este é baseado em 0 para o utilizador).	Sim
sequence_number	número inteiro	O número de sequência do item de geração de imagem que está a ser processado.	Sim
tipo	enumeração	O tipo de evento. Sempre 'response.image_generation_call.partial_image'. Valores possíveis: `response.image_generation_call.partial_image`	Sim

OpenAI.ResponseInProgressEvent

Emitido quando a resposta está em andamento.

Name	Tipo	Description	Obrigatório	Predefinição
response	OpenAI.Response		Sim
└─ Antecedentes	Booleano ou nulo		No
└─ completed_at	string ou nulo (unixTimestamp)		No
└─ content_filters	array of AzureContentFilterForResponsesAPI	O filtro de conteúdo resulta do RAI.	No
└─ Conversa	OpenAI.ConversationReference ou null		No
└─ created_at	inteiro (unixtime)	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Sim
└─ erro	OpenAI.ResponseError ou null		Sim
└─ ID	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Sim
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails ou null		Sim
└─ instruções	string ou array de OpenAI.InputItem ou null		Sim
└─ max_output_tokens (limite máximo de tokens de saída)	inteiro ou nulo		No
└─ número_máximo_de_chamadas_da_ferramenta	inteiro ou nulo		No
└─ metadados	OpenAI.Metadata ou null		No
└─ modelo	cadeia (de caracteres)	ID de modelo usado para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma vasta gama de modelos com diferentes capacidades e desempenhos características e faixas de preço. Consulte o guia de modelos para consultar e comparar os modelos disponíveis.	No
└─ objeto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Sim
└─ saída	array do OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Sim
└─ texto_de_saida	string ou null		No
└─ chamadas_de_ferramentas_em_paralelo	boolean	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
└─ ID_de_resposta_anterior	string ou null		No
└─ Prompt	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis.	No
└─ prompt_cache_key	cadeia (de caracteres)	Usado pela OpenAI para armazenar em cache respostas a pedidos semelhantes para otimizar as suas taxas de acesso. Substitui o `user` campo.	No
└─ prompt_cache_retention	string ou null		No
└─ raciocínio	OpenAI.Raciocínio ou nulo		No
└─ safety_identifier	cadeia (de caracteres)	Um identificador estável usado para ajudar a detetar utilizadores da sua aplicação que possam estar a violar as políticas de utilização da OpenAI. Os IDs devem ser uma cadeia que identifique de forma única cada utilizador, com um comprimento máximo de 64 caracteres. Recomendamos que faça hash no nome de utilizador ou endereço de email deles, para evitar que nos enviem qualquer informação identificativa. Restrições: maxComprimento: 64	No
└─ estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└─ temperatura	Número ou nulo		No	1
└─ texto	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas Estruturadas	No
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
└─ Ferramentas	OpenAI.ToolsArray	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. Suportamos as seguintes categorias de ferramentas: - Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. - Ferramentas MCP: Integrações com sistemas de terceiros através de servidores MCP personalizados ou conectores pré-definidos como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame o seu próprio código com argumentos fortemente tipados e saídas. Saiba mais sobre função a chamar. Também podes usar Ferramentas personalizadas para chamar o seu próprio código.	No
└─ top_logprobs	inteiro ou nulo		No
└─ top_p	Número ou nulo		No	1
└─ truncamento	string ou null		No	desactivado
└─ utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ utilizador	string (descontinuada)	Este campo está a ser substituído por `safety_identifier` e `prompt_cache_key`. Use `prompt_cache_key` antes para manter as otimizações de cache. Um identificador estável para os seus utilizadores finais. Usado para aumentar as taxas de acerto na cache ao fazer melhor bucketing de pedidos semelhantes e para ajudar a OpenAI a detetar e prevenir abusos.	No
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.in_progress`. Valores possíveis: `response.in_progress`	Sim

OpenAI.RespostaIncompletaDetalhes

Name	Tipo	Description	Obrigatório	Predefinição
razão	enumeração	Valores possíveis: `max_output_tokens`, `content_filter`	No

OpenAI.ResponseIncompleteEvent

Um evento que é emitido quando uma resposta termina como incompleta.

Name	Tipo	Description	Obrigatório	Predefinição
response	OpenAI.Response		Sim
└─ Antecedentes	Booleano ou nulo		No
└─ completed_at	string ou nulo (unixTimestamp)		No
└─ content_filters	array of AzureContentFilterForResponsesAPI	O filtro de conteúdo resulta do RAI.	No
└─ Conversa	OpenAI.ConversationReference ou null		No
└─ created_at	inteiro (unixtime)	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Sim
└─ erro	OpenAI.ResponseError ou null		Sim
└─ ID	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Sim
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails ou null		Sim
└─ instruções	string ou array de OpenAI.InputItem ou null		Sim
└─ max_output_tokens (limite máximo de tokens de saída)	inteiro ou nulo		No
└─ número_máximo_de_chamadas_da_ferramenta	inteiro ou nulo		No
└─ metadados	OpenAI.Metadata ou null		No
└─ modelo	cadeia (de caracteres)	ID de modelo usado para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma vasta gama de modelos com diferentes capacidades e desempenhos características e faixas de preço. Consulte o guia de modelos para consultar e comparar os modelos disponíveis.	No
└─ objeto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Sim
└─ saída	array do OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Sim
└─ texto_de_saida	string ou null		No
└─ chamadas_de_ferramentas_em_paralelo	boolean	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
└─ ID_de_resposta_anterior	string ou null		No
└─ Prompt	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis.	No
└─ prompt_cache_key	cadeia (de caracteres)	Usado pela OpenAI para armazenar em cache respostas a pedidos semelhantes para otimizar as suas taxas de acesso. Substitui o `user` campo.	No
└─ prompt_cache_retention	string ou null		No
└─ raciocínio	OpenAI.Raciocínio ou nulo		No
└─ safety_identifier	cadeia (de caracteres)	Um identificador estável usado para ajudar a detetar utilizadores da sua aplicação que possam estar a violar as políticas de utilização da OpenAI. Os IDs devem ser uma cadeia que identifique de forma única cada utilizador, com um comprimento máximo de 64 caracteres. Recomendamos que faça hash no nome de utilizador ou endereço de email deles, para evitar que nos enviem qualquer informação identificativa. Restrições: maxComprimento: 64	No
└─ estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└─ temperatura	Número ou nulo		No	1
└─ texto	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas Estruturadas	No
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
└─ Ferramentas	OpenAI.ToolsArray	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. Suportamos as seguintes categorias de ferramentas: - Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. - Ferramentas MCP: Integrações com sistemas de terceiros através de servidores MCP personalizados ou conectores pré-definidos como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame o seu próprio código com argumentos fortemente tipados e saídas. Saiba mais sobre função a chamar. Também podes usar Ferramentas personalizadas para chamar o seu próprio código.	No
└─ top_logprobs	inteiro ou nulo		No
└─ top_p	Número ou nulo		No	1
└─ truncamento	string ou null		No	desactivado
└─ utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ utilizador	string (descontinuada)	Este campo está a ser substituído por `safety_identifier` e `prompt_cache_key`. Use `prompt_cache_key` antes para manter as otimizações de cache. Um identificador estável para os seus utilizadores finais. Usado para aumentar as taxas de acerto na cache ao fazer melhor bucketing de pedidos semelhantes e para ajudar a OpenAI a detetar e prevenir abusos.	No
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.incomplete`. Valores possíveis: `response.incomplete`	Sim

OpenAI.ResponseItemList

Uma lista de itens de resposta.

Name	Tipo	Description	Obrigatório
dados	array de OpenAI.ItemResource	Uma lista de itens usados para gerar essa resposta.	Sim
first_id	cadeia (de caracteres)	A ID do primeiro item da lista.	Sim
tem_mais	boolean	Se há mais itens disponíveis.	Sim
last_id	cadeia (de caracteres)	A ID do último item da lista.	Sim
objecto	enumeração	O tipo de objeto retornado, deve ser `list`. Valores possíveis: `list`	Sim

OpenAI.ResponseLogProb

Um logprob é a probabilidade logarítmica que o modelo atribui à produção de um token particular numa posição dada na sequência. Valores de logprob menos negativos (mais altos) indicam maior confiança do modelo nessa escolha de token.

Name	Tipo	Description	Obrigatório
logprob	number	A probabilidade logarítmica deste token.	Sim
token	cadeia (de caracteres)	Um possível token de texto.	Sim
top_logprobs	array de OpenAI.ResponseLogProbTopLogprobs	As probabilidades logarítmicas de até 20 dos tokens mais prováveis.	No

OpenAI.ResponseLogProbTopLogprobs

Name	Tipo	Description	Obrigatório	Predefinição
logprob	number		No
token	cadeia (de caracteres)		No

OpenAI.ResponseMCPCallArgumentsDeltaEvent

RespostaMCPCtodosArgumentosDeltaEvento

Emitido quando há um delta (atualização parcial) para os argumentos de uma chamada de ferramenta MCP.

Name	Tipo	Description	Obrigatório
delta	cadeia (de caracteres)	Uma string JSON contendo a atualização parcial dos argumentos para a chamada de ferramenta MCP.	Sim
item_id	cadeia (de caracteres)	O identificador exclusivo do item de chamada da ferramenta MCP que está a ser processado.	Sim
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call_arguments.delta'. Valores possíveis: `response.mcp_call_arguments.delta`	Sim

OpenAI.ResponseMCPCallArgumentsDoneEvent

RespostaMCPCtodosArgumentosFeitoEvento

Emitido quando os argumentos para uma chamada de ferramenta MCP são finalizados.

Name	Tipo	Description	Obrigatório
arguments	cadeia (de caracteres)	Uma string JSON contendo os argumentos finais para a chamada da ferramenta MCP.	Sim
item_id	cadeia (de caracteres)	O identificador exclusivo do item de chamada da ferramenta MCP que está a ser processado.	Sim
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call_arguments. feito'. Valores possíveis: `response.mcp_call_arguments.done`	Sim

OpenAI.ResponseMCPCallCompletedEvent

ResponseMCPCallCompletedEvent

Emitido quando uma chamada de ferramenta MCP foi concluída com êxito.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O ID do item da chamada da ferramenta MCP que foi concluído.	Sim
output_index	número inteiro	O índice do item de saída que foi concluído.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call.completed'. Valores possíveis: `response.mcp_call.completed`	Sim

OpenAI.ResponseMCPCallFailedEvent

ResponseMCPCallFailedEvent

Emitido quando uma chamada de ferramenta MCP falhou.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O ID da ferramenta MCP chama o item que falhou.	Sim
output_index	número inteiro	O índice do item de saída que falhou.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call.failed'. Valores possíveis: `response.mcp_call.failed`	Sim

OpenAI.ResponseMCPCallInProgressEvent

ResponseMCPCallInProgressEvent

Emitido quando uma chamada de ferramenta MCP está em andamento.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O identificador exclusivo do item de chamada da ferramenta MCP que está a ser processado.	Sim
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call.in_progress'. Valores possíveis: `response.mcp_call.in_progress`	Sim

OpenAI.ResponseMCPListToolsCompletedEvent

ResponseMCPListToolsCompletedEvent

Emitido quando a lista de ferramentas MCP disponíveis foi recuperada com êxito.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O ID da ferramenta MCP chama o item que produziu esta saída.	Sim
output_index	número inteiro	O índice do item de saída que foi processado.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_list_tools.completed'. Valores possíveis: `response.mcp_list_tools.completed`	Sim

OpenAI.ResponseMCPListToolsFailedEvent

RespostaMCPListToolsFailedEvent

Emitido quando a tentativa de listar as ferramentas MCP disponíveis falhou.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O ID da ferramenta MCP chama o item que falhou.	Sim
output_index	número inteiro	O índice do item de saída que falhou.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_list_tools.failed'. Valores possíveis: `response.mcp_list_tools.failed`	Sim

OpenAI.ResponseMCPListToolsInProgressEvent

RespostaEventoMCPListToolsInProgressInProgress

Emitido quando o sistema está no processo de recuperação da lista de ferramentas MCP disponíveis.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	O ID da ferramenta MCP chama o item que está a ser processado.	Sim
output_index	número inteiro	O índice do item de saída que está a ser processado.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_list_tools.in_progress'. Valores possíveis: `response.mcp_list_tools.in_progress`	Sim

OpenAI.ResponseOutputItemAddedEvent

Emitido quando um novo item de saída é adicionado.

Name	Tipo	Description	Obrigatório
item	OpenAI.OutputItem		Sim
└─ tipo	OpenAI.OutputItemType		Sim
output_index	número inteiro	O índice do item de saída que foi adicionado.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.output_item.added`. Valores possíveis: `response.output_item.added`	Sim

OpenAI.ResponseOutputItemDoneEvent

Emitido quando um item de saída é marcado como concluído.

Name	Tipo	Description	Obrigatório
item	OpenAI.OutputItem		Sim
└─ tipo	OpenAI.OutputItemType		Sim
output_index	número inteiro	O índice do item de saída que foi marcado como concluído.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.output_item.done`. Valores possíveis: `response.output_item.done`	Sim

OpenAI.RespostaSaídaTextoAnotaçãoAcrescenteEvento

RespostaSaídaTextoAnotaçãoAcrescenteEvento

Emitido quando uma anotação é adicionada ao conteúdo de texto de saída.

Name	Tipo	Description	Obrigatório
anotação	OpenAI.Annotation	Uma anotação que se aplica a um espaço de texto de saída.	Sim
└─ tipo	OpenAI.AnnotationType		Sim
annotation_index	número inteiro	O índice da anotação dentro da parte de conteúdo.	Sim
content_index	número inteiro	O índice da parte de conteúdo dentro do item de saída.	Sim
item_id	cadeia (de caracteres)	O identificador único do item ao qual a anotação está a ser adicionada.	Sim
output_index	número inteiro	O índice do item de saída na matriz de saída da resposta.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre 'response.output_text.annotation.added'. Valores possíveis: `response.output_text.annotation.added`	Sim

OpenAI.ResponsePromptVariables

Variáveis de Prompt

Mapa opcional de valores para substituir variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros tipos de entrada de resposta, como imagens ou arquivos.

Tipo: objeto

OpenAI.ResponseQueuedEvent

ResponseFiledEvent

Emitido quando uma resposta está na fila e aguardando para ser processada.

Name	Tipo	Description	Obrigatório	Predefinição
response	OpenAI.Response		Sim
└─ Antecedentes	Booleano ou nulo		No
└─ completed_at	string ou nulo (unixTimestamp)		No
└─ content_filters	array of AzureContentFilterForResponsesAPI	O filtro de conteúdo resulta do RAI.	No
└─ Conversa	OpenAI.ConversationReference ou null		No
└─ created_at	inteiro (unixtime)	Marca de data/hora Unix (em segundos) de quando esta Resposta foi criada.	Sim
└─ erro	OpenAI.ResponseError ou null		Sim
└─ ID	cadeia (de caracteres)	Identificador exclusivo para esta resposta.	Sim
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails ou null		Sim
└─ instruções	string ou array de OpenAI.InputItem ou null		Sim
└─ max_output_tokens (limite máximo de tokens de saída)	inteiro ou nulo		No
└─ número_máximo_de_chamadas_da_ferramenta	inteiro ou nulo		No
└─ metadados	OpenAI.Metadata ou null		No
└─ modelo	cadeia (de caracteres)	ID de modelo usado para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma vasta gama de modelos com diferentes capacidades e desempenhos características e faixas de preço. Consulte o guia de modelos para consultar e comparar os modelos disponíveis.	No
└─ objeto	enumeração	O tipo de objeto deste recurso - sempre definido como `response`. Valores possíveis: `response`	Sim
└─ saída	array do OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a `output` ordem dos itens na matriz dependem na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e assumindo que é uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar usar a `output_text` propriedade onde suportado em SDKs.	Sim
└─ texto_de_saida	string ou null		No
└─ chamadas_de_ferramentas_em_paralelo	boolean	Se deve permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
└─ ID_de_resposta_anterior	string ou null		No
└─ Prompt	OpenAI.Prompt	Referência a um modelo de prompt e as suas variáveis.	No
└─ prompt_cache_key	cadeia (de caracteres)	Usado pela OpenAI para armazenar em cache respostas a pedidos semelhantes para otimizar as suas taxas de acesso. Substitui o `user` campo.	No
└─ prompt_cache_retention	string ou null		No
└─ raciocínio	OpenAI.Raciocínio ou nulo		No
└─ safety_identifier	cadeia (de caracteres)	Um identificador estável usado para ajudar a detetar utilizadores da sua aplicação que possam estar a violar as políticas de utilização da OpenAI. Os IDs devem ser uma cadeia que identifique de forma única cada utilizador, com um comprimento máximo de 64 caracteres. Recomendamos que faça hash no nome de utilizador ou endereço de email deles, para evitar que nos enviem qualquer informação identificativa. Restrições: maxComprimento: 64	No
└─ estado	enumeração	O estado da geração de resposta. Um dos `completed`, `failed`, `in_progress`, `cancelled`, `queued` ou `incomplete`. Valores possíveis: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└─ temperatura	Número ou nulo		No	1
└─ texto	OpenAI.ResponseTextParam	Opções de configuração para uma resposta de texto do modelo. Pode ser simples texto ou dados JSON estruturados. Saiba mais: - Entradas e saídas de texto - Saídas Estruturadas	No
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		No
└─ Ferramentas	OpenAI.ToolsArray	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o `tool_choice` parâmetro. Suportamos as seguintes categorias de ferramentas: - Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o Capacidades do modelo, como a pesquisa na web Ou pesquisa de ficheiros. Saiba mais sobre Ferramentas integradas. - Ferramentas MCP: Integrações com sistemas de terceiros através de servidores MCP personalizados ou conectores pré-definidos como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções que são definidas por você, permitindo que o modelo chame o seu próprio código com argumentos fortemente tipados e saídas. Saiba mais sobre função a chamar. Também podes usar Ferramentas personalizadas para chamar o seu próprio código.	No
└─ top_logprobs	inteiro ou nulo		No
└─ top_p	Número ou nulo		No	1
└─ truncamento	string ou null		No	desactivado
└─ utilização	OpenAI.ResponseUsage	Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ utilizador	string (descontinuada)	Este campo está a ser substituído por `safety_identifier` e `prompt_cache_key`. Use `prompt_cache_key` antes para manter as otimizações de cache. Um identificador estável para os seus utilizadores finais. Usado para aumentar as taxas de acerto na cache ao fazer melhor bucketing de pedidos semelhantes e para ajudar a OpenAI a detetar e prevenir abusos.	No
sequence_number	número inteiro	O número de série para este evento.	Sim
tipo	enumeração	O tipo de evento. Sempre 'response.queued'. Valores possíveis: `response.queued`	Sim

OpenAI.ResponseReasoningSummaryPartAddedEvent

Emitido quando é adicionada uma nova parte do resumo do raciocínio.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	A ID do item ao qual esta parte de resumo está associada.	Sim
output_index	número inteiro	O índice do item de saída ao qual esta parte de resumo está associada.	Sim
part	OpenAI.RespostaRaciocínioResumoParteAdicionadoEventoParte		Sim
└─ texto	cadeia (de caracteres)		Sim
└─ tipo	enumeração	Valores possíveis: `summary_text`	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
summary_index	número inteiro	O índice da parte sumária dentro da exposição de motivos.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_part.added`. Valores possíveis: `response.reasoning_summary_part.added`	Sim

OpenAI.RespostaRaciocínioResumoParteAdicionadoEventoParte

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

OpenAI.ResponseReasoningSummaryPartDoneEvent

Emitido quando uma parte sumária de raciocínio é concluída.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	A ID do item ao qual esta parte de resumo está associada.	Sim
output_index	número inteiro	O índice do item de saída ao qual esta parte de resumo está associada.	Sim
part	OpenAI.RespostaRaciocínioResumoParteFeitoEventoParte		Sim
└─ texto	cadeia (de caracteres)		Sim
└─ tipo	enumeração	Valores possíveis: `summary_text`	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
summary_index	número inteiro	O índice da parte sumária dentro da exposição de motivos.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_part.done`. Valores possíveis: `response.reasoning_summary_part.done`	Sim

OpenAI.RespostaRaciocínioResumoParteFeitoEventoParte

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

OpenAI.ResponseReasoningSummaryTextDeltaEvent

É emitido quando um delta é adicionado a um texto de resumo de raciocínio.

Name	Tipo	Description	Obrigatório
delta	cadeia (de caracteres)	O texto delta que foi adicionado ao resumo.	Sim
item_id	cadeia (de caracteres)	A ID do item ao qual este delta de texto de resumo está associado.	Sim
output_index	número inteiro	O índice do item de saída ao qual este delta de texto de resumo está associado.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
summary_index	número inteiro	O índice da parte sumária dentro da exposição de motivos.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_text.delta`. Valores possíveis: `response.reasoning_summary_text.delta`	Sim

OpenAI.ResponseReasoningSummaryTextDoneEvent

Emitido quando um texto de resumo de raciocínio é concluído.

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	A ID do item ao qual este texto de resumo está associado.	Sim
output_index	número inteiro	O índice do item de saída ao qual este texto de resumo está associado.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
summary_index	número inteiro	O índice da parte sumária dentro da exposição de motivos.	Sim
enviar SMS	cadeia (de caracteres)	Texto integral da exposição de motivos completa.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_text.done`. Valores possíveis: `response.reasoning_summary_text.done`	Sim

OpenAI.RespostaRaciocínioTextoDeltaEvento

Emitido quando um delta é adicionado a um texto de raciocínio.

Name	Tipo	Description	Obrigatório
content_index	número inteiro	O índice da parte do conteúdo de raciocínio a que esta delta está associada.	Sim
delta	cadeia (de caracteres)	O delta de texto que foi adicionado ao conteúdo de raciocínio.	Sim
item_id	cadeia (de caracteres)	O ID do item ao qual este delta de texto de raciocínio está associado.	Sim
output_index	número inteiro	O índice do item de saída ao qual este delta de texto de raciocínio está associado.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_text.delta`. Valores possíveis: `response.reasoning_text.delta`	Sim

OpenAI.RespostaRaciocínioTextoFeitoEvento

Emitido quando um texto de raciocínio é concluído.

Name	Tipo	Description	Obrigatório
content_index	número inteiro	A parte do índice do conteúdo de raciocínio.	Sim
item_id	cadeia (de caracteres)	O ID do item ao qual este texto de raciocínio está associado.	Sim
output_index	número inteiro	O índice do item de saída ao qual este texto de raciocínio está associado.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
enviar SMS	cadeia (de caracteres)	O texto completo do conteúdo de raciocínio concluído.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_text.done`. Valores possíveis: `response.reasoning_text.done`	Sim

OpenAI.ResponseRefusalDeltaEvent

Emitido quando há um texto de recusa parcial.

Name	Tipo	Description	Obrigatório
content_index	número inteiro	O índice da parte de conteúdo à qual o texto de recusa é adicionado.	Sim
delta	cadeia (de caracteres)	O texto de recusa que é adicionado.	Sim
item_id	cadeia (de caracteres)	A ID do item de saída ao qual o texto de recusa é adicionado.	Sim
output_index	número inteiro	O índice do item de saída ao qual o texto de recusa é adicionado.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.refusal.delta`. Valores possíveis: `response.refusal.delta`	Sim

OpenAI.ResponseRefusalDoneEvent

Emitido quando o texto de recusa é finalizado.

Name	Tipo	Description	Obrigatório
content_index	número inteiro	O índice da parte do conteúdo onde o texto de recusa é finalizado.	Sim
item_id	cadeia (de caracteres)	A ID do item de saída em que o texto de recusa é finalizado.	Sim
output_index	número inteiro	O índice do item de saída em que o texto de recusa é concluído.	Sim
refusal	cadeia (de caracteres)	O texto de recusa finalizado.	Sim
sequence_number	número inteiro	O número de sequência deste evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.refusal.done`. Valores possíveis: `response.refusal.done`	Sim

OpenAI.ResponseStreamEvent

Discriminador para OpenAI.ResponseStreamEvent

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

Valor do tipo	Schema
`response.audio.done`	OpenAI.ResponseAudioDoneEvent
`response.audio.transcript.delta`	OpenAI.ResponseAudioTranscriptDeltaEvent
`response.audio.transcript.done`	OpenAI.ResponseAudioTranscriptDoneEvento
`response.code_interpreter_call_code.delta`	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
`response.code_interpreter_call_code.done`	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
`response.code_interpreter_call.completed`	OpenAI.ResponseCodeInterpreterCallCompletedEvent
`response.code_interpreter_call.in_progress`	OpenAI.ResponseCodeInterpreterCallInProgressEvent
`response.code_interpreter_call.interpreting`	OpenAI.ResponseCodeInterpreterCallInterpretingEvent
`response.completed`	OpenAI.ResponseCompletedEvent
`response.content_part.added`	OpenAI.ResponseContentPartAddedEvent
`response.content_part.done`	OpenAI.ResponseContentPartDoneEvent
`response.created`	OpenAI.ResponseCreatedEvent
`response.custom_tool_call_input.delta`	OpenAI.ResponseCustomToolCallInputDeltaEvent
`response.custom_tool_call_input.done`	OpenAI.ResponseCustomToolCallInputDoneEvento
`error`	OpenAI.ResponseErrorEvent
`response.failed`	OpenAI.ResponseFailedEvent
`response.file_search_call.completed`	OpenAI.ResponseFileSearchCallCompletedEvent
`response.file_search_call.in_progress`	OpenAI.ResponseFileSearchCallInProgressEvent
`response.file_search_call.searching`	OpenAI.ResponseFileSearchCallSearchingEvent
`response.function_call_arguments.delta`	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
`response.function_call_arguments.done`	OpenAI.ResponseFunctionCallArgumentsDoneEvent
`response.image_generation_call.completed`	OpenAI.ResponseImageGenCallCompletedEvent
`response.image_generation_call.generating`	OpenAI.ResponseImageGenCallGeneratingEvent
`response.image_generation_call.in_progress`	OpenAI.ResponseImageGenCallInProgressEvent
`response.image_generation_call.partial_image`	OpenAI.ResponseImageGenCallPartialImageEvent
`response.in_progress`	OpenAI.ResponseInProgressEvent
`response.incomplete`	OpenAI.ResponseIncompleteEvent
`response.mcp_call_arguments.delta`	OpenAI.ResponseMCPCallArgumentsDeltaEvent
`response.mcp_call_arguments.done`	OpenAI.ResponseMCPCallArgumentsDoneEvent
`response.mcp_call.completed`	OpenAI.ResponseMCPCallCompletedEvent
`response.mcp_call.failed`	OpenAI.ResponseMCPCallFailedEvent
`response.mcp_call.in_progress`	OpenAI.ResponseMCPCallInProgressEvent
`response.mcp_list_tools.completed`	OpenAI.ResponseMCPListToolsCompletedEvent
`response.mcp_list_tools.failed`	OpenAI.ResponseMCPListToolsFailedEvent
`response.mcp_list_tools.in_progress`	OpenAI.ResponseMCPListToolsInProgressEvent
`response.output_item.added`	OpenAI.ResponseOutputItemAddedEvent
`response.output_item.done`	OpenAI.ResponseOutputItemDoneEvent
`response.output_text.annotation.added`	OpenAI.RespostaSaídaTextoAnotaçãoAcrescenteEvento
`response.queued`	OpenAI.ResponseQueuedEvent
`response.reasoning_summary_part.added`	OpenAI.ResponseReasoningSummaryPartAddedEvent
`response.reasoning_summary_part.done`	OpenAI.ResponseReasoningSummaryPartDoneEvent
`response.reasoning_summary_text.delta`	OpenAI.ResponseReasoningSummaryTextDeltaEvent
`response.reasoning_summary_text.done`	OpenAI.ResponseReasoningSummaryTextDoneEvent
`response.reasoning_text.delta`	OpenAI.RespostaRaciocínioTextoDeltaEvento
`response.reasoning_text.done`	OpenAI.RespostaRaciocínioTextoFeitoEvento
`response.refusal.delta`	OpenAI.ResponseRefusalDeltaEvent
`response.refusal.done`	OpenAI.ResponseRefusalDoneEvent
`response.output_text.delta`	OpenAI.ResponseTextDeltaEvent
`response.output_text.done`	OpenAI.ResponseTextDoneEvent
`response.web_search_call.completed`	OpenAI.ResponseWebSearchCallCompletedEvent
`response.web_search_call.in_progress`	OpenAI.ResponseWebSearchCallInProgressEvent
`response.web_search_call.searching`	OpenAI.ResponseWebSearchCallSearchingEvent
`response.audio.delta`	OpenAI.ResponseAudioDeltaEvent

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

OpenAI.ResponseStreamEventType

Property Valor

Type cadeia (de caracteres)

Valores response.audio.delta
response.audio.done
response.audio.transcript.delta
response.audio.transcript.done
response.code_interpreter_call_code.delta
response.code_interpreter_call_code.done
response.code_interpreter_call.completed
response.code_interpreter_call.in_progress
response.code_interpreter_call.interpreting
response.completed
response.content_part.added
response.content_part.done
response.created
error
response.file_search_call.completed
response.file_search_call.in_progress
response.file_search_call.searching
response.function_call_arguments.delta
response.function_call_arguments.done
response.in_progress
response.failed
response.incomplete
response.output_item.added
response.output_item.done
response.reasoning_summary_part.added
response.reasoning_summary_part.done
response.reasoning_summary_text.delta
response.reasoning_summary_text.done
response.reasoning_text.delta
response.reasoning_text.done
response.refusal.delta
response.refusal.done
response.output_text.delta
response.output_text.done
response.web_search_call.completed
response.web_search_call.in_progress
response.web_search_call.searching
response.image_generation_call.completed
response.image_generation_call.generating
response.image_generation_call.in_progress
response.image_generation_call.partial_image
response.mcp_call_arguments.delta
response.mcp_call_arguments.done
response.mcp_call.completed
response.mcp_call.failed
response.mcp_call.in_progress
response.mcp_list_tools.completed
response.mcp_list_tools.failed
response.mcp_list_tools.in_progress
response.output_text.annotation.added
response.queued
response.custom_tool_call_input.delta
response.custom_tool_call_input.done

OpenAI.ResponseStreamOptions

Opções para respostas em streaming. Defina isso apenas quando definir stream: true.

Name	Tipo	Description	Obrigatório	Predefinição
include_obfuscation	boolean	Quando verdadeiro, a ofuscação do fluxo será ativada. Ofuscação de fluxos adiciona personagens aleatórios para um `obfuscation` campo em streaming de eventos delta para normalizar o tamanho das cargas úteis como mitigação a certos ataques de canal lateral. Estes campos de ofuscação estão incluídos por defeito, mas acrescentam uma pequena quantidade de sobrecarga para o fluxo de dados. Podes definir `include_obfuscation` para false para otimizar a largura de banda se confiar nas ligações de rede entre a sua aplicação e a API OpenAI.	No

OpenAI.ResponseTextDeltaEvent

Emitido quando há um delta de texto adicional.

Name	Tipo	Description	Obrigatório
content_index	número inteiro	O índice da parte de conteúdo à qual foi adicionado o delta de texto.	Sim
delta	cadeia (de caracteres)	O texto delta que foi adicionado.	Sim
item_id	cadeia (de caracteres)	A ID do item de saída ao qual o delta de texto foi adicionado.	Sim
Logprobs	array de OpenAI.ResponseLogProb	As probabilidades logarítmicas dos tokens no delta.	Sim
output_index	número inteiro	O índice do item de saída ao qual o delta de texto foi adicionado.	Sim
sequence_number	número inteiro	O número de série para este evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.output_text.delta`. Valores possíveis: `response.output_text.delta`	Sim

OpenAI.ResponseTextDoneEvent

Emitido quando o conteúdo do texto é finalizado.

Name	Tipo	Description	Obrigatório
content_index	número inteiro	O índice da parte do conteúdo em que o texto é finalizado.	Sim
item_id	cadeia (de caracteres)	O ID do item de saída onde o conteúdo de texto foi finalizado.	Sim
Logprobs	array de OpenAI.ResponseLogProb	As probabilidades logarítmicas dos tokens no delta.	Sim
output_index	número inteiro	O índice do item de saída em que o conteúdo do texto é finalizado.	Sim
sequence_number	número inteiro	O número de série para este evento.	Sim
enviar SMS	cadeia (de caracteres)	Conteúdo do texto que foi finalizado.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.output_text.done`. Valores possíveis: `response.output_text.done`	Sim

OpenAI.ResponseTextParam

Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. Saiba mais:

Entradas e saídas de texto
Saídas estruturadas

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
verbosidade	OpenAI.Verbosity	Restringe a verbosidade da resposta do modelo. Valores mais baixos resultarão em respostas mais concisas, enquanto valores mais altos resultarão em respostas mais verbosas. Atualmente, os valores suportados são `low`, `medium`e `high`.	No

OpenAI.ResponseUsage

Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento de tokens de saída e o total de tokens usados.

Name	Tipo	Description	Obrigatório
input_tokens	número inteiro	O número de tokens de entrada.	Sim
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Sim
└─ tokens em cache	número inteiro		Sim
output_tokens	número inteiro	O número de tokens de saída.	Sim
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetalhes		Sim
└─ tokens de raciocínio	número inteiro		Sim
total_tokens	número inteiro	O número total de tokens usados.	Sim

OpenAI.ResponseUsageInputTokensDetails

Name	Tipo	Description	Obrigatório	Predefinição
cached_tokens	número inteiro		Sim

OpenAI.ResponseUsageOutputTokensDetalhes

Name	Tipo	Description	Obrigatório	Predefinição
fatores_de_razonamento	número inteiro		Sim

OpenAI.ResponseWebSearchCallCompletedEvent

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

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	ID exclusivo para o item de saída associado à chamada de pesquisa na Web.	Sim
output_index	número inteiro	O índice do item de saída ao qual a chamada de pesquisa na Web está associada.	Sim
sequence_number	número inteiro	O número de sequência da chamada de pesquisa na web a ser processada.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.web_search_call.completed`. Valores possíveis: `response.web_search_call.completed`	Sim

OpenAI.ResponseWebSearchCallInProgressEvent

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

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	ID exclusivo para o item de saída associado à chamada de pesquisa na Web.	Sim
output_index	número inteiro	O índice do item de saída ao qual a chamada de pesquisa na Web está associada.	Sim
sequence_number	número inteiro	O número de sequência da chamada de pesquisa na web a ser processada.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.web_search_call.in_progress`. Valores possíveis: `response.web_search_call.in_progress`	Sim

OpenAI.ResponseWebSearchCallSearchingEvent

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

Name	Tipo	Description	Obrigatório
item_id	cadeia (de caracteres)	ID exclusivo para o item de saída associado à chamada de pesquisa na Web.	Sim
output_index	número inteiro	O índice do item de saída ao qual a chamada de pesquisa na Web está associada.	Sim
sequence_number	número inteiro	O número de sequência da chamada de pesquisa na web a ser processada.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.web_search_call.searching`. Valores possíveis: `response.web_search_call.searching`	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.SpecificApplyPatchParam

Aplicação específica para a ferramenta de correção

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

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

OpenAI.FunctionSpecificShellParam

Escolha específica de ferramenta de concha

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

Name	Tipo	Description	Obrigatório	Predefinição
tipo	enumeração	A ferramenta para ligar. Sempre `shell`. Valores possíveis: `shell`	Sim	shell

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

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.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.EscolhaFerramenta Permitida

Ferramentas permitidas

Restringe as ferramentas disponíveis para o modelo a um conjunto pré-definido.

Name	Tipo	Description	Obrigatório
mode	enumeração	Restringe as ferramentas disponíveis para o modelo a um conjunto pré-definido. `auto` permite ao modelo escolher entre as ferramentas permitidas e gerar um Mensagem. `required` requer que o modelo chame uma ou mais das ferramentas permitidas. Valores possíveis: `auto`, `required`	Sim
tools	array de objetos	Uma lista de definições de ferramentas que o modelo deve poder chamar. Para a API Responses, a lista de definições de ferramentas pode ser a seguinte: `json<br> [ { "type": "function", "name": "get_weather" }, { "type": "mcp", "server_label": "deepwiki" }, { "type": "image_generation" } ]<br>`	Sim
tipo	enumeração	Tipo de configuração permitido da ferramenta. Sempre `allowed_tools`. Valores possíveis: `allowed_tools`	Sim

OpenAI.ToolChoiceCodeInterpreter

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

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

OpenAI.ToolChoiceComputer

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

Name	Tipo	Description	Obrigatório	Predefinição
tipo	enumeração	Valores possíveis: `computer`	Sim

OpenAI.EscolhaMáquinaComputadorUsar

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

Name	Tipo	Description	Obrigatório	Predefinição
tipo	enumeração	Valores possíveis: `computer_use`	Sim

OpenAI.ToolChoiceComputerUsePreview

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

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

OpenAI.ToolChoiceCustom

Ferramenta personalizada

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

Name	Tipo	Description	Obrigatório	Predefinição
Nome	cadeia (de caracteres)	O nome da ferramenta personalizada a chamar.	Sim
tipo	enumeração	Para chamadas de ferramentas personalizadas, o tipo é sempre `custom`. Valores possíveis: `custom`	Sim

OpenAI.ToolChoiceFileSearch

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

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

OpenAI.ToolChoiceFunction

Ferramenta funcional

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

Name	Tipo	Description	Obrigatório	Predefinição
Nome	cadeia (de caracteres)	O nome da função a ser chamada.	Sim
tipo	enumeração	Para chamada de função, o tipo é sempre `function`. Valores possíveis: `function`	Sim

OpenAI.ToolChoiceImageGeneration

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

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

OpenAI.ToolChoiceMCP

Ferramenta MCP

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

Name	Tipo	Description	Obrigatório
Nome	string ou null		No
rótulo de servidor	cadeia (de caracteres)	O rótulo do servidor MCP a ser usado.	Sim
tipo	enumeração	Para ferramentas MCP, o tipo é sempre `mcp`. Valores possíveis: `mcp`	Sim

OpenAI.ToolChoiceOptions

Modo de escolha de ferramenta

Controla qual (se houver) ferramenta é chamada pelo modelo. none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem. auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas. required significa que o modelo deve chamar uma ou mais ferramentas.

Property	Valor
Type	cadeia (de caracteres)
Valores	`none` `auto` `required`

OpenAI.ToolChoiceParam

Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o tools parâmetro para ver como especificar quais ferramentas o modelo pode chamar.

Discriminador para OpenAI.ToolChoiceParam

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

Valor do tipo	Schema
`allowed_tools`	OpenAI.EscolhaFerramenta Permitida
`mcp`	OpenAI.ToolChoiceMCP
`custom`	OpenAI.ToolChoiceCustom
`apply_patch`	OpenAI.SpecificApplyPatchParam
`shell`	OpenAI.FunctionSpecificShellParam
`file_search`	OpenAI.ToolChoiceFileSearch
`web_search_preview`	OpenAI.ToolChoiceWebSearchPreview
`computer_use_preview`	OpenAI.ToolChoiceComputerUsePreview
`web_search_preview_2025_03_11`	OpenAI.ToolChoiceWebSearchPreview20250311
`image_generation`	OpenAI.ToolChoiceImageGeneration
`code_interpreter`	OpenAI.ToolChoiceCodeInterpreter
`computer`	OpenAI.ToolChoiceComputer
`computer_use`	OpenAI.EscolhaMáquinaComputadorUsar
`function`	OpenAI.ToolChoiceFunction

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

OpenAI.ToolChoiceParamType

Property	Valor
Type	cadeia (de caracteres)
Valores	`allowed_tools` `function` `mcp` `custom` `apply_patch` `shell` `file_search` `web_search_preview` `computer_use_preview` `web_search_preview_2025_03_11` `image_generation` `code_interpreter` `computer` `computer_use`

OpenAI.ToolChoiceWebSearchPreview

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

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

OpenAI.ToolChoiceWebSearchPreview20250311

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

Name	Tipo	Description	Obrigatório	Predefinição
tipo	enumeração	Valores possíveis: `web_search_preview_2025_03_11`	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.ToolsArray

Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o tool_choice parâmetro. Suportamos as seguintes categorias de ferramentas:

Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem as capacidades do modelo, como pesquisa web ou pesquisa de ficheiros. Saiba mais sobre ferramentas integradas.
MCP Tools: Integrações com sistemas de terceiros através de servidores MCP personalizados ou conectores pré-definidos como Google Drive e SharePoint. Saiba mais sobre as Ferramentas MCP.
Chamadas de função (ferramentas personalizadas): Funções definidas por si, permitindo ao modelo chamar o seu próprio código com argumentos e saídas fortemente tipadas. Saiba mais sobre chamadas de função. Também pode usar ferramentas personalizadas para chamar o seu próprio código.

Conjunto de: OpenAI.Tool

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
title	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.Verbosity

Restringe a verbosidade da resposta do modelo. Valores mais baixos resultarão em respostas mais concisas, enquanto valores mais altos resultarão em respostas mais verbosas. Atualmente, os valores suportados são low, mediume high.

Property	Valor
Description	Restringe a verbosidade da resposta do modelo. Valores mais baixos resultarão em respostas mais concisas, enquanto valores mais altos resultarão em respostas mais verbosas. Atualmente, os valores suportados são `low`, `medium`e `high`.
Type	cadeia (de caracteres)
Valores	`low` `medium` `high`

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
Fontes	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