Respostas do Azure OpenAI

Versão da API: v1

Server:{endpoint}/openai/v1 — APIs Fábrica de IA do Azure Models

Variáveis de servidor:

Variable	Default	Description
ponto de extremidade		Um endpoint de APIs suportado pelo Fábrica de IA do Azure Models, incluindo protocolo e nome de host. Por exemplo: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).

Authentication

ApiKeyAuth (API Key)

Passe sua chave de API no api-key cabeçalho.

ApiKeyAuth_ (Chave API)

Passe sua chave de 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

Escopos:

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

Requisitos de segurança

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

ApiKeyAuth
ApiKeyAuth_
OAuth2Auth (escopos: https://cognitiveservices.azure.com/.default)

Criar resposta

POST {endpoint}/openai/v1/responses

Cria uma resposta de modelo.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Sim	cadeia	Um endpoint de APIs suportado pelo Fábrica de IA do Azure 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 Valores possíveis: `v1`, `preview`	A versão explícita da API de Modelos do Fábrica de IA do Azure a ser usada para essa solicitação. `v1` se não for especificado de outra forma.

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Description	Obrigatório
em segundo plano	booliano ou nulo		No
context_management	array de OpenAI.ContextManagementParam ou nulo	Configuração de gerenciamento de contexto para esta solicitação.	No
conversa	OpenAI.ConversationParam ou nulo		No
Incluem	matriz de OpenAI.IncludeEnum ou null		No
entrada	OpenAI.InputParam	Entradas de texto, imagem ou arquivo para o modelo, usadas para gerar uma resposta. Saiba mais: – Entradas e saídas de texto - Entradas de imagem - Entradas de arquivo - Estado de conversa - Chamada de função	No
instructions	cadeia de caracteres ou nulo		No
max_output_tokens	inteiro ou nulo		No
max_tool_calls	inteiro ou nulo		No
metadados	OpenAI.Metadata ou nulo		No
modelo	cadeia	ID do modelo usada para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma ampla gama de modelos com diferentes funcionalidades, desempenho características e pontos de preço. Consulte o guia de modelos para navegar e comparar os modelos disponíveis.	No
parallel_tool_calls	booliano ou nulo		No
previous_response_id	cadeia de caracteres ou nulo		No
solicitação	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	No
prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo.	No
prompt_cache_retention	cadeia de caracteres ou nulo		No
reasoning	OpenAI.Reasoning ou nulo		No
safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. Os IDs devem ser uma string que identifique unicamente cada usuário, com um comprimento máximo de 64 caracteres. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Restrições: maxComprimento: 64	No
armazenar	booliano ou nulo		No
fluxo	booliano ou nulo		No
stream_options	OpenAI.ResponseStreamOptions ou nulo		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 internas: ferramentas fornecidas pelo OpenAI que estendem o capacidades do modelo, como busca de arquivos - Chamadas de função (ferramentas personalizadas): funções definidas por você, permitindo que o modelo chame seu próprio código.	No
top_logprobs	inteiro ou nulo		No
top_p	número ou nulo		No
truncation	cadeia de caracteres ou nulo		No
usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos.	No

Responses

Código de status: 200

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

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

Nome	Tipo	Description	Obrigatório	Default
em segundo plano	booliano ou nulo		No
concluído_em	cadeia de caracteres ou nulo		No
content_filters	matriz de AzureContentFilterForResponsesAPI	Os resultados do filtro de conteúdo da RAI.	No
conversa	OpenAI.ConversationReference ou nulo		No
criado_em	inteiro (unixtime)	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Sim
erro	OpenAI.ResponseError ou nulo		Sim
id	cadeia	Identificador exclusivo para esta resposta.	Sim
incomplete_details	OpenAI.ResponseIncompleteDetails ou null		Sim
instructions	cadeia de caracteres ou matriz de OpenAI.InputItem ou nulo		Sim
max_output_tokens	inteiro ou nulo		No
max_tool_calls	inteiro ou nulo		No
metadados	OpenAI.Metadata ou nulo		No
modelo	cadeia	ID do modelo usada para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma ampla gama de modelos com diferentes funcionalidades, desempenho características e pontos de preço. Consulte o guia de modelos para navegar e comparar os modelos disponíveis.	No
objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Sim
saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Sim
output_text	cadeia de caracteres ou nulo		No
parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
previous_response_id	cadeia de caracteres ou nulo		No
solicitação	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	No
prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo.	No
prompt_cache_retention	cadeia de caracteres ou nulo		No
reasoning	OpenAI.Reasoning ou nulo		No
safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. Os IDs devem ser uma string que identifique unicamente cada usuário, com um comprimento máximo de 64 caracteres. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Restrições: maxComprimento: 64	No
status	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
Temperatura	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o Capacidades do modelo, como busca na web Ou busca de arquivos. Saiba mais sobre Ferramentas embutidas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre função chamando. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
top_logprobs	inteiro ou nulo		No
top_p	número ou nulo		No
truncation	cadeia de caracteres ou nulo		No
uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos.	No

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
apim-request-id	cadeia	Uma ID de solicitação usada para fins de solução de problemas.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objeto

Nome	Tipo	Obrigatório
codificar	cadeia de caracteres ou nulo	Sim
inner_error		No
mensagem	cadeia	Sim
param	cadeia de caracteres ou nulo	No
tipo	cadeia	No

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
apim-request-id	cadeia	Uma ID de solicitação usada para fins de solução de problemas.

Exemplos

Example

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 de modelo com a ID fornecida.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Sim	cadeia	Um endpoint de APIs suportado pelo Fábrica de IA do Azure 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 Valores possíveis: `v1`, `preview`	A versão explícita da API de Modelos do Fábrica de IA do Azure a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
response_id	caminho	Sim	cadeia
include[]	consulta	No	matriz	Campos adicionais a serem incluídos na resposta. Consulte o parâmetro include para a criação de resposta acima para obter 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 forem 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 iniciar o streaming. Serialização: explode: false
include_obfuscation	consulta	No	boolean	Quando true, a ofuscação de fluxo será habilitada. A ofuscação de fluxo adiciona caracteres aleatórios a um `obfuscation` campo em eventos delta de streaming para normalizar os tamanhos de carga como uma mitigação para determinados ataques de canal lateral. Esses campos de ofuscação são incluídos por padrão, mas adicionam uma pequena quantidade de sobrecarga 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: a solicitação foi bem-sucedida.

Tipo de conteúdo	Type	Description
application/json	objeto

Nome	Tipo	Description	Obrigatório	Default
em segundo plano	booliano ou nulo		No
concluído_em	cadeia de caracteres ou nulo		No
content_filters	matriz de AzureContentFilterForResponsesAPI	Os resultados do filtro de conteúdo da RAI.	No
conversa	OpenAI.ConversationReference ou nulo		No
criado_em	inteiro (unixtime)	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Sim
erro	OpenAI.ResponseError ou nulo		Sim
id	cadeia	Identificador exclusivo para esta resposta.	Sim
incomplete_details	OpenAI.ResponseIncompleteDetails ou null		Sim
instructions	cadeia de caracteres ou matriz de OpenAI.InputItem ou nulo		Sim
max_output_tokens	inteiro ou nulo		No
max_tool_calls	inteiro ou nulo		No
metadados	OpenAI.Metadata ou nulo		No
modelo	cadeia	ID do modelo usada para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma ampla gama de modelos com diferentes funcionalidades, desempenho características e pontos de preço. Consulte o guia de modelos para navegar e comparar os modelos disponíveis.	No
objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Sim
saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Sim
output_text	cadeia de caracteres ou nulo		No
parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
previous_response_id	cadeia de caracteres ou nulo		No
solicitação	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	No
prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo.	No
prompt_cache_retention	cadeia de caracteres ou nulo		No
reasoning	OpenAI.Reasoning ou nulo		No
safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. Os IDs devem ser uma string que identifique unicamente cada usuário, com um comprimento máximo de 64 caracteres. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Restrições: maxComprimento: 64	No
status	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
Temperatura	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o Capacidades do modelo, como busca na web Ou busca de arquivos. Saiba mais sobre Ferramentas embutidas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre função chamando. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
top_logprobs	inteiro ou nulo		No
top_p	número ou nulo		No
truncation	cadeia de caracteres ou nulo		No
uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos.	No

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
apim-request-id	cadeia	Uma ID de solicitação usada para fins de solução de problemas.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objeto

Nome	Tipo	Obrigatório
codificar	cadeia de caracteres ou nulo	Sim
inner_error		No
mensagem	cadeia	Sim
param	cadeia de caracteres ou nulo	No
tipo	cadeia	No

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
apim-request-id	cadeia	Uma ID de solicitação usada para fins de solução de problemas.

Excluir resposta

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

Exclui uma resposta por ID.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Sim	cadeia	Um endpoint de APIs suportado pelo Fábrica de IA do Azure 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 Valores possíveis: `v1`, `preview`	A versão explícita da API de Modelos do Fábrica de IA do Azure a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
response_id	caminho	Sim	cadeia

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	objeto

Nome	Tipo	Description	Obrigatório
excluído	enumeração	Valores possíveis: `True`	Sim
id	cadeia		Sim
objeto	enumeração	Valores possíveis: `response.deleted`	Sim

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
apim-request-id	cadeia	Uma ID de solicitação usada para fins de solução de problemas.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objeto

Nome	Tipo	Obrigatório
codificar	cadeia de caracteres ou nulo	Sim
inner_error		No
mensagem	cadeia	Sim
param	cadeia de caracteres ou nulo	No
tipo	cadeia	No

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
apim-request-id	cadeia	Uma ID de solicitação usada para fins de solução de problemas.

Cancelar resposta

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

Cancela uma resposta de modelo com a ID fornecida. Somente as respostas criadas com o parâmetro em segundo plano definido como true podem ser canceladas.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Sim	cadeia	Um endpoint de APIs suportado pelo Fábrica de IA do Azure 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 Valores possíveis: `v1`, `preview`	A versão explícita da API de Modelos do Fábrica de IA do Azure a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
response_id	caminho	Sim	cadeia

Responses

Código de status: 200

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

Tipo de conteúdo	Type	Description
application/json	objeto

Nome	Tipo	Description	Obrigatório	Default
em segundo plano	booliano ou nulo		No
concluído_em	cadeia de caracteres ou nulo		No
content_filters	matriz de AzureContentFilterForResponsesAPI	Os resultados do filtro de conteúdo da RAI.	No
conversa	OpenAI.ConversationReference ou nulo		No
criado_em	inteiro (unixtime)	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Sim
erro	OpenAI.ResponseError ou nulo		Sim
id	cadeia	Identificador exclusivo para esta resposta.	Sim
incomplete_details	OpenAI.ResponseIncompleteDetails ou null		Sim
instructions	cadeia de caracteres ou matriz de OpenAI.InputItem ou nulo		Sim
max_output_tokens	inteiro ou nulo		No
max_tool_calls	inteiro ou nulo		No
metadados	OpenAI.Metadata ou nulo		No
modelo	cadeia	ID do modelo usada para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma ampla gama de modelos com diferentes funcionalidades, desempenho características e pontos de preço. Consulte o guia de modelos para navegar e comparar os modelos disponíveis.	No
objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Sim
saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Sim
output_text	cadeia de caracteres ou nulo		No
parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
previous_response_id	cadeia de caracteres ou nulo		No
solicitação	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	No
prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo.	No
prompt_cache_retention	cadeia de caracteres ou nulo		No
reasoning	OpenAI.Reasoning ou nulo		No
safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. Os IDs devem ser uma string que identifique unicamente cada usuário, com um comprimento máximo de 64 caracteres. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Restrições: maxComprimento: 64	No
status	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
Temperatura	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o Capacidades do modelo, como busca na web Ou busca de arquivos. Saiba mais sobre Ferramentas embutidas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre função chamando. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
top_logprobs	inteiro ou nulo		No
top_p	número ou nulo		No
truncation	cadeia de caracteres ou nulo		No
uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos.	No

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
apim-request-id	cadeia	Uma ID de solicitação usada para fins de solução de problemas.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objeto

Nome	Tipo	Obrigatório
codificar	cadeia de caracteres ou nulo	Sim
inner_error		No
mensagem	cadeia	Sim
param	cadeia de caracteres ou nulo	No
tipo	cadeia	No

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
apim-request-id	cadeia	Uma ID de solicitação usada para fins de soluçã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

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Sim	cadeia	Um endpoint de APIs suportado pelo Fábrica de IA do Azure 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 Valores possíveis: `v1`, `preview`	A versão explícita da API de Modelos do Fábrica de IA do Azure a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
response_id	caminho	Sim	cadeia
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
ordem	consulta	No	cadeia Valores possíveis: `asc`, `desc`	Classificar a ordem pelo carimbo de data/hora `created_at` dos objetos. `asc` para ordem crescente e`desc` para ordem decrescente. Serialização: explode: false
Depois	consulta	No	cadeia	Um cursor para uso na paginação. `after` é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A próxima chamada pode incluir o parâmetro after=obj_foo para buscar a próxima página da lista. Serialização: explode: false
before	consulta	No	cadeia	Um cursor para uso na paginação. `before` é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada seguinte pode incluir before=obj_foo para buscar a página anterior da lista. Serialização: explode: false

Responses

Código de status: 200

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

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

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
apim-request-id	cadeia	Uma ID de solicitação usada para fins de solução de problemas.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objeto

Nome	Tipo	Obrigatório
codificar	cadeia de caracteres ou nulo	Sim
inner_error		No
mensagem	cadeia	Sim
param	cadeia de caracteres ou nulo	No
tipo	cadeia	No

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
apim-request-id	cadeia	Uma ID de solicitação usada para fins de solução de problemas.

Components

AzureAIFoundryModelsApiVersion

Property	Valor
Type	cadeia
Valores	`v1` `preview`

AzureContentFilterBlocklistResult

Uma coleção de resultados de filtragem true/false para listas de bloqueio personalizadas configuradas.

Nome	Tipo	Description	Obrigatório	Default
details	matriz de objeto	Os pares de IDs individuais da lista de bloqueio e se eles resultaram em ações de filtragem.	No
Filtrada	boolean	Um valor que indica se qualquer uma 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 usado pelos resultados do filtro de conteúdo do Azure OpenAI.

Nome	Tipo	Description	Obrigatório	Default
completion_end_offset	inteiro (int32)	Deslocamento do primeiro ponto de código UTF32 que é excluído do intervalo. Esse campo é sempre igual a completion_start_offset para intervalos vazios. Esse campo é sempre maior que completion_start_offset para intervalos não vazios.	Sim
completion_start_offset	inteiro (int32)	Deslocamento do ponto de código UTF32 que inicia o intervalo.	Sim

AzureContentFilterCompletionTextSpanDetectionResult

Nome	Tipo	Description	Obrigatório
details	matriz de AzureContentFilterCompletionTextSpan	Informações detalhadas sobre os intervalos de texto de conclusão detectados.	Sim
detectado	boolean	Se a categoria de conteúdo rotulado foi detectada no conteúdo.	Sim
Filtrada	boolean	Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim

AzureContentFilterCustomTopicResult

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

Nome	Tipo	Description	Obrigatório	Default
details	matriz de objeto	Os pares de IDs de tópico individuais e se são detectados.	No
Filtrada	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 detectado e se o conteúdo foi filtrado.

Nome	Tipo	Description	Obrigatório	Default
detectado	boolean	Se a categoria de conteúdo rotulado foi detectada no conteúdo.	Sim
Filtrada	boolean	Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim

AzureContentFilterForResponsesAPI

Nome	Tipo	Description	Obrigatório
Bloqueado	boolean	Indique se a resposta está bloqueada.	Sim
content_filter_offsets	AzureContentFilterResultOffsets		Sim
content_filter_results	AzureContentFilterResultsForResponsesAPI		Sim
└─ listas_personalizadas_de_bloqueio	AzureContentFilterBlocklistResult	Uma coleção de resultados de filtragem binária para listas de bloqueio personalizadas configuradas.	No
└─ tópicos_personalizados	AzureContentFilterCustomTopicResult	Uma coleção de resultados de filtragem binária para tópicos personalizados configurados.	No
└─ erro	objeto	Se estiver 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 e legível pelo computador associado ao erro.	Sim
Mensagem └─	cadeia	Uma mensagem legível por humanos associada ao erro.	Sim
└─ ódio	AzureContentFilterSeverityResult	Uma categoria de filtro de conteúdo que pode se referir a qualquer conteúdo que ataque ou use pejorativo ou discriminatório idioma com referência a uma pessoa ou grupo de identidade com base em determinados atributos diferenciais desses grupos incluindo, mas não se limitando à raça, etnia, nacionalidade, identidade de gênero e expressão, orientação sexual, religião, status de imigração, status de habilidade, aparência pessoal e tamanho do corpo.	No
└─ ataque_indireto	AzureContentFilterDetectionResult	Um resultado de detecção que descreve ataques a sistemas alimentados por modelos de IA generativos que podem acontecer sempre um aplicativo processa informações que não foram criadas diretamente pelo desenvolvedor do aplicativo ou o usuário.	No
└─ desbloqueio	AzureContentFilterDetectionResult	Um resultado de detecção que descreve ataques de injeção de prompt do usuário, em que usuários mal-intencionados exploram deliberadamente vulnerabilidades do sistema para provocar um comportamento não autorizado da LLM. Isso pode levar a conteúdo inadequado geração ou violações de restrições impostas pelo sistema.	Sim
└─ personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Um resultado de detecção que descreve correspondências com informações de identificação pessoal com subcategorias configuráveis.	No
└─ palavrões	AzureContentFilterDetectionResult	Um resultado de detecção que identifica se a linguagem bruta, vulgar ou de outra forma de objeção está presente no Conteúdo.	No
└─ protected_material_code	objeto	Um resultado de detecção que descreve uma correspondência com o código licenciado ou outro material de origem protegido.	No
└─ citação	objeto	Se disponível, os detalhes da citação que descrevem a licença associada e sua localização.	No
└─ URL	cadeia de caracteres (uri)	A URL associada à licença.	No
└─ Licença	cadeia	O nome ou identificador da licença associada à detecção.	No
└─ detectado	boolean	Se a categoria de conteúdo rotulado foi detectada no conteúdo.	Sim
└─ filtrado	boolean	Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
└─ protected_material_text	AzureContentFilterDetectionResult	Um resultado de detecção que descreve uma correspondência com o texto protegido por direitos autorais ou outro status.	No
└─ automutilação	AzureContentFilterSeverityResult	Uma categoria de filtro de conteúdo que descreve a linguagem relacionada a ações físicas destinadas a prejudicar de propósito, ferir, danificar o corpo ou se matar.	No
└─ sexual	AzureContentFilterSeverityResult	Uma categoria de filtro de conteúdo para linguagem relacionada a órgãos anatômicos e genitais, relacionamentos românticos, atos retratados em termos eróticos ou afetuosos, gravidez, atos sexuais físicos, incluindo aqueles retratados como um agressão ou um ato violento sexual forçado contra a vontade, prostituição, pornografia e abuso.	No
└─ task_adherence	AzureContentFilterDetectionResult	Um resultado de detecção que indica se o fluxo de execução ainda mantém o plano.	Sim
└─ ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
└─ violência	AzureContentFilterSeverityResult	Uma categoria de filtro de conteúdo para linguagem relacionada a ações físicas destinadas a ferir, ferir, danificar ou matar alguém ou algo assim; descreve armas, armas e entidades relacionadas, como fabricantes, associações, legislação, e assim por diante.	No
Source_type	cadeia	O nome do tipo de origem da mensagem.	Sim
tool_call_id	cadeia	O ID da chamada de ferramenta associada a esse filtro de conteúdo resulta, se aplicável.	No

AzureContentFilterPersonallyIdentifiableInformationResult

Um resultado de detecção de filtro de conteúdo para informações de identificação pessoal que inclui extensões de danos.

Nome	Tipo	Description	Obrigatório
detectado	boolean	Se a categoria de conteúdo rotulado foi detectada no conteúdo.	Sim
Filtrada	boolean	Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
redacted_text	cadeia	O texto redigido com informações de PII removidas ou mascaradas.	No
sub_categories	matriz de AzurePiiSubCategoryResult	Resultados detalhados para PIIHarmSubCategory(s) individuais.	No

AzureContentFilterResultOffsets

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

AzureContentFilterResultsForResponsesAPI

Nome	Tipo	Description	Obrigatório
custom_blocklists	AzureContentFilterBlocklistResult	Uma coleção de resultados de filtragem true/false para listas de bloqueio personalizadas configuradas.	No
└─ detalhes	matriz de objeto	Os pares de IDs individuais da lista de bloqueio e se eles resultaram em ações de filtragem.	No
└─ filtrado	boolean	Um valor que indica se a lista de bloqueios produziu uma ação de filtragem.	Sim
└─ id	cadeia	A ID da lista de bloqueios personalizada avaliada.	Sim
└─ filtrado	boolean	Um valor que indica se qualquer uma das listas de bloqueio detalhadas resultou em uma ação de filtragem.	Sim
custom_topics	AzureContentFilterCustomTopicResult	Uma coleção de resultados de filtragem true/false para tópicos personalizados configurados.	No
└─ detalhes	matriz de objeto	Os pares de IDs de tópico individuais e se são detectados.	No
└─ detectado	boolean	Um valor que indica se o tópico foi detectado.	Sim
└─ id	cadeia	A ID do tópico personalizado avaliado.	Sim
└─ filtrado	boolean	Um valor que indica se algum dos tópicos detalhados resultou em uma ação de filtragem.	Sim
erro	objeto	Se estiver 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 e legível pelo computador associado ao erro.	Sim
Mensagem └─	cadeia	Uma mensagem legível por humanos associada ao erro.	Sim
Odeio	AzureContentFilterSeverityResult	Um item rotulado de resultado de filtro de conteúdo que indica se o conteúdo foi filtrado e qual o resultado qualitativo. O nível de severidade do conteúdo foi avaliado com base na configuração do filtro de conteúdo para a categoria.	No
└─ filtrado	boolean	Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
└─ severidade	enumeração	A gravidade rotulada do conteúdo. Valores possíveis: `safe`, , `low`, `mediumhigh`	Sim
indirect_attack	AzureContentFilterDetectionResult	Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi filtrado.	No
└─ detectado	boolean	Se a categoria de conteúdo rotulado foi detectada no conteúdo.	Sim
└─ filtrado	boolean	Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
jailbreak	AzureContentFilterDetectionResult	Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi filtrado.	Sim
└─ detectado	boolean	Se a categoria de conteúdo rotulado foi detectada no conteúdo.	Sim
└─ filtrado	boolean	Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Um resultado de detecção de filtro de conteúdo para informações de identificação pessoal que inclui extensões de danos.	No
└─ redacted_text	cadeia	O texto redigido com informações de PII removidas ou mascaradas.	No
└─ sub-categorias	matriz de AzurePiiSubCategoryResult	Resultados detalhados para PIIHarmSubCategory(s) individuais.	No
Profanidade	AzureContentFilterDetectionResult	Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi filtrado.	No
└─ detectado	boolean	Se a categoria de conteúdo rotulado foi detectada no conteúdo.	Sim
└─ filtrado	boolean	Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
protected_material_code	objeto	Um resultado de detecção que descreve uma correspondência com o código licenciado ou outro material de origem protegido.	No
└─ citação	objeto	Se disponível, os detalhes da citação que descrevem a licença associada e sua localização.	No
└─ URL	cadeia de caracteres (uri)	A URL associada à licença.	No
└─ Licença	cadeia	O nome ou identificador da licença associada à detecção.	No
└─ detectado	boolean	Se a categoria de conteúdo rotulado foi detectada no conteúdo.	Sim
└─ filtrado	boolean	Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
protected_material_text	AzureContentFilterDetectionResult	Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi filtrado.	No
└─ detectado	boolean	Se a categoria de conteúdo rotulado foi detectada no conteúdo.	Sim
└─ filtrado	boolean	Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
self_harm	AzureContentFilterSeverityResult	Um item rotulado de resultado de filtro de conteúdo que indica se o conteúdo foi filtrado e qual o resultado qualitativo. O nível de severidade do conteúdo foi avaliado com base na configuração do filtro de conteúdo para a categoria.	No
└─ filtrado	boolean	Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
└─ severidade	enumeração	A gravidade rotulada do conteúdo. Valores possíveis: `safe`, , `low`, `mediumhigh`	Sim
sexual	AzureContentFilterSeverityResult	Um item rotulado de resultado de filtro de conteúdo que indica se o conteúdo foi filtrado e qual o resultado qualitativo. O nível de severidade do conteúdo foi avaliado com base na configuração do filtro de conteúdo para a categoria.	No
└─ filtrado	boolean	Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
└─ severidade	enumeração	A gravidade rotulada do conteúdo. Valores possíveis: `safe`, , `low`, `mediumhigh`	Sim
task_adherence	AzureContentFilterDetectionResult	Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi filtrado.	Sim
└─ detectado	boolean	Se a categoria de conteúdo rotulado foi detectada no conteúdo.	Sim
└─ filtrado	boolean	Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
Violência	AzureContentFilterSeverityResult	Um item rotulado de resultado de filtro de conteúdo que indica se o conteúdo foi filtrado e qual o resultado qualitativo. O nível de severidade do conteúdo foi avaliado com base na configuração do filtro de conteúdo para a categoria.	No
└─ filtrado	boolean	Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Sim
└─ severidade	enumeração	A gravidade rotulada do conteúdo. Valores possíveis: `safe`, , `low`, `mediumhigh`	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.

Nome	Tipo	Description	Obrigatório	Default
Filtrada	boolean	Se a gravidade 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`, `mediumhigh`	Sim

AzurePiiSubCategoryResult

Detalhes do resultado para PIIHarmSubCategory(s) individuais.

Nome	Tipo	Description	Obrigatório
detectado	boolean	Se a subcategoria de conteúdo rotulada foi detectada no conteúdo.	Sim
Filtrada	boolean	Se a detecçã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 redigido para essa subcategoria.	Sim
sub_category	cadeia	O PIIHarmSubCategory que foi avaliado.	Sim

AzureToolApprovalRequest

Solicitação de aprovação de ferramenta Azure

Uma solicitação de aprovação da ferramenta Azure na saída da resposta.

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma string JSON de argumentos para a ferramenta.	Sim
call_id	cadeia	O ID da chamada de ferramenta que exige aprovação.	Sim
id	cadeia	A ID exclusiva da solicitação de aprovação.	Sim
etiqueta	cadeia	O rótulo da ferramenta (por exemplo, 'remote_functions').	Sim
nome	cadeia	O nome da função da ferramenta (por exemplo, 'output_binding').	Sim
tipo	enumeração	O tipo do item. 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 da solicitação.

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia	A ID da solicitação de aprovação que está sendo respondida.	Sim
aprovar	boolean	Se a solicitação foi aprovada.	Sim
tipo	enumeração	O tipo do item. Sempre `tool_approval_response`. Valores possíveis: `tool_approval_response`	Sim

OpenAI.Annotation

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

Discriminador para OpenAI.Annotation

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

Digite um valor	Schema
`file_citation`	OpenAI.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.AnnotationType		Sim

OpenAI.AnnotationType

Property	Valor
Type	cadeia
Valores	`file_citation` `url_citation` `container_file_citation` `file_path`

OpenAI.ApplyPatchCallOutputStatus

Property	Valor
Type	cadeia
Valores	`completed` `failed`

OpenAI.ApplyPatchCallOutputStatusParam

Aplicar status de saída de chamada de patch

Valores de resultado relatados para saídas de chamada de ferramenta de apply_patch.

Property	Valor
Type	cadeia
Valores	`completed` `failed`

OpenAI.ApplyPatchCallStatus

Property	Valor
Type	cadeia
Valores	`in_progress` `completed`

OpenAI.ApplyPatchCallStatusParam

Aplicar o status de chamada de contato

Valores de status relatados para chamadas de ferramenta de apply_patch.

Property	Valor
Type	cadeia
Valores	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

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

Instrução que descreve como criar um arquivo por meio da ferramenta apply_patch.

Nome	Tipo	Description	Obrigatório	Default
Diff	cadeia	Difusão a ser aplicada.	Sim
caminho	cadeia	Caminho do arquivo a ser criado.	Sim
tipo	enumeração	Crie um novo arquivo com a diferença fornecida. Valores possíveis: `create_file`	Sim	create_file

OpenAI.ApplyPatchCreateFileOperationParam

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

Instrução para criar um novo arquivo por meio da ferramenta apply_patch.

Nome	Tipo	Description	Obrigatório	Default
Diff	cadeia	Conteúdo unificado para aplicar ao criar o arquivo. Restrições: maxLength: 10485760	Sim
caminho	cadeia	Caminho do arquivo a ser criado em relação à raiz do workspace. Restrições: minLength: 1	Sim
tipo	enumeração	O tipo de operação. Sempre `create_file`. Valores possíveis: `create_file`	Sim	create_file

OpenAI.ApplyPatchDeleteFileOperation

Aplicar operação de eliminação de patch

Instrução que descreve como excluir um arquivo por meio da ferramenta apply_patch.

Nome	Tipo	Description	Obrigatório	Default
caminho	cadeia	Caminho do arquivo a ser excluído.	Sim
tipo	enumeração	Exclua o arquivo especificado. Valores possíveis: `delete_file`	Sim	delete_file

OpenAI.ApplyPatchDeleteFileOperationParam

Aplicar operação de eliminação de patch

Instrução para excluir um arquivo existente por meio da ferramenta apply_patch.

Nome	Tipo	Description	Obrigatório	Default
caminho	cadeia	Caminho do arquivo a ser excluído em relação à raiz do workspace. Restrições: minLength: 1	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 de create_file, delete_file ou update_file aplicadas por meio de apply_patch.

Discriminador para OpenAI.ApplyPatchFileOperation

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

Digite um valor	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ApplyPatchFileOperationType		Sim

OpenAI.ApplyPatchFileOperationType

Property	Valor
Type	cadeia
Valores	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchOperationParam

Aplicar operação de patch

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

Discriminador para OpenAI.ApplyPatchOperationParam

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

Digite um valor	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperationParam
`delete_file`	OpenAI.ApplyPatchDeleteFileOperationParam
`update_file`	OpenAI.ApplyPatchUpdateFileOperationParam

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ApplyPatchOperationParamType		Sim

OpenAI.ApplyPatchOperationParamType

Property	Valor
Type	cadeia
Valores	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

Aplicar a ferramenta de correção

Permite que o assistente crie, exclua ou atualize arquivos usando diferenças unificadas.

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

OpenAI.ApplyPatchUpdateFileOperation

Aplicar operação de atualização de patch

Instrução que descreve como atualizar um arquivo por meio da ferramenta apply_patch.

Nome	Tipo	Description	Obrigatório	Default
Diff	cadeia	Difusão a ser aplicada.	Sim
caminho	cadeia	Caminho do arquivo a ser atualizado.	Sim
tipo	enumeração	Atualize um arquivo existente com a diferença fornecida. Valores possíveis: `update_file`	Sim	update_file

OpenAI.ApplyPatchUpdateFileOperationParam

Aplicar operação de atualização de patch

Instrução para atualizar um arquivo existente por meio da ferramenta apply_patch.

Nome	Tipo	Description	Obrigatório	Default
Diff	cadeia	Conteúdo diferencial unificado para aplicar ao arquivo existente. Restrições: maxLength: 10485760	Sim
caminho	cadeia	Caminho do arquivo a ser atualizado em relação à raiz do workspace. Restrições: minLength: 1	Sim
tipo	enumeração	O tipo de operação. Sempre `update_file`. Valores possíveis: `update_file`	Sim	update_file

OpenAI.ApproximateLocation

Nome	Tipo	Description	Obrigatório	Default
Cidade	cadeia de caracteres ou nulo		No
country	cadeia de caracteres ou nulo		No
região	cadeia de caracteres ou nulo		No
timezone	cadeia de caracteres ou nulo		No
tipo	enumeração	O tipo de aproximação de local. Sempre `approximate`. Valores possíveis: `approximate`	Sim	aproximado

OpenAI.AutoCodeInterpreterToolParam

Parâmetros da Ferramenta Automática de Interpretador 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.

Nome	Tipo	Description	Obrigatório	Default
identificadores_de_arquivos	matriz de strings	Uma lista opcional de arquivos carregados a serem disponibilizados para seu código. Restrições: máximosItens: 50	No
limite de memória	OpenAI.ContainerMemoryLimit ou null		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Política de acesso à rede para o contêiner.	No
tipo	enumeração	Sempre `auto`. Valores possíveis: `auto`	Sim	automático

OpenAI.ClickButtonType

Property	Valor
Type	cadeia
Valores	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

Click

Uma ação de clique.

Nome	Tipo	Description	Obrigatório	Default
botão	OpenAI.ClickButtonType		Sim
keys	matriz de cadeia de caracteres ou nulo		No
tipo	enumeração	Especifica o tipo de evento. Para uma ação de clique, essa propriedade é sempre `click`. Valores possíveis: `click`	Sim	clique
x	inteiro	A coordenada x em que o clique ocorreu.	Sim
y	inteiro	A coordenada y em que o clique ocorreu.	Sim

OpenAI.CodeInterpreterOutputImage

Imagem de saída do interpretador de código

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

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	O tipo da saída. Sempre `image`. Valores possíveis: `image`	Sim	imagem
url	cadeia de caracteres (uri)	A URL da saída da imagem do 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.

Nome	Tipo	Description	Obrigatório	Default
logs	cadeia	A saída de logs do interpretador de código.	Sim
tipo	enumeração	O tipo da saída. Sempre `logs`. Valores possíveis: `logs`	Sim	logs

OpenAI.CodeInterpreterTool

Interpretador de código

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

Nome	Tipo	Description	Obrigatório	Default
contêiner	string ou OpenAI.AutoCodeInterpreterToolParam	O contêiner do interpretador de código. Pode ser uma ID de contêiner ou um objeto que especifica as IDs de arquivo carregadas a serem disponibilizadas para seu código, juntamente com um configuração opcional `memory_limit` .	Sim
tipo	enumeração	O tipo da ferramenta de interpretador de código. Sempre `code_interpreter`. Valores possíveis: `code_interpreter`	Sim

OpenAI.FiltroComparativo

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.

Nome	Tipo	Description	Obrigatório	Default
chave	cadeia	A chave a ser comparada com o valor.	Sim
tipo	enumeração	Especifica o operador de comparação: `eq`, , `ne`, `gt`, `gte`, `lt`, , `lte`, `in`, `nin`. - `eq`: igual - `ne`: não é igual a - `gt`: maior que - `gte`: maior ou igual a - `lt`: menor que - `lte`: menor ou igual a - `in`:Em - `nin`: não em Valores possíveis: `eq`, , `ne`, `gt`, `gte`, `lt`, `lte`, , , `innin`	Sim	eq
value	string ou número ou booleano ou array de string ou número	O valor a ser comparado com a chave de atributo; dá suporte a tipos de cadeia de caracteres, número ou booliano.	Sim

OpenAI.CompoundFilter

Filtro composto

Combinar vários filtros usando and ou or.

Nome	Tipo	Description	Obrigatório	Default
Filtros	matriz de OpenAI.ComparisonFilter ou objeto	Matriz de filtros a serem combinados. Os itens podem ser `ComparisonFilter` ou `CompoundFilter`.	Sim
tipo	enumeração	Tipo de operação: `and` ou `or`. Valores possíveis: `and`, `or`	Sim

OpenAI.ComputerAction

Discriminador para OpenAI.ComputerAction

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

Digite um valor	Schema
`click`	OpenAI.ClickParam
`double_click`	OpenAI.DoubleClickAction
`drag`	OpenAI.DragParam
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.MoveParam
`screenshot`	OpenAI.ScreenshotParam
`scroll`	OpenAI.ScrollParam
`type`	OpenAI.TypeParam
`wait`	OpenAI.WaitParam

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ComputerActionType		Sim

OpenAI.ComputerActionList

Lista de Ações Computacionais

Ações em lote 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
Valores	`click` `double_click` `drag` `keypress` `move` `screenshot` `scroll` `type` `wait`

OpenAI.ComputerCallSafetyCheckParam

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

Nome	Tipo	Description	Obrigatório
codificar	cadeia de caracteres ou nulo		No
id	cadeia	A ID da verificação de segurança pendente.	Sim
mensagem	cadeia de caracteres ou nulo		No

OpenAI.ComputerEnvironment

Property	Valor
Type	cadeia
Valores	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerScreenshotContent

Captura de tela do computador

Uma captura de tela de um computador.

Nome	Tipo	Description	Obrigatório	Default
detail	OpenAI.ImageDetail		Sim
file_id	cadeia de caracteres ou nulo		Sim
image_url	cadeia de caracteres ou nulo		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.

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

OpenAI.ComputerTool

Computador

Uma ferramenta que controla um computador virtual.

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	O tipo da ferramenta de computador. Sempre `computer`. Valores possíveis: `computer`	Sim	computador

OpenAI.ComputerUsePreviewTool

Prévia do uso do computador

Uma ferramenta que controla um computador virtual.

Nome	Tipo	Description	Obrigatório	Default
altura_do_display	inteiro	A altura da exibição do computador.	Sim
largura de exibição	inteiro	A largura da exibição do computador.	Sim
ambiente	OpenAI.ComputerEnvironment		Sim
tipo	enumeração	O tipo da ferramenta de uso do computador. Sempre `computer_use_preview`. Valores possíveis: `computer_use_preview`	Sim	computer_use_preview

OpenAI.ContainerAutoParam

Nome	Tipo	Description	Obrigatório	Default
identificadores_de_arquivos	matriz de strings	Uma lista opcional de arquivos carregados a serem disponibilizados para seu código. Restrições: máximosItens: 50	No
limite de memória	OpenAI.ContainerMemoryLimit ou null		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Política de acesso à rede para o contêiner.	No
habilidades	array de OpenAI.ContainerSkill	Uma lista opcional de habilidades referenciadas por ID ou dados inline. Restrições: máximoItens: 200	No
tipo	enumeração	Cria automaticamente um contêiner para essa solicitação Valores possíveis: `container_auto`	Sim	container_auto

OpenAI.ContainerFileCitationBody

Citação de arquivo de contêiner

Uma citação para um arquivo de contêiner usado para gerar uma resposta de modelo.

Nome	Tipo	Description	Obrigatório	Default
container_id	cadeia	A ID do arquivo de contêiner.	Sim
end_index	inteiro	O índice do último caractere da citação do arquivo de contêiner na mensagem.	Sim
file_id	cadeia	A ID do arquivo.	Sim
filename	cadeia	O nome do arquivo de contêiner citado.	Sim
start_index	inteiro	O índice do primeiro caractere da citação do arquivo de contêiner na mensagem.	Sim
tipo	enumeração	O tipo da citação de arquivo de contêiner. Sempre `container_file_citation`. Valores possíveis: `container_file_citation`	Sim	container_file_citation

OpenAI.ContainerMemoryLimit

Property	Valor
Type	cadeia
Valores	`1g` `4g` `16g` `64g`

OpenAI.ContainerNetworkPolicyAllowlistParam

Nome	Tipo	Description	Obrigatório	Default
allowed_domains	matriz de strings	Uma lista de domínios permitidos quando o tipo é `allowlist`. Restrições: minItens: 1	Sim
tipo	enumeração	Permita acesso à rede de saída apenas a domínios específicos. Sempre `allowlist`. Valores possíveis: `allowlist`	Sim	incluir na lista de permitidos

OpenAI.ContainerNetworkPolicyDisabledParam

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

OpenAI.ContainerNetworkPolicyParam

Política de acesso à rede para o contêiner.

Discriminador para OpenAI.ContainerNetworkPolicyParam

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

Digite um valor	Schema
`disabled`	OpenAI.ContainerNetworkPolicyDisabledParam
`allowlist`	OpenAI.ContainerNetworkPolicyAllowlistParam

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ContainerNetworkPolicyParamType		Sim

OpenAI.ContainerNetworkPolicyParamType

Property	Valor
Type	cadeia
Valores	`disabled` `allowlist`

OpenAI.ContainerReferenceResource

Referência de Contêiner

Representa um container criado com /v1/containers.

Nome	Tipo	Description	Obrigatório	Default
container_id	cadeia		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

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

Digite um valor	Schema
`skill_reference`	OpenAI.SkillReferenceParam
`inline`	OpenAI.InlineSkillParam

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ContainerSkillType		Sim

OpenAI.ContainerSkillType

Property	Valor
Type	cadeia
Valores	`skill_reference` `inline`

OpenAI.ContextManagementParam

Nome	Tipo	Description	Obrigatório	Default
compact_threshold	inteiro ou nulo		No
tipo	cadeia	O tipo de entrada de gerenciamento de contexto. Atualmente, apenas a 'compactação' é suportada.	Sim

OpenAI.ConversationParam

A conversa à qual essa resposta pertence. Os itens dessa conversa são anexados a input_items essa solicitação de resposta. Itens de entrada e itens de saída dessa resposta são adicionados automaticamente a essa conversa após a conclusão dessa resposta.

Esse componente pode ser um dos seguintes:

string
OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

Objeto de conversa

A conversa à qual essa resposta pertence.

Nome	Tipo	Description	Obrigatório	Default
id	cadeia	A ID exclusiva da conversa.	Sim

OpenAI.ConversationReference

Conversa

A conversa à qual essa resposta pertencia. Itens de entrada e itens de saída dessa resposta foram adicionados automaticamente a essa conversa.

Nome	Tipo	Description	Obrigatório	Default
id	cadeia	A ID exclusiva da conversa à qual essa resposta foi associada.	Sim

OpenAI.CoordParam

Coordinate

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

Nome	Tipo	Description	Obrigatório	Default
x	inteiro	A coordenada x.	Sim
y	inteiro	A coordenada y.	Sim

OpenAI.CreateResponse

Nome	Tipo	Description	Obrigatório
em segundo plano	booliano ou nulo		No
context_management	array de OpenAI.ContextManagementParam ou nulo	Configuração de gerenciamento de contexto para esta solicitação.	No
conversa	OpenAI.ConversationParam ou nulo		No
Incluem	matriz de OpenAI.IncludeEnum ou null		No
entrada	OpenAI.InputParam	Entradas de texto, imagem ou arquivo para o modelo, usadas para gerar uma resposta. Saiba mais: – Entradas e saídas de texto - Entradas de imagem - Entradas de arquivo - Estado de conversa - Chamada de função	No
instructions	cadeia de caracteres ou nulo		No
max_output_tokens	inteiro ou nulo		No
max_tool_calls	inteiro ou nulo		No
metadados	OpenAI.Metadata ou nulo		No
modelo	cadeia	ID do modelo usada para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma ampla gama de modelos com diferentes funcionalidades, desempenho características e pontos de preço. Consulte o guia de modelos para navegar e comparar os modelos disponíveis.	No
parallel_tool_calls	booliano ou nulo		No
previous_response_id	cadeia de caracteres ou nulo		No
solicitação	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	No
prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo.	No
prompt_cache_retention	cadeia de caracteres ou nulo		No
reasoning	OpenAI.Reasoning ou nulo		No
safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. Os IDs devem ser uma string que identifique unicamente cada usuário, com um comprimento máximo de 64 caracteres. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Restrições: maxComprimento: 64	No
armazenar	booliano ou nulo		No
fluxo	booliano ou nulo		No
stream_options	OpenAI.ResponseStreamOptions ou nulo		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 internas: ferramentas fornecidas pelo OpenAI que estendem o capacidades do modelo, como busca de arquivos - Chamadas de função (ferramentas personalizadas): funções definidas por você, permitindo que o modelo chame seu próprio código.	No
top_logprobs	inteiro ou nulo		No
top_p	número ou nulo		No
truncation	cadeia de caracteres ou nulo		No
usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos.	No

OpenAI.CustomGrammarFormatParam

Formato gramatical

Uma gramática definida pelo usuário.

Nome	Tipo	Description	Obrigatório	Default
definição	cadeia	A definição de gramática.	Sim
Sintaxe	OpenAI.GrammarSyntax1		Sim
tipo	enumeração	Formato de gramática. Sempre `grammar`. Valores possíveis: `grammar`	Sim	Gramática

OpenAI.CustomTextFormatParam

Formato de texto

Texto sem restrições de forma livre.

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	Formato de texto não treinado. Sempre `text`. Valores possíveis: `text`	Sim	enviar SMS

OpenAI.CustomToolParam

Ferramenta personalizada

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

Nome	Tipo	Description	Obrigatório	Default
defer_loading	boolean	Se essa ferramenta deve ser adiada e descoberta por meio de busca por ferramentas.	No
description	cadeia	Descrição opcional da ferramenta personalizada, usada para fornecer mais contexto.	No
format	OpenAI.CustomToolParamFormat	O formato de entrada para a ferramenta personalizada. O padrão é texto sem restrições.	No
└─ tipo	OpenAI.CustomToolParamFormatType		Sim
nome	cadeia	O nome da ferramenta personalizada, usada para identificá-la em chamadas de ferramenta.	Sim
tipo	enumeração	O tipo da ferramenta personalizada. Sempre `custom`. Valores possíveis: `custom`	Sim	Personalizado

OpenAI.CustomToolParamFormat

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

Discriminador para OpenAI.CustomToolParamFormat

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

Digite um valor	Schema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.CustomToolParamFormatType		Sim

OpenAI.CustomToolParamFormatType

Property	Valor
Type	cadeia
Valores	`text` `grammar`

OpenAI.DetailEnum

Property	Valor
Type	cadeia
Valores	`low` `high` `auto` `original`

OpenAI.DoubleClickAction

DoubleClick

Uma ação de clique duplo.

Nome	Tipo	Description	Obrigatório	Default
keys	matriz de cadeia de caracteres 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	inteiro	A coordenada x em que o clique duplo ocorreu.	Sim
y	inteiro	A coordenada y em que o clique duplo ocorreu.	Sim

OpenAI.DragParam

Drag

Uma ação de arrastar.

Nome	Tipo	Description	Obrigatório	Default
keys	matriz de cadeia de caracteres ou nulo		No
caminho	array do OpenAI.CoordParam	Uma matriz de coordenadas que representa o caminho da ação de arrastar. As coordenadas serão exibidas como uma matriz de objetos, por exemplo, `<br> [ { 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 mensagem de entrada para o modelo com uma função que indica a hierarquia de instruções a seguir. As instruções fornecidas com a função developer ou system têm precedência sobre as instruções fornecidas com a função user. Presume-se que as mensagens com a assistant função tenham sido geradas pelo modelo em interações anteriores.

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

OpenAI.EmptyModelParam

Tipo: objeto

OpenAI.FileCitationBody

Citação do arquivo

Uma citação a um arquivo.

Nome	Tipo	Description	Obrigatório	Default
file_id	cadeia	A ID do arquivo.	Sim
filename	cadeia	O nome do arquivo citado.	Sim
indexar	inteiro	O índice do arquivo na lista de arquivos.	Sim
tipo	enumeração	O tipo da citação de arquivo. Sempre `file_citation`. Valores possíveis: `file_citation`	Sim	file_citation

OpenAI.FileInputDetail

Property	Valor
Type	cadeia
Valores	`low` `high`

OpenAI.FilePath

Caminho do arquivo

Um caminho para um arquivo.

Nome	Tipo	Description	Obrigatório
file_id	cadeia	A ID do arquivo.	Sim
indexar	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 arquivo

Uma ferramenta que pesquisa conteúdo relevante de arquivos carregados.

Nome	Tipo	Description	Obrigatório	Default
Filtros	OpenAI.Filters ou nulo		No
numero_maximo_de_resultados	inteiro	O número máximo de resultados a serem retornados. Esse número deve estar 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 classificação recíproca equilibra correspondências de inserção semântica versus correspondências de palavra-chave esparsa quando a pesquisa híbrida está habilitada.	No
└─ Ranker	OpenAI.RankerVersionType	O classificador a ser usado para a pesquisa de arquivos.	No
└─ limite_de_pontuação	número	O limite de pontuação para a pesquisa de arquivos, um número entre 0 e 1. Números mais próximos de 1 tentarão retornar apenas os resultados mais relevantes, mas podem retornar menos resultados.	No
tipo	enumeração	O tipo da ferramenta de pesquisa de arquivo. Sempre `file_search`. Valores possíveis: `file_search`	Sim	file_search
vector_store_ids	matriz de strings	Os IDs dos repositórios de vetores a serem pesquisados.	Sim

OpenAI.FileSearchToolCallResults

Nome	Tipo	Obrigatório
attributes	OpenAI.VectorStoreFileAttributes ou nulo	No
file_id	cadeia	No
filename	cadeia	No
pontuação	número (flutuante)	No
enviar SMS	cadeia	No

OpenAI.Filters

Tipo: OpenAI.ComparisonFilter ou OpenAI.CompoundFilter

OpenAI.FunctionAndCustomToolCallOutput

Discriminador para OpenAI.FunctionAndCustomToolCallOutput

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

Digite um valor	Schema
`input_text`	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
`input_image`	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.FunctionAndCustomToolCallOutputType		Sim

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Arquivo de entrada

Uma entrada de arquivo para o modelo.

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

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Imagem de entrada

Uma entrada de imagem para o modelo.

Nome	Tipo	Description	Obrigatório	Default
detail	OpenAI.ImageDetail		Sim
file_id	cadeia de caracteres ou nulo		No
image_url	cadeia de caracteres ou nulo		No
tipo	enumeração	O tipo do item de entrada. Sempre `input_image`. Valores possíveis: `input_image`	Sim	input_image

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Texto de entrada

Uma entrada de texto para o modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	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
Valores	`input_text` `input_image` `input_file`

OpenAI.FunctionCallItemStatus

Property	Valor
Type	cadeia
Valores	`in_progress` `completed` `incomplete`

OpenAI.FunctionCallOutputStatusEnum

Property	Valor
Type	cadeia
Valores	`in_progress` `completed` `incomplete`

OpenAI.FunctionCallStatus

Property	Valor
Type	cadeia
Valores	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellAction

Ação executiva da Shell

Execute um comando de shell.

Nome	Tipo	Obrigatório
commands	matriz de strings	Sim
max_output_length	inteiro ou nulo	Sim
tempo_de_espera_ms	inteiro ou nulo	Sim

OpenAI.FunctionShellActionParam

Ação de projéteis

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

Nome	Tipo	Description	Obrigatório
commands	matriz de strings	Comandos de shell ordenados para que o ambiente de execução seja executado.	Sim
max_output_length	inteiro ou nulo		No
tempo_de_espera_ms	inteiro ou nulo		No

OpenAI.FunctionShellCallEnvironment

Discriminador para OpenAI.FunctionShellCallEnvironment

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

Digite um valor	Schema
`local`	OpenAI.LocalEnvironmentResource
`container_reference`	OpenAI.ContainerReferenceResource

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.FunctionShellCallEnvironmentType		Sim

OpenAI.FunctionShellCallEnvironmentType

Property	Valor
Type	cadeia
Valores	`local` `container_reference`

OpenAI.FunctionShellCallItemParamEnvironment

O ambiente para executar os comandos do shell.

Discriminador para OpenAI.FunctionShellCallItemParamEnvironment

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

Digite um valor	Schema
`local`	OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.FunctionShellCallItemParamEnvironmentType		Sim

OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

Nome	Tipo	Description	Obrigatório	Default
container_id	cadeia	O ID do contêiner referenciado.	Sim
tipo	enumeração	Faz referência a um contêiner criado com o endpoint /v1/containers Valores possíveis: `container_reference`	Sim	container_reference

OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam

Nome	Tipo	Description	Obrigatório	Default
habilidades	array de OpenAI.LocalSkillParam	Uma lista opcional de habilidades. Restrições: máximoItens: 200	No
tipo	enumeração	Use um ambiente de computador local. Valores possíveis: `local`	Sim	local

OpenAI.FunctionShellCallItemParamEnvironmentType

Property	Valor
Type	cadeia
Valores	`local` `container_reference`

OpenAI.FunctionShellCallItemStatus

Status da chamada shell

Valores de status relatados para chamadas de ferramenta de shell.

Property	Valor
Type	cadeia
Valores	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputContent

Conteúdo de saída das chamadas de shell

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

Nome	Tipo	Description	Obrigatório
created_by	cadeia	O identificador do ator que criou o item.	No
resultado	OpenAI.FunctionShellCallOutputOutcome	Representa um resultado de saída (com um código de saída) ou um resultado de tempo limite para uma parte de saída de chamada de shell.	Sim
└─ tipo	OpenAI.FunctionShellCallOutputOutcomeType		Sim
Stderr	cadeia	A saída de erro padrão que foi capturada.	Sim
stdout	cadeia	A saída padrão que foi capturada.	Sim

OpenAI.FunctionShellCallOutputContentParam

Conteúdo de saída do shell

Stdout e stderr capturados para uma parte de uma saída de chamada de ferramenta de shell.

Nome	Tipo	Description	Obrigatório
resultado	OpenAI.FunctionShellCallOutputOutcomeParam	O resultado de saída ou tempo limite associado a essa chamada de shell.	Sim
└─ tipo	OpenAI.FunctionShellCallOutputOutcomeParamType		Sim
Stderr	cadeia	Saída stderr capturada para a chamada de shell. Restrições: maxLength: 10485760	Sim
stdout	cadeia	Saída stdout capturada para a chamada de shell. Restrições: maxLength: 10485760	Sim

OpenAI.FunctionShellCallOutputExitOutcome

Resultado de saída de chamadas shell

Indica que os comandos do shell foram concluídos e retornaram um código de saída.

Nome	Tipo	Description	Obrigatório	Default
exit_code	inteiro	Saia do código do processo de shell.	Sim
tipo	enumeração	O tipo de resultado. Sempre `exit`. Valores possíveis: `exit`	Sim	encerrar

OpenAI.FunctionShellCallOutputExitOutcomeParam

Resultado de saída de chamadas shell

Indica que os comandos do shell foram concluídos e retornaram um código de saída.

Nome	Tipo	Description	Obrigatório	Default
exit_code	inteiro	O código de saída retornado pelo processo shell.	Sim
tipo	enumeração	O tipo de resultado. Sempre `exit`. Valores possíveis: `exit`	Sim	encerrar

OpenAI.FunctionShellCallOutputOutcome

Resultado da chamada shell

Representa um resultado de saída (com um código de saída) ou um resultado de tempo limite para uma parte de saída de chamada de shell.

Discriminador para OpenAI.FunctionShellCallOutputOutcome

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

Digite um valor	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcome
`exit`	OpenAI.FunctionShellCallOutputExitOutcome

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.FunctionShellCallOutputOutcomeType		Sim

OpenAI.FunctionShellCallOutputOutcomeParam

Resultado da chamada shell

O resultado de saída ou tempo limite associado a essa chamada de shell.

Discriminador para OpenAI.FunctionShellCallOutputOutcomeParam

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

Digite um valor	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
`exit`	OpenAI.FunctionShellCallOutputExitOutcomeParam

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.FunctionShellCallOutputOutcomeParamType		Sim

OpenAI.FunctionShellCallOutputOutcomeParamType

Property	Valor
Type	cadeia
Valores	`timeout` `exit`

OpenAI.FunctionShellCallOutputOutcomeType

Property	Valor
Type	cadeia
Valores	`timeout` `exit`

OpenAI.FunctionShellCallOutputStatusEnum

Property	Valor
Type	cadeia
Valores	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputTimeoutOutcome

Resultado do tempo limite da chamada shell

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

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

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Resultado do tempo limite da chamada shell

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

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

OpenAI.FunctionShellCallStatus

Property	Valor
Type	cadeia
Valores	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellToolParam

Ferramenta de concha

Uma ferramenta que permite que o modelo execute comandos de shell.

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

OpenAI.FunctionShellToolParamEnvironment

Discriminador para OpenAI.FunctionShellToolParamEnvironment

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

Digite um valor	Schema
`local`	OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam
`container_auto`	OpenAI.ContainerAutoParam

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.FunctionShellToolParamEnvironmentType		Sim

OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam

Nome	Tipo	Description	Obrigatório	Default
container_id	cadeia	O ID do contêiner referenciado.	Sim
tipo	enumeração	Faz referência a um contêiner criado com o endpoint /v1/containers Valores possíveis: `container_reference`	Sim	container_reference

OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam

Nome	Tipo	Description	Obrigatório	Default
habilidades	array de OpenAI.LocalSkillParam	Uma lista opcional de habilidades. Restrições: máximoItens: 200	No
tipo	enumeração	Use um ambiente de computador local. Valores possíveis: `local`	Sim	local

OpenAI.FunctionShellToolParamEnvironmentType

Property	Valor
Type	cadeia
Valores	`container_auto` `local` `container_reference`

OpenAI.FunctionTool

Função

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

Nome	Tipo	Description	Obrigatório	Default
defer_loading	boolean	Se essa função é diferida e carregada via busca por ferramenta.	No
description	cadeia de caracteres ou nulo		No
nome	cadeia	O nome da função a ser chamada.	Sim
parameters	objeto ou nulo		Sim
rigoroso	booliano ou nulo		Sim
tipo	enumeração	O tipo da ferramenta de função. Sempre `function`. Valores possíveis: `function`	Sim	função

OpenAI.FunctionToolParam

Nome	Tipo	Description	Obrigatório	Default
defer_loading	boolean	Se essa função deve ser adiada e descoberta por meio de busca por ferramenta.	No
description	cadeia de caracteres ou nulo		No
nome	cadeia	Restrições: minComprimento: 1, máximoComprimento: 128, padrão: `^[a-zA-Z0-9_-]+$`	Sim
parameters	OpenAI.EmptyModelParam ou null		No
rigoroso	booliano ou nulo		No
tipo	enumeração	Valores possíveis: `function`	Sim	função

OpenAI.GrammarSyntax1

Property	Valor
Type	cadeia
Valores	`lark` `regex`

OpenAI.HybridSearchOptions

Nome	Tipo	Description	Obrigatório	Default
embedding_weight	número	O peso da inserção na fusão de classificação recíproca.	Sim
text_weight	número	O peso do texto na fusão de classificação recíproca.	Sim

OpenAI.ImageDetail

Property	Valor
Type	cadeia
Valores	`low` `high` `auto` `original`

OpenAI.ImageGenActionEnum

Property	Valor
Type	cadeia
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

Nome	Tipo	Description	Obrigatório	Default
ação	OpenAI.ImageGenActionEnum		No
em segundo plano	enumeração	Tipo de plano de fundo para a imagem gerada. Uma opção entre `transparent`, `opaque` ou `auto`. Padrão: `auto`. Valores possíveis: `transparent`, , `opaqueauto`	No	automático
fidelidade_de_entrada	OpenAI.InputFidelity ou null		No
input_image_mask	OpenAI.ImageGenToolInputImageMask		No
└─ identificador_de_arquivo	cadeia		No
└─ URL da imagem	cadeia de caracteres (uri)		No
modelo	cadeia de caracteres (veja os modelos válidos abaixo)		No
Moderação	enumeração	Nível de moderação para a imagem gerada. Padrão: `auto`. Valores possíveis: `auto`, `low`	No	automático
compressão_de_saída	inteiro	Nível de compactação para a imagem de saída. Padrão: 100. Restrições: min: 0, máximo: 100	No	100
formato de saída	enumeração	O formato de saída da imagem gerada. Um de `png`, `webp`, ou `jpeg`. Padrão: `png`. Valores possíveis: `png`, , `webpjpeg`	No	png
imagens parciais	inteiro	Número de imagens parciais a serem geradas no modo de streaming, de 0 (valor padrão) a 3. Restrições: min: 0, max: 3	No
Qualidade	enumeração	A qualidade da imagem gerada. Um de `low`, `medium`, , `high` ou `auto`. Padrão: `auto`. Valores possíveis: `low`, , `medium`, `highauto`	No	automático
size	cadeia de caracteres (veja os 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`. Largura e altura devem ser ambas divisíveis por 16 e a proporção 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 também deve atender aos limites atuais de pixels 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 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

Nome	Tipo	Description	Obrigatório	Default
file_id	cadeia		No
image_url	cadeia de caracteres (uri)		No

OpenAI.IncludeEnum

Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Os valores com suporte no momento são:

web_search_call.results: Inclua os resultados da busca da chamada da ferramenta de busca web.
web_search_call.action.sources: inclua as fontes da chamada da ferramenta de pesquisa na Web.
code_interpreter_call.outputs: inclui as saídas da execução de código python em itens de chamada de ferramenta de interpretador de código.
computer_call_output.output.image_url: inclua urls de imagem da saída da chamada do computador.
file_search_call.results: inclua os resultados da pesquisa da chamada da ferramenta de pesquisa de arquivos.
message.input_image.image_url: inclua urls de imagem da mensagem de entrada.
message.output_text.logprobs: inclua logprobs com mensagens de assistente.
reasoning.encrypted_content: inclui uma versão criptografada de tokens de raciocínio em saídas de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em conversas de vários turnos ao utilizar a API de Respostas sem estado (como quando o parâmetro store é definido para false, ou quando uma organização está inscrita no programa de retenção de dados zero).

Property	Valor
Description	Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Os valores com suporte no momento são: - `web_search_call.results`: Inclua os resultados da busca da chamada da ferramenta de busca web. - `web_search_call.action.sources`: Inclua as fontes da ferramenta de busca web chamada . - `code_interpreter_call.outputs`: inclui os resultados da execução do código python nos itens de chamada da ferramenta interpretadora de código. - `computer_call_output.output.image_url`: inclua urls de imagem da saída da chamada do computador. - `file_search_call.results`: inclua os resultados da pesquisa da ferramenta de busca de arquivos. - `message.input_image.image_url`: inclua urls de imagem da mensagem de entrada. - `message.output_text.logprobs`: inclua logprobs com mensagens de assistente. - `reasoning.encrypted_content`: inclui uma versão criptografada de tokens de raciocínio nos resultados de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em conversas de vários turnos ao utilizar a API de Respostas sem estado (como quando o parâmetro `store` é definido para `false`, ou quando uma organização está inscrita no programa de retenção de dados zero).
Type	cadeia
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

Nome	Tipo	Description	Obrigatório	Default
description	cadeia	A descrição da habilidade.	Sim
nome	cadeia	O nome da habilidade.	Sim
fonte	OpenAI.InlineSkillSourceParam	Carga útil de habilidade inline	Sim
└─ dados	cadeia	Pacote zip de habilidades codificado em base64. Restrições: minComprimento: 1, maxComprimento: 70254592	Sim
└─ media_type	enumeração	O tipo de mídia da carga útil de habilidades inline. Deve ser `application/zip`. Valores possíveis: `application/zip`	Sim	application/zip
└─ tipo	enumeração	O tipo da fonte de habilidade inline. Deve ser `base64`. Valores possíveis: `base64`	Sim	base64
tipo	enumeração	Define uma habilidade inline para essa solicitação. Valores possíveis: `inline`	Sim	em linha

OpenAI.InlineSkillSourceParam

Carga útil de habilidade inline

Nome	Tipo	Description	Obrigatório	Default
dados	cadeia	Pacote zip de habilidades codificado em base64. Restrições: minComprimento: 1, maxComprimento: 70254592	Sim
media_type	enumeração	O tipo de mídia da carga útil de habilidades inline. Deve ser `application/zip`. Valores possíveis: `application/zip`	Sim	application/zip
tipo	enumeração	O tipo da fonte de habilidade inline. Deve ser `base64`. Valores possíveis: `base64`	Sim	base64

OpenAI.InputContent

Discriminador para OpenAI.InputContent

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

Digite um valor	Schema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputContentInputImageContent
`input_file`	OpenAI.InputContentInputFileContent

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.InputContentType		Sim

OpenAI.InputContentInputFileContent

Arquivo de entrada

Uma entrada de arquivo para o modelo.

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

OpenAI.InputContentInputImageContent

Imagem de entrada

Uma entrada de imagem para o modelo.

Nome	Tipo	Description	Obrigatório	Default
detail	OpenAI.ImageDetail		Sim
file_id	cadeia de caracteres ou nulo		No
image_url	cadeia de caracteres ou nulo		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.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	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
Valores	`input_text` `input_image` `input_file`

OpenAI.InputFidelity

Controlar o esforço que o modelo exercerá para corresponder ao estilo e aos recursos, especialmente os recursos faciais, das imagens de entrada. Esse parâmetro é suportado apenas para gpt-image-1 e gpt-image-1.5 modelos posteriores, não suportados para gpt-image-1-mini. Suportes high e low. Usa low como padrão.

Property	Valor
Type	cadeia
Valores	`high` `low`

OpenAI.InputFileContent

Arquivo de entrada

Uma entrada de arquivo para o modelo.

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

OpenAI.InputFileContentParam

Arquivo de entrada

Uma entrada de arquivo para o modelo.

Nome	Tipo	Description	Obrigatório	Default
detail	OpenAI.FileInputDetail		No
file_data	cadeia de caracteres ou nulo		No
file_id	cadeia de caracteres ou nulo		No
file_url	cadeia de caracteres ou nulo		No
filename	cadeia de caracteres ou nulo		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.

Nome	Tipo	Description	Obrigatório	Default
detail	OpenAI.ImageDetail		Sim
file_id	cadeia de caracteres ou nulo		No
image_url	cadeia de caracteres ou nulo		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

Nome	Tipo	Description	Obrigatório	Default
detail	OpenAI.DetailEnum ou null		No
file_id	cadeia de caracteres ou nulo		No
image_url	cadeia de caracteres ou nulo		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 entradas de texto, imagens e áudio, bem como respostas anteriores do assistente e saídas de chamadas de ferramenta.

Discriminador para OpenAI.InputItem

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

Digite um valor	Schema
`message`	OpenAI.EasyInputMessage
`item_reference`	OpenAI.ItemReferenceParam
`output_message`	OpenAI.InputItemOutputMessage
`file_search_call`	OpenAI.InputItemFileSearchToolCall
`computer_call`	OpenAI.InputItemComputerToolCall
`computer_call_output`	OpenAI.InputItemComputerCallOutputItemParam
`web_search_call`	OpenAI.InputItemWebSearchToolCall
`function_call`	OpenAI.InputItemFunctionToolCall
`function_call_output`	OpenAI.InputItemFunctionCallOutputItemParam
`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.InputItemMcpApprovalResponse
`mcp_call`	OpenAI.InputItemMcpToolCall
`custom_tool_call_output`	OpenAI.InputItemCustomToolCallOutput
`custom_tool_call`	OpenAI.InputItemCustomToolCall
`tool_approval_response`	AzureToolApprovalResponse

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.InputItemType		Sim

OpenAI.InputItemApplyPatchToolCallItemParam

Aplicar chamada de ferramenta de patch

Uma chamada de ferramenta que representa uma solicitação para criar, excluir ou atualizar arquivos usando patches dif.

Nome	Tipo	Description	Obrigatório	Default
call_id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch gerada pelo modelo. Restrições: minLength: 1, maxLength: 64	Sim
id	cadeia de caracteres ou nulo		No
operação	OpenAI.ApplyPatchOperationParam	Uma das operações de create_file, delete_file ou update_file fornecidas à ferramenta apply_patch.	Sim
└─ tipo	OpenAI.ApplyPatchOperationParamType		Sim
status	OpenAI.ApplyPatchCallStatusParam	Valores de status relatados para chamadas de ferramenta de apply_patch.	Sim
tipo	enumeração	O tipo do item. 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 aplicar patch.

Nome	Tipo	Description	Obrigatório	Default
call_id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch gerada pelo modelo. Restrições: minLength: 1, maxLength: 64	Sim
id	cadeia de caracteres ou nulo		No
saída	cadeia de caracteres ou nulo		No
status	OpenAI.ApplyPatchCallOutputStatusParam	Valores de resultado relatados para saídas de chamada de ferramenta de apply_patch.	Sim
tipo	enumeração	O tipo do item. 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 o código.

Nome	Tipo	Description	Obrigatório	Default
codificar	cadeia de caracteres ou nulo		Sim
container_id	cadeia	A ID do contêiner usado para executar o código.	Sim
id	cadeia	A ID exclusiva da chamada da ferramenta de intérprete de código.	Sim
outputs	matriz de OpenAI.CodeInterpreterOutputLogs ou OpenAI.CodeInterpreterOutputImage ou null		Sim
status	enumeração	O status da chamada da ferramenta de intérprete de código. Os valores válidos são `in_progress`, , `completed`, `incomplete`, `interpreting`e `failed`. Valores possíveis: `in_progress`, , `completed`, `incomplete`, `interpreting`, `failed`	Sim
tipo	enumeração	O tipo da chamada da ferramenta de intérprete de código. Sempre `code_interpreter_call`. Valores possíveis: `code_interpreter_call`	Sim	code_interpreter_call

OpenAI.InputItemCompactionSummaryItemParam

Item de compactação

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

Nome	Tipo	Description	Obrigatório	Default
encrypted_content	cadeia	O conteúdo criptografado do resumo da compactação. Restrições: maxLength: 10485760	Sim
id	cadeia de caracteres ou nulo		No
tipo	enumeração	O tipo do item. Sempre `compaction`. Valores possíveis: `compaction`	Sim	Compactação

OpenAI.InputItemComputerCallOutputItemParam

Saída de chamada de ferramenta de computador

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

Nome	Tipo	Description	Obrigatório	Default
acknowledged_safety_checks	array de OpenAI.ComputerCallSafetyCheckParam ou null		No
call_id	cadeia	A ID da chamada da ferramenta de computador que produziu a saída. Restrições: minLength: 1, maxLength: 64	Sim
id	cadeia de caracteres ou nulo		No
saída	OpenAI.ComputerScreenshotImage	Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.	Sim
status	OpenAI.FunctionCallItemStatus ou null		No
tipo	enumeração	O tipo da saída de chamada da ferramenta de computador. Sempre `computer_call_output`. Valores possíveis: `computer_call_output`	Sim	computer_call_output

OpenAI.InputItemComputerToolCall

Chamada de ferramenta de computador

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

Nome	Tipo	Description	Obrigatório	Default
ação	OpenAI.ComputerAction		No
actions	OpenAI.ComputerActionList	Ações em lote achatadas para `computer_use`. Cada ação inclui um `type` campos discriminadores e específicos de ação.	No
call_id	cadeia	Um identificador usado ao responder à chamada de ferramenta com saída.	Sim
id	cadeia	O identificador único da chamada do computador.	Sim
pending_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam	As verificações de segurança pendentes para a chamada de computador.	Sim
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Sim
tipo	enumeração	O tipo da chamada de computador. Sempre `computer_call`. Valores possíveis: `computer_call`	Sim	computer_call

OpenAI.InputItemCustomToolCall

Chamada de ferramenta personalizada

Uma chamada para uma ferramenta personalizada criada pelo modelo.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	Um identificador usado para mapear essa chamada de ferramenta personalizada para uma saída de chamada de ferramenta.	Sim
id	cadeia	A ID exclusiva da chamada de ferramenta personalizada na plataforma OpenAI.	No
entrada	cadeia	A entrada para a chamada de ferramenta personalizada gerada pelo modelo.	Sim
nome	cadeia	O nome da ferramenta personalizada que está sendo chamada.	Sim
espaço para nome	cadeia	O namespace da ferramenta personalizada que está sendo chamada.	No
tipo	enumeração	O tipo da chamada de ferramenta personalizada. Sempre `custom_tool_call`. Valores possíveis: `custom_tool_call`	Sim

OpenAI.InputItemCustomToolCallOutput

Saída personalizada de chamada de ferramenta

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

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID da chamada, usada para mapear essa saída de chamada de ferramenta personalizada para uma chamada de ferramenta personalizada.	Sim
id	cadeia	A ID exclusiva da saída de chamada de ferramenta personalizada na plataforma OpenAI.	No
saída	cadeia de caracteres ou matriz de OpenAI.FunctionAndCustomToolCallOutput	A saída da chamada de ferramenta personalizada gerada pelo seu código. Pode ser uma cadeia de caracteres ou uma lista de conteúdo de saída.	Sim
tipo	enumeração	O tipo da saída da chamada de ferramenta personalizada. Sempre `custom_tool_call_output`. Valores possíveis: `custom_tool_call_output`	Sim

OpenAI.InputItemFileSearchToolCall

Chamada de ferramenta de busca de arquivos

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

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada da ferramenta de pesquisa de arquivos.	Sim
Consultas	matriz de strings	As consultas usadas para pesquisar arquivos.	Sim
results	matriz de OpenAI.FileSearchToolCallResults ou null		No
status	enumeração	O status da chamada da ferramenta de pesquisa de arquivos. Uma opção entre `in_progress`, `searching`, `incomplete` ou `failed`, Valores possíveis: `in_progress`, , `searching`, `completed`, `incomplete`, `failed`	Sim
tipo	enumeração	O tipo da chamada da ferramenta de pesquisa de arquivo. Sempre `file_search_call`. Valores possíveis: `file_search_call`	Sim

OpenAI.InputItemFunctionCallOutputItemParam

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

A saída de uma chamada de ferramenta de função.

Nome	Tipo	Description	Obrigatório	Default
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo. Restrições: minLength: 1, maxLength: 64	Sim
id	cadeia de caracteres ou nulo		No
saída	cadeia de caracteres ou matriz de OpenAI.InputTextContentParam ou OpenAI.InputImageContentParamAutoParam ou OpenAI.InputFileContentParam	Saída de texto, imagem ou arquivo da chamada da ferramenta de função.	Sim
status	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 uma solicitação para executar um ou mais comandos de shell.

Nome	Tipo	Description	Obrigatório	Default
ação	OpenAI.FunctionShellActionParam	Comandos e limites que descrevem como executar a chamada de ferramenta do shell.	Sim
Comandos └─	matriz de strings	Comandos de shell ordenados para que o ambiente de execução seja executado.	Sim
└─ max_output_length	inteiro ou nulo		No
└─ timeout_ms	inteiro ou nulo		No
call_id	cadeia	A ID exclusiva da chamada de ferramenta de shell gerada pelo modelo. Restrições: minLength: 1, maxLength: 64	Sim
ambiente	OpenAI.FunctionShellCallItemParamEnvironment ou null		No
id	cadeia de caracteres ou nulo		No
status	OpenAI.FunctionShellCallItemStatus ou null		No
tipo	enumeração	O tipo do item. Sempre `shell_call`. Valores possíveis: `shell_call`	Sim	shell_call

OpenAI.InputItemFunctionShellCallOutputItemParam

Saída da chamada de ferramenta de shell

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

Nome	Tipo	Description	Obrigatório	Default
call_id	cadeia	A ID exclusiva da chamada de ferramenta de shell gerada pelo modelo. Restrições: minLength: 1, maxLength: 64	Sim
id	cadeia de caracteres ou nulo		No
max_output_length	inteiro ou nulo		No
saída	matriz de OpenAI.FunctionShellCallOutputContentParam	Partes capturadas de stdout e saída stderr, juntamente com seus resultados associados.	Sim
status	OpenAI.FunctionShellCallItemStatus ou null		No
tipo	enumeração	O tipo do item. 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.

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos a serem passados para a função.	Sim
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Sim
id	cadeia de caracteres (somente leitura)	A ID exclusiva da chamada da ferramenta de função.	Sim
nome	cadeia	O nome da função a ser executada.	Sim
espaço para nome	cadeia	O namespace da função a ser executada.	No
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da chamada da ferramenta de função. Sempre `function_call`. Valores possíveis: `function_call`	Sim

OpenAI.InputItemImageGenToolCall

Chamada de geração de imagem

Uma solicitação de geração de imagem feita pelo modelo.

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada de geração de imagem.	Sim
Resultado	cadeia de caracteres ou nulo		Sim
status	enumeração	O status da chamada de geração de imagem. Valores possíveis: `in_progress`, , `completed`, `generatingfailed`	Sim
tipo	enumeração	O tipo da 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.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.LocalShellExecAction	Execute um comando shell no servidor.	Sim
call_id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Sim
id	cadeia	A ID exclusiva da chamada de shell local.	Sim
status	enumeração	O status da chamada de shell local. Valores possíveis: `in_progress`, , `completedincomplete`	Sim
tipo	enumeração	O tipo da chamada de shell local. Sempre `local_shell_call`. Valores possíveis: `local_shell_call`	Sim

OpenAI.InputItemLocalShellToolCallOutput

Saída local de chamada de shell

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

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Sim
saída	cadeia	Uma cadeia de caracteres JSON da saída da chamada da ferramenta de shell local.	Sim
status	cadeia de caracteres ou nulo		No
tipo	enumeração	O tipo da saída da chamada da ferramenta de shell local. Sempre `local_shell_call_output`. Valores possíveis: `local_shell_call_output`	Sim

OpenAI.InputItemMcpApprovalRequest

Solicitação de aprovação do MCP

Uma solicitação de aprovação humana de uma invocação de ferramenta.

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma string JSON de argumentos para a ferramenta.	Sim
id	cadeia	A ID exclusiva da solicitação de aprovação.	Sim
nome	cadeia	O nome da ferramenta a ser executada.	Sim
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que está fazendo a solicitação.	Sim
tipo	enumeração	O tipo do item. Sempre `mcp_approval_request`. Valores possíveis: `mcp_approval_request`	Sim

OpenAI.InputItemMcpApprovalResponse

Resposta de aprovação do MCP

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

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia	A ID da solicitação de aprovação que está sendo respondida.	Sim
aprovar	boolean	Se a solicitação foi aprovada.	Sim
id	cadeia de caracteres ou nulo		No
reason	cadeia de caracteres ou nulo		No
tipo	enumeração	O tipo do item. 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.

Nome	Tipo	Description	Obrigatório
erro	OpenAI.RealtimeMCPError		No
id	cadeia	A ID exclusiva da lista.	Sim
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP.	Sim
tools	matriz de OpenAI.MCPListToolsTool	As ferramentas disponíveis no servidor.	Sim
tipo	enumeração	O tipo do item. 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.

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia de caracteres ou nulo		No
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta.	Sim
erro	OpenAI.RealtimeMCPError		No
id	cadeia	A ID exclusiva da chamada de ferramenta.	Sim
nome	cadeia	O nome da ferramenta que foi executada.	Sim
saída	cadeia de caracteres ou nulo		No
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que executa a ferramenta.	Sim
status	OpenAI.MCPToolCallStatus		No
tipo	enumeração	O tipo do item. Sempre `mcp_call`. Valores possíveis: `mcp_call`	Sim

OpenAI.InputItemOutputMessage

Mensagem de saída

Uma mensagem de saída do modelo.

Nome	Tipo	Description	Obrigatório
conteúdo	matriz de OpenAI.OutputMessageContent	O conteúdo da mensagem de saída.	Sim
id	cadeia	A identificação única 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
status	enumeração	O status da entrada da mensagem. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens de entrada são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	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 em inputpara a API de Respostas para as próximas rodadas de uma conversa se você estiver gerenciando manualmente o contexto.

Nome	Tipo	Description	Obrigatório
conteúdo	matriz de OpenAI.ReasoningTextContent	Conteúdo de texto de raciocínio.	No
encrypted_content	cadeia de caracteres ou nulo		No
id	cadeia	O identificador exclusivo do conteúdo de raciocínio.	Sim
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
resumo	array de OpenAI.ResumoTextoConteúdo	Conteúdo de resumo de raciocínio.	Sim
tipo	enumeração	O tipo do objeto. Sempre `reasoning`. Valores possíveis: `reasoning`	Sim

OpenAI.InputItemToolSearchCallItemParam

Nome	Tipo	Description	Obrigatório	Default
arguments	OpenAI.EmptyModelParam		Sim
call_id	cadeia de caracteres ou nulo		No
execução	OpenAI.ToolSearchExecutionType		No
id	cadeia de caracteres ou nulo		No
status	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

Nome	Tipo	Description	Obrigatório	Default
call_id	cadeia de caracteres ou nulo		No
execução	OpenAI.ToolSearchExecutionType		No
id	cadeia de caracteres ou nulo		No
status	OpenAI.FunctionCallItemStatus ou null		No
tools	matriz de OpenAI.Tool	As definições de ferramentas carregadas retornaram pela saída da busca 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

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 busca na web

Os resultados de uma chamada de ferramenta de pesquisa na Web.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.WebSearchActionSearch ou OpenAI.WebSearchActionOpenPage ou OpenAI.WebSearchActionFind	Um objeto que descreve a ação específica executada nesta chamada de pesquisa na Web. Inclui detalhes sobre como o modelo usou a web (busca, open_page, find_in_page).	Sim
id	cadeia	A ID exclusiva da chamada da ferramenta de pesquisa na Web.	Sim
status	enumeração	O status da chamada da ferramenta de pesquisa na Web. Valores possíveis: `in_progress`, , `searching`, `completedfailed`	Sim
tipo	enumeração	O tipo da chamada da ferramenta de pesquisa na Web. Sempre `web_search_call`. Valores possíveis: `web_search_call`	Sim

OpenAI.InputMessageContentList

Lista de conteúdo dos itens de entrada

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

Matriz de: OpenAI.InputContent

OpenAI.InputParam

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

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

Esse componente pode ser um dos seguintes:

string
array

OpenAI.InputTextContent

Texto de entrada

Uma entrada de texto para o modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	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.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	A entrada de texto para o modelo. Restrições: maxLength: 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 de item

Um identificador interno para um item a ser referenciado.

Nome	Tipo	Description	Obrigatório	Default
id	cadeia	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 para OpenAI.ItemResource

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

Digite um valor	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.ItemReasoningResourceReason
`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

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ItemResourceType		Sim

OpenAI.ItemResourceApplyPatchToolCall

Aplicar chamada de ferramenta de patch

Uma chamada de ferramenta que aplica diferenças de arquivo criando, excluindo ou atualizando arquivos.

Nome	Tipo	Description	Obrigatório	Default
call_id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch gerada pelo modelo.	Sim
created_by	cadeia	A ID da entidade que criou essa chamada de ferramenta.	No
id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch. Populado quando esse item é retornado por meio da API.	Sim
operação	OpenAI.ApplyPatchFileOperation	Uma das operações de create_file, delete_file ou update_file aplicadas por meio de apply_patch.	Sim
└─ tipo	OpenAI.ApplyPatchFileOperationType		Sim
status	OpenAI.ApplyPatchCallStatus		Sim
tipo	enumeração	O tipo do item. 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 aplicar patch.

Nome	Tipo	Description	Obrigatório	Default
call_id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch gerada pelo modelo.	Sim
created_by	cadeia	A ID da entidade que criou essa saída de chamada de ferramenta.	No
id	cadeia	A ID exclusiva da saída de chamada da ferramenta aplicar patch. Populado quando esse item é retornado por meio da API.	Sim
saída	cadeia de caracteres ou nulo		No
status	OpenAI.ApplyPatchCallOutputStatus		Sim
tipo	enumeração	O tipo do item. 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 o código.

Nome	Tipo	Description	Obrigatório	Default
codificar	cadeia de caracteres ou nulo		Sim
container_id	cadeia	A ID do contêiner usado para executar o código.	Sim
id	cadeia	A ID exclusiva da chamada da ferramenta de intérprete de código.	Sim
outputs	matriz de OpenAI.CodeInterpreterOutputLogs ou OpenAI.CodeInterpreterOutputImage ou null		Sim
status	enumeração	O status da chamada da ferramenta de intérprete de código. Os valores válidos são `in_progress`, , `completed`, `incomplete`, `interpreting`e `failed`. Valores possíveis: `in_progress`, , `completed`, `incomplete`, `interpreting`, `failed`	Sim
tipo	enumeração	O tipo da chamada da ferramenta de intérprete de código. Sempre `code_interpreter_call`. Valores possíveis: `code_interpreter_call`	Sim	code_interpreter_call

OpenAI.ItemResourceCompactionBody

Item de compactação

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

Nome	Tipo	Description	Obrigatório	Default
created_by	cadeia	O identificador do ator que criou o item.	No
encrypted_content	cadeia	O conteúdo criptografado que foi produzido pela compactação.	Sim
id	cadeia	A ID exclusiva do item de compactação.	Sim
tipo	enumeração	O tipo do item. Sempre `compaction`. Valores possíveis: `compaction`	Sim	Compactação

OpenAI.ItemResourceComputerToolCall

Chamada de ferramenta de computador

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

Nome	Tipo	Description	Obrigatório	Default
ação	OpenAI.ComputerAction		No
actions	OpenAI.ComputerActionList	Ações em lote achatadas para `computer_use`. Cada ação inclui um `type` campos discriminadores e específicos de ação.	No
call_id	cadeia	Um identificador usado ao responder à chamada de ferramenta com saída.	Sim
id	cadeia	O identificador único da chamada do computador.	Sim
pending_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam	As verificações de segurança pendentes para a chamada de computador.	Sim
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Sim
tipo	enumeração	O tipo da chamada de computador. Sempre `computer_call`. Valores possíveis: `computer_call`	Sim	computer_call

OpenAI.ItemResourceComputerToolCallOutput

Saída de chamada de ferramenta de computador

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

Nome	Tipo	Description	Obrigatório	Default
acknowledged_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam	As verificações de segurança relatadas pela API que foram confirmadas pela desenvolvedor.	No
call_id	cadeia	A ID da chamada da ferramenta de computador que produziu a saída.	Sim
id	cadeia de caracteres (somente leitura)	A 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
status	enumeração	O status da entrada da mensagem. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens de entrada são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da saída de chamada da ferramenta de computador. Sempre `computer_call_output`. Valores possíveis: `computer_call_output`	Sim	computer_call_output

OpenAI.ItemResourceCustomToolCallOutputResource

ItemRespostaCustomToolCallCallOutput

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID da chamada, usada para mapear essa saída de chamada de ferramenta personalizada para uma chamada de ferramenta personalizada.	Sim
created_by	cadeia	O identificador do ator que criou o item.	No
id	cadeia	A ID exclusiva da saída de chamada de ferramenta personalizada na plataforma OpenAI.	No
saída	cadeia de caracteres ou matriz de OpenAI.FunctionAndCustomToolCallOutput	A saída da chamada de ferramenta personalizada gerada pelo seu código. Pode ser uma cadeia de caracteres ou uma lista de conteúdo de saída.	Sim
status	OpenAI.FunctionCallOutputStatusEnum		Sim
tipo	enumeração	O tipo da saída da chamada de ferramenta personalizada. Sempre `custom_tool_call_output`. Valores possíveis: `custom_tool_call_output`	Sim

OpenAI.ItemResourceCustomToolCallResource

ItemRespostaCustomChamadaFerramenta

Nome	Tipo	Description	Obrigatório
call_id	cadeia	Um identificador usado para mapear essa chamada de ferramenta personalizada para uma saída de chamada de ferramenta.	Sim
created_by	cadeia	O identificador do ator que criou o item.	No
id	cadeia	A ID exclusiva da chamada de ferramenta personalizada na plataforma OpenAI.	No
entrada	cadeia	A entrada para a chamada de ferramenta personalizada gerada pelo modelo.	Sim
nome	cadeia	O nome da ferramenta personalizada que está sendo chamada.	Sim
espaço para nome	cadeia	O namespace da ferramenta personalizada que está sendo chamada.	No
status	OpenAI.FunctionCallStatus		Sim
tipo	enumeração	O tipo da chamada de ferramenta personalizada. Sempre `custom_tool_call`. Valores possíveis: `custom_tool_call`	Sim

OpenAI.ItemResourceFileSearchToolCall

Chamada de ferramenta de busca de arquivos

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

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada da ferramenta de pesquisa de arquivos.	Sim
Consultas	matriz de strings	As consultas usadas para pesquisar arquivos.	Sim
results	matriz de OpenAI.FileSearchToolCallResults ou null		No
status	enumeração	O status da chamada da ferramenta de pesquisa de arquivos. Uma opção entre `in_progress`, `searching`, `incomplete` ou `failed`, Valores possíveis: `in_progress`, , `searching`, `completed`, `incomplete`, `failed`	Sim
tipo	enumeração	O tipo da chamada da ferramenta de pesquisa de arquivo. 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 em um ambiente gerenciado.

Nome	Tipo	Description	Obrigatório	Default
ação	OpenAI.FunctionShellAction	Execute um comando de shell.	Sim
Comandos └─	matriz de strings		Sim
└─ max_output_length	inteiro ou nulo		Sim
└─ timeout_ms	inteiro ou nulo		Sim
call_id	cadeia	A ID exclusiva da chamada de ferramenta de shell gerada pelo modelo.	Sim
created_by	cadeia	A ID da entidade que criou essa chamada de ferramenta.	No
ambiente	OpenAI.FunctionShellCallEnvironment ou null		Sim
id	cadeia	A ID exclusiva da chamada da ferramenta shell. Populado quando esse item é retornado por meio da API.	Sim
status	OpenAI.FunctionShellCallStatus		Sim
tipo	enumeração	O tipo do item. 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 de shell que foi emitida.

Nome	Tipo	Description	Obrigatório	Default
call_id	cadeia	A ID exclusiva da chamada de ferramenta de shell gerada pelo modelo.	Sim
created_by	cadeia	O identificador do ator que criou o item.	No
id	cadeia	A ID exclusiva da saída de chamada do shell. Populado quando esse item é retornado por meio da API.	Sim
max_output_length	inteiro ou nulo		Sim
saída	matriz de OpenAI.FunctionShellCallOutputContent	Uma matriz de conteúdo de saída de chamada de shell	Sim
status	OpenAI.FunctionShellCallOutputStatusEnum		Sim
tipo	enumeração	O tipo da saída da chamada de 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.

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos a serem passados para a função.	Sim
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Sim
id	cadeia de caracteres (somente leitura)	A ID exclusiva da chamada da ferramenta de função.	Sim
nome	cadeia	O nome da função a ser executada.	Sim
espaço para nome	cadeia	O namespace da função a ser executada.	No
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da chamada da ferramenta de função. Sempre `function_call`. Valores possíveis: `function_call`	Sim

OpenAI.ItemResourceFunctionToolCallOutput

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

A saída de uma chamada de ferramenta de função.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Sim
id	cadeia de caracteres (somente leitura)	A ID exclusiva da saída da chamada da ferramenta de função. Populado quando este item é retornado por meio da API.	Sim
saída	cadeia de caracteres ou matriz de OpenAI.FunctionAndCustomToolCallOutput	A saída da chamada de função gerada pelo código. Pode ser uma cadeia de caracteres ou uma lista de conteúdo de saída.	Sim
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da saída de chamada da ferramenta de função. Sempre `function_call_output`. Valores possíveis: `function_call_output`	Sim

OpenAI.ItemResourceImageGenToolCall

Chamada de geração de imagem

Uma solicitação de geração de imagem feita pelo modelo.

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada de geração de imagem.	Sim
Resultado	cadeia de caracteres ou nulo		Sim
status	enumeração	O status da chamada de geração de imagem. Valores possíveis: `in_progress`, , `completed`, `generatingfailed`	Sim
tipo	enumeração	O tipo da chamada de geração de imagem. Sempre `image_generation_call`. Valores possíveis: `image_generation_call`	Sim

OpenAI.ItemResourceInputMessage

Mensagem de entrada

Nome	Tipo	Description	Obrigatório	Default
conteúdo	OpenAI.InputMessageContentList	Uma lista de um ou muitos itens de entrada para o modelo, contendo conteúdo diferente types.	Sim
id	cadeia de caracteres (somente leitura)	A ID exclusiva da entrada da mensagem.	Sim
função	enumeração	A função da entrada de mensagem. Uma opção entre `user`, `system` ou `developer`. Valores possíveis: `user`, , `systemdeveloper`	Sim
status	enumeração	O status do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo de entrada da mensagem. Sempre defina como `message`. Valores possíveis: `message`	Sim	mensagem

OpenAI.ItemResourceLocalShellToolCall

Chamada local de shell

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

Nome	Tipo	Description	Obrigatório
ação	OpenAI.LocalShellExecAction	Execute um comando shell no servidor.	Sim
call_id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Sim
id	cadeia	A ID exclusiva da chamada de shell local.	Sim
status	enumeração	O status da chamada de shell local. Valores possíveis: `in_progress`, , `completedincomplete`	Sim
tipo	enumeração	O tipo da chamada de shell local. Sempre `local_shell_call`. Valores possíveis: `local_shell_call`	Sim

OpenAI.ItemResourceLocalShellToolCallOutput

Saída local de chamada de shell

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

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Sim
saída	cadeia	Uma cadeia de caracteres JSON da saída da chamada da ferramenta de shell local.	Sim
status	cadeia de caracteres ou nulo		No
tipo	enumeração	O tipo da saída da chamada da ferramenta de shell local. Sempre `local_shell_call_output`. Valores possíveis: `local_shell_call_output`	Sim

OpenAI.ItemResourceMcpApprovalRequest

Solicitação de aprovação do MCP

Uma solicitação de aprovação humana de uma invocação de ferramenta.

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma string JSON de argumentos para a ferramenta.	Sim
id	cadeia	A ID exclusiva da solicitação de aprovação.	Sim
nome	cadeia	O nome da ferramenta a ser executada.	Sim
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que está fazendo a solicitação.	Sim
tipo	enumeração	O tipo do item. 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 do MCP.

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia	A ID da solicitação de aprovação que está sendo respondida.	Sim
aprovar	boolean	Se a solicitação foi aprovada.	Sim
id	cadeia	A ID exclusiva da resposta de aprovação	Sim
reason	cadeia de caracteres ou nulo		No
tipo	enumeração	O tipo do item. 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.

Nome	Tipo	Description	Obrigatório
erro	OpenAI.RealtimeMCPError		No
id	cadeia	A ID exclusiva da lista.	Sim
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP.	Sim
tools	matriz de OpenAI.MCPListToolsTool	As ferramentas disponíveis no servidor.	Sim
tipo	enumeração	O tipo do item. 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.

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia de caracteres ou nulo		No
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta.	Sim
erro	OpenAI.RealtimeMCPError		No
id	cadeia	A ID exclusiva da chamada de ferramenta.	Sim
nome	cadeia	O nome da ferramenta que foi executada.	Sim
saída	cadeia de caracteres ou nulo		No
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que executa a ferramenta.	Sim
status	OpenAI.MCPToolCallStatus		No
tipo	enumeração	O tipo do item. Sempre `mcp_call`. Valores possíveis: `mcp_call`	Sim

OpenAI.ItemResourceOutputMessage

Mensagem de saída

Uma mensagem de saída do modelo.

Nome	Tipo	Description	Obrigatório
conteúdo	matriz de OpenAI.OutputMessageContent	O conteúdo da mensagem de saída.	Sim
id	cadeia	A identificação única 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
status	enumeração	O status da entrada da mensagem. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens de entrada são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Sim
tipo	enumeração	O tipo da mensagem de saída. Sempre `message`. Valores possíveis: `output_message`	Sim

OpenAI.ItemReasoningResourceReason

Reasoning

Nome	Tipo	Description	Obrigatório
conteúdo	matriz de OpenAI.ReasoningTextContent	Conteúdo de texto de raciocínio.	No
encrypted_content	cadeia de caracteres ou nulo		No
id	cadeia	O identificador exclusivo do conteúdo de raciocínio.	Sim
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
resumo	array de OpenAI.ResumoTextoConteúdo	Conteúdo de resumo de raciocínio.	Sim
tipo	enumeração	O tipo do objeto. Sempre `reasoning`. Valores possíveis: `reasoning`	Sim

OpenAI.ItemResourceToolSearchCall

Nome	Tipo	Description	Obrigatório	Default
arguments		Argumentos usados para a chamada de busca de ferramenta.	Sim
call_id	cadeia de caracteres ou nulo		Sim
created_by	cadeia	O identificador do ator que criou o item.	No
execução	OpenAI.ToolSearchExecutionType		Sim
id	cadeia	O ID único do item de chamada de busca da ferramenta.	Sim
status	OpenAI.FunctionCallStatus		Sim
tipo	enumeração	O tipo do item. Sempre `tool_search_call`. Valores possíveis: `tool_search_call`	Sim	tool_search_call

OpenAI.ItemResourceToolSearchOutput

Nome	Tipo	Description	Obrigatório	Default
call_id	cadeia de caracteres ou nulo		Sim
created_by	cadeia	O identificador do ator que criou o item.	No
execução	OpenAI.ToolSearchExecutionType		Sim
id	cadeia	O ID único do item de saída da busca da ferramenta.	Sim
status	OpenAI.FunctionCallOutputStatusEnum		Sim
tools	matriz de OpenAI.Tool	As definições carregadas de ferramentas retornadas pela busca de ferramenta.	Sim
tipo	enumeração	O tipo do item. Sempre `tool_search_output`. Valores possíveis: `tool_search_output`	Sim	tool_search_output

OpenAI.ItemResourceType

Property Valor

Type cadeia

OpenAI.ItemResourceWebSearchToolCall

Chamada de ferramenta de busca na web

Os resultados de uma chamada de ferramenta de pesquisa na Web.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.WebSearchActionSearch ou OpenAI.WebSearchActionOpenPage ou OpenAI.WebSearchActionFind	Um objeto que descreve a ação específica executada nesta chamada de pesquisa na Web. Inclui detalhes sobre como o modelo usou a web (busca, open_page, find_in_page).	Sim
id	cadeia	A ID exclusiva da chamada da ferramenta de pesquisa na Web.	Sim
status	enumeração	O status da chamada da ferramenta de pesquisa na Web. Valores possíveis: `in_progress`, , `searching`, `completedfailed`	Sim
tipo	enumeração	O tipo da chamada da ferramenta de pesquisa na Web. Sempre `web_search_call`. Valores possíveis: `web_search_call`	Sim

OpenAI.KeyPressAction

KeyPress

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

Nome	Tipo	Description	Obrigatório	Default
keys	matriz de strings	A combinação de teclas que o modelo está solicitando que sejam pressionadas. Essa é uma matriz de cadeias de caracteres, cada uma representando uma chave.	Sim
tipo	enumeração	Especifica o tipo de evento. Para uma ação keypress, essa propriedade é sempre definida como `keypress`. Valores possíveis: `keypress`	Sim	Pressionar teclas

OpenAI.LocalEnvironmentResource

Ambiente Local

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

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

Nome	Tipo	Description	Obrigatório	Default
comando	matriz de strings	O comando a ser executado.	Sim
env	objeto	Variáveis de ambiente a serem definidas para o comando.	Sim
tempo_de_espera_ms	inteiro ou nulo		No
tipo	enumeração	O tipo da ação do shell local. Sempre `exec`. Valores possíveis: `exec`	Sim	exec
usuário	cadeia de caracteres ou nulo		No
working_directory	cadeia de caracteres ou nulo		No

OpenAI.LocalShellToolParam

Ferramenta local de concha

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

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

OpenAI.LocalSkillParam

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

OpenAI.LogProb

Probabilidade logarítmica

A probabilidade de log de um token.

Nome	Tipo	Obrigatório
bytes	matriz de inteiro	Sim
logprob	número	Sim
símbolo	cadeia	Sim
top_logprobs	matriz de OpenAI.TopLogProb	Sim

OpenAI.MCPListToolsTool

Ferramenta de listas MCP

Uma ferramenta disponível em um servidor MCP.

Nome	Tipo	Description	Obrigatório
annotations	OpenAI.MCPListToolsToolAnnotations ou null		No
description	cadeia de caracteres ou nulo		No
input_schema	OpenAI.MCPListToolsToolInputSchema		Sim
nome	cadeia	O nome da ferramenta.	Sim

OpenAI.MCPListToolsToolAnnotations

Tipo: objeto

OpenAI.MCPListToolsToolInputSchema

Tipo: objeto

OpenAI.MCPTool

Ferramenta MCP

Forneça ao modelo acesso a ferramentas adicionais por meio de servidores remotos do Protocolo de Contexto de Modelo (MCP).

Nome	Tipo	Description	Obrigatório
ferramentas_permitidas	matriz de cadeia de caracteres ou OpenAI.MCPToolFilter ou nulo		No
autorização	cadeia	Um token de acesso OAuth que pode ser usado com um servidor MCP remoto, com uma URL de servidor MCP personalizada ou um conector de serviço. Seu aplicativo deve lidar com o fluxo de autorização OAuth e fornecer o token aqui.	No
connector_id	enumeração	Identificador para conectores de serviço, como aqueles disponíveis no ChatGPT. Um dos `server_url` ou `connector_id` deve ser fornecido. Saiba mais sobre o serviço conectores aqui. Os valores com `connector_id` suporte no momento são: -Dropbox: `connector_dropbox` -Gmail: `connector_gmail` - Google Calendário: `connector_googlecalendar` - Google Drive: `connector_googledrive` - Microsoft Teams:`connector_microsoftteams` - calendário Outlook: `connector_outlookcalendar` - Email do Outlook: `connector_outlookemail` -Sharepoint: `connector_sharepoint` Valores possíveis: `connector_dropbox`, , `connector_gmail`, `connector_googlecalendar`, `connector_googledrive`, `connector_microsoftteams`, `connector_outlookcalendar`, , , `connector_outlookemailconnector_sharepoint`	No
defer_loading	boolean	Se essa ferramenta MCP é adiada e descoberta por meio de busca de ferramentas.	No
headers	objeto ou nulo		No
requer_aprovação	OpenAI.MCPToolRequireApproval ou cadeia de caracteres ou nulo		No
server_description	cadeia	Descrição opcional do servidor MCP, usada para fornecer mais contexto.	No
etiqueta_do_servidor	cadeia	Um rótulo para esse servidor MCP, usado para identificá-lo em chamadas de ferramenta.	Sim
URL_do_servidor	cadeia de caracteres (uri)	A URL do servidor MCP. Um de `server_url` ou `connector_id` deve ser Fornecido.	No
tipo	enumeração	O tipo da ferramenta MCP. Sempre `mcp`. Valores possíveis: `mcp`	Sim

OpenAI.MCPToolCallStatus

Property	Valor
Type	cadeia
Valores	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

Filtro de ferramenta MCP

Um objeto de filtro para especificar quais ferramentas são permitidas.

Nome	Tipo	Description	Obrigatório	Default
Read_only	boolean	Indica se uma ferramenta modifica ou não dados ou é somente leitura. Se um O servidor MCP é anotado com `readOnlyHint`, ele corresponderá a esse filtro.	No
tool_names	matriz de strings	Lista de nomes de ferramentas permitidos.	No

OpenAI.MCPToolRequireApproval

Nome	Tipo	Description	Obrigatório	Default
Sempre	OpenAI.MCPToolFilter	Um objeto de filtro para especificar quais ferramentas são permitidas.	No
never	OpenAI.MCPToolFilter	Um objeto de filtro para especificar quais ferramentas são permitidas.	No

OpenAI.MessageContent

Uma parte de conteúdo que compõe um item de entrada ou saída.

Discriminador para OpenAI.MessageContent

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

Digite um valor	Schema
`text`	OpenAI.TextContent
`computer_screenshot`	OpenAI.ComputerScreenshotContent
`input_text`	OpenAI.MessageContentInputTextContent
`output_text`	OpenAI.MessageContentOutputTextContent
`reasoning_text`	OpenAI.MessageContentReasoningTextContent
`refusal`	OpenAI.MessageContentRefusalContent
`input_image`	OpenAI.MessageContentInputImageContent
`input_file`	OpenAI.MessageContentInputFileContent
`summary_text`	OpenAI.SummaryTextContent

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.MessageContentType		Sim

OpenAI.MessageContentInputFileContent

Arquivo de entrada

Uma entrada de arquivo para o modelo.

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

OpenAI.MessageContentInputImageContent

Imagem de entrada

Uma entrada de imagem para o modelo.

Nome	Tipo	Description	Obrigatório	Default
detail	OpenAI.ImageDetail		Sim
file_id	cadeia de caracteres ou nulo		No
image_url	cadeia de caracteres ou nulo		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.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	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.

Nome	Tipo	Description	Obrigatório	Default
annotations	matriz de OpenAI.Annotation	As anotações da saída de texto.	Sim
logprobs	matriz de OpenAI.LogProb		Sim
enviar SMS	cadeia	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.MessageContentReasoningTextContent

Texto do raciocínio

Texto de raciocínio do modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	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.

Nome	Tipo	Description	Obrigatório	Default
Recusa	cadeia	A explicação da recusa do modelo.	Sim
tipo	enumeração	O tipo da recusa. Sempre `refusal`. Valores possíveis: `refusal`	Sim	Recusa

OpenAI.MessageContentType

Property	Valor
Type	cadeia
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 intermediário (commentary) ou a resposta final (final_answer). Para modelos como gpt-5.3-codex e outros, ao enviar requisições de acompanhamento, preserve e reenvie a fase em todas as mensagens do assistente — deixá-la cair pode degradar o desempenho. Não é usado para mensagens de usuário.

Property	Valor
Type	cadeia
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 por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.

Tipo: objeto

OpenAI.MoveParam

Move

Uma ação de movimentação do mouse.

Nome	Tipo	Description	Obrigatório	Default
keys	matriz de cadeia de caracteres 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	inteiro	A coordenada x para a qual mover.	Sim
y	inteiro	A coordenada y para a qual mover.	Sim

OpenAI.NamespaceToolParam

Namespace

Grupos funcional/ferramentas personalizadas em um namespace compartilhado.

Nome	Tipo	Description	Obrigatório	Default
description	cadeia	Uma descrição do namespace mostrada ao modelo. Restrições: minLength: 1	Sim
nome	cadeia	O nome do namespace usado em chamadas de ferramentas (por exemplo, `crm`). Restrições: minLength: 1	Sim
tools	array de OpenAI.FunctionToolParam ou OpenAI.CustomToolParam	As funções/ferramentas personalizadas disponíveis dentro desse namespace. Restrições: minItens: 1	Sim
tipo	enumeração	O tipo da ferramenta. Sempre `namespace`. Valores possíveis: `namespace`	Sim	espaço para nome

OpenAI.OutputContent

Discriminador para OpenAI.OutputContent

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

Digite um valor	Schema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent
`reasoning_text`	OpenAI.OutputContentReasoningTextContent

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.OutputContentType		Sim

OpenAI.OutputContentOutputTextContent

Texto de saída

Uma saída de texto do modelo.

Nome	Tipo	Description	Obrigatório	Default
annotations	matriz de OpenAI.Annotation	As anotações da saída de texto.	Sim
logprobs	matriz de OpenAI.LogProb		Sim
enviar SMS	cadeia	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 do raciocínio

Texto de raciocínio do modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	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.

Nome	Tipo	Description	Obrigatório	Default
Recusa	cadeia	A explicação da recusa do modelo.	Sim
tipo	enumeração	O tipo da recusa. Sempre `refusal`. Valores possíveis: `refusal`	Sim	Recusa

OpenAI.OutputContentType

Property	Valor
Type	cadeia
Valores	`output_text` `refusal` `reasoning_text`

OpenAI.OutputItem

Discriminador para OpenAI.OutputItem

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

Digite um valor	Schema
`output_message`	OpenAI.OutputItemOutputMessage
`file_search_call`	OpenAI.OutputItemFileSearchToolCall
`function_call`	OpenAI.OutputItemFunctionToolCall
`function_call_output`	OpenAI.SaídaItemFunçãoFerramentaChamadaSaída
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`computer_call_output`	OpenAI.OutputItemComputadorFerramentaChamadaSaída
`reasoning`	OpenAI.OutputItemReasoningItem
`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

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.OutputItemType		Sim

OpenAI.OutputItemApplyPatchToolCall

Aplicar chamada de ferramenta de patch

Uma chamada de ferramenta que aplica diferenças de arquivo criando, excluindo ou atualizando arquivos.

Nome	Tipo	Description	Obrigatório	Default
call_id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch gerada pelo modelo.	Sim
created_by	cadeia	A ID da entidade que criou essa chamada de ferramenta.	No
id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch. Populado quando esse item é retornado por meio da API.	Sim
operação	OpenAI.ApplyPatchFileOperation	Uma das operações de create_file, delete_file ou update_file aplicadas por meio de apply_patch.	Sim
└─ tipo	OpenAI.ApplyPatchFileOperationType		Sim
status	OpenAI.ApplyPatchCallStatus		Sim
tipo	enumeração	O tipo do item. 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 aplicar patch.

Nome	Tipo	Description	Obrigatório	Default
call_id	cadeia	A ID exclusiva da chamada da ferramenta aplicar patch gerada pelo modelo.	Sim
created_by	cadeia	A ID da entidade que criou essa saída de chamada de ferramenta.	No
id	cadeia	A ID exclusiva da saída de chamada da ferramenta aplicar patch. Populado quando esse item é retornado por meio da API.	Sim
saída	cadeia de caracteres ou nulo		No
status	OpenAI.ApplyPatchCallOutputStatus		Sim
tipo	enumeração	O tipo do item. 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 o código.

Nome	Tipo	Description	Obrigatório	Default
codificar	cadeia de caracteres ou nulo		Sim
container_id	cadeia	A ID do contêiner usado para executar o código.	Sim
id	cadeia	A ID exclusiva da chamada da ferramenta de intérprete de código.	Sim
outputs	matriz de OpenAI.CodeInterpreterOutputLogs ou OpenAI.CodeInterpreterOutputImage ou null		Sim
status	enumeração	O status da chamada da ferramenta de intérprete de código. Os valores válidos são `in_progress`, , `completed`, `incomplete`, `interpreting`e `failed`. Valores possíveis: `in_progress`, , `completed`, `incomplete`, `interpreting`, `failed`	Sim
tipo	enumeração	O tipo da chamada da ferramenta de intérprete de código. Sempre `code_interpreter_call`. Valores possíveis: `code_interpreter_call`	Sim	code_interpreter_call

OpenAI.OutputItemCompactionBody

Item de compactação

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

Nome	Tipo	Description	Obrigatório	Default
created_by	cadeia	O identificador do ator que criou o item.	No
encrypted_content	cadeia	O conteúdo criptografado que foi produzido pela compactação.	Sim
id	cadeia	A ID exclusiva do item de compactação.	Sim
tipo	enumeração	O tipo do item. Sempre `compaction`. Valores possíveis: `compaction`	Sim	Compactação

OpenAI.OutputItemComputerToolCall

Chamada de ferramenta de computador

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

Nome	Tipo	Description	Obrigatório	Default
ação	OpenAI.ComputerAction		No
actions	OpenAI.ComputerActionList	Ações em lote achatadas para `computer_use`. Cada ação inclui um `type` campos discriminadores e específicos de ação.	No
call_id	cadeia	Um identificador usado ao responder à chamada de ferramenta com saída.	Sim
id	cadeia	O identificador único da chamada do computador.	Sim
pending_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam	As verificações de segurança pendentes para a chamada de computador.	Sim
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Sim
tipo	enumeração	O tipo da chamada de computador. Sempre `computer_call`. Valores possíveis: `computer_call`	Sim	computer_call

OpenAI.OutputItemComputadorFerramentaChamadaSaída

Saída de chamada de ferramenta de computador

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

Nome	Tipo	Description	Obrigatório	Default
acknowledged_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam	As verificações de segurança relatadas pela API que foram confirmadas pela desenvolvedor.	No
call_id	cadeia	A ID da chamada da ferramenta de computador que produziu a saída.	Sim
id	cadeia de caracteres (somente leitura)	A 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
status	enumeração	O status da entrada da mensagem. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens de entrada são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da saída de chamada da ferramenta de computador. Sempre `computer_call_output`. Valores possíveis: `computer_call_output`	Sim	computer_call_output

OpenAI.OutputItemCustomToolCallOutputResource

ItemRespostaCustomToolCallCallOutput

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID da chamada, usada para mapear essa saída de chamada de ferramenta personalizada para uma chamada de ferramenta personalizada.	Sim
created_by	cadeia	O identificador do ator que criou o item.	No
id	cadeia	A ID exclusiva da saída de chamada de ferramenta personalizada na plataforma OpenAI.	No
saída	cadeia de caracteres ou matriz de OpenAI.FunctionAndCustomToolCallOutput	A saída da chamada de ferramenta personalizada gerada pelo seu código. Pode ser uma cadeia de caracteres ou uma lista de conteúdo de saída.	Sim
status	OpenAI.FunctionCallOutputStatusEnum		Sim
tipo	enumeração	O tipo da saída da chamada de ferramenta personalizada. Sempre `custom_tool_call_output`. Valores possíveis: `custom_tool_call_output`	Sim

OpenAI.OutputItemCustomToolCallResource

ItemRespostaCustomChamadaFerramenta

Nome	Tipo	Description	Obrigatório
call_id	cadeia	Um identificador usado para mapear essa chamada de ferramenta personalizada para uma saída de chamada de ferramenta.	Sim
created_by	cadeia	O identificador do ator que criou o item.	No
id	cadeia	A ID exclusiva da chamada de ferramenta personalizada na plataforma OpenAI.	No
entrada	cadeia	A entrada para a chamada de ferramenta personalizada gerada pelo modelo.	Sim
nome	cadeia	O nome da ferramenta personalizada que está sendo chamada.	Sim
espaço para nome	cadeia	O namespace da ferramenta personalizada que está sendo chamada.	No
status	OpenAI.FunctionCallStatus		Sim
tipo	enumeração	O tipo da chamada de ferramenta personalizada. Sempre `custom_tool_call`. Valores possíveis: `custom_tool_call`	Sim

OpenAI.OutputItemFileSearchToolCall

Chamada de ferramenta de busca de arquivos

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

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada da ferramenta de pesquisa de arquivos.	Sim
Consultas	matriz de strings	As consultas usadas para pesquisar arquivos.	Sim
results	matriz de OpenAI.FileSearchToolCallResults ou null		No
status	enumeração	O status da chamada da ferramenta de pesquisa de arquivos. Uma opção entre `in_progress`, `searching`, `incomplete` ou `failed`, Valores possíveis: `in_progress`, , `searching`, `completed`, `incomplete`, `failed`	Sim
tipo	enumeração	O tipo da chamada da ferramenta de pesquisa de arquivo. 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 em um ambiente gerenciado.

Nome	Tipo	Description	Obrigatório	Default
ação	OpenAI.FunctionShellAction	Execute um comando de shell.	Sim
Comandos └─	matriz de strings		Sim
└─ max_output_length	inteiro ou nulo		Sim
└─ timeout_ms	inteiro ou nulo		Sim
call_id	cadeia	A ID exclusiva da chamada de ferramenta de shell gerada pelo modelo.	Sim
created_by	cadeia	A ID da entidade que criou essa chamada de ferramenta.	No
ambiente	OpenAI.FunctionShellCallEnvironment ou null		Sim
id	cadeia	A ID exclusiva da chamada da ferramenta shell. Populado quando esse item é retornado por meio da API.	Sim
status	OpenAI.FunctionShellCallStatus		Sim
tipo	enumeração	O tipo do item. 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 de shell que foi emitida.

Nome	Tipo	Description	Obrigatório	Default
call_id	cadeia	A ID exclusiva da chamada de ferramenta de shell gerada pelo modelo.	Sim
created_by	cadeia	O identificador do ator que criou o item.	No
id	cadeia	A ID exclusiva da saída de chamada do shell. Populado quando esse item é retornado por meio da API.	Sim
max_output_length	inteiro ou nulo		Sim
saída	matriz de OpenAI.FunctionShellCallOutputContent	Uma matriz de conteúdo de saída de chamada de shell	Sim
status	OpenAI.FunctionShellCallOutputStatusEnum		Sim
tipo	enumeração	O tipo da saída da chamada de 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.

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos a serem passados para a função.	Sim
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Sim
id	cadeia de caracteres (somente leitura)	A ID exclusiva da chamada da ferramenta de função.	Sim
nome	cadeia	O nome da função a ser executada.	Sim
espaço para nome	cadeia	O namespace da função a ser executada.	No
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da chamada da ferramenta de função. Sempre `function_call`. Valores possíveis: `function_call`	Sim

OpenAI.SaídaItemFunçãoFerramentaChamadaSaída

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

A saída de uma chamada de ferramenta de função.

Nome	Tipo	Description	Obrigatório
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Sim
id	cadeia de caracteres (somente leitura)	A ID exclusiva da saída da chamada da ferramenta de função. Populado quando este item é retornado por meio da API.	Sim
saída	cadeia de caracteres ou matriz de OpenAI.FunctionAndCustomToolCallOutput	A saída da chamada de função gerada pelo código. Pode ser uma cadeia de caracteres ou uma lista de conteúdo de saída.	Sim
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
tipo	enumeração	O tipo da saída de chamada da ferramenta de função. Sempre `function_call_output`. Valores possíveis: `function_call_output`	Sim

OpenAI.OutputItemImageGenToolCall

Chamada de geração de imagem

Uma solicitação de geração de imagem feita pelo modelo.

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada de geração de imagem.	Sim
Resultado	cadeia de caracteres ou nulo		Sim
status	enumeração	O status da chamada de geração de imagem. Valores possíveis: `in_progress`, , `completed`, `generatingfailed`	Sim
tipo	enumeração	O tipo da 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.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.LocalShellExecAction	Execute um comando shell no servidor.	Sim
call_id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Sim
id	cadeia	A ID exclusiva da chamada de shell local.	Sim
status	enumeração	O status da chamada de shell local. Valores possíveis: `in_progress`, , `completedincomplete`	Sim
tipo	enumeração	O tipo da chamada de shell local. Sempre `local_shell_call`. Valores possíveis: `local_shell_call`	Sim

OpenAI.OutputItemLocalShellToolCallOutput

Saída local de chamada de shell

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

Nome	Tipo	Description	Obrigatório
id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Sim
saída	cadeia	Uma cadeia de caracteres JSON da saída da chamada da ferramenta de shell local.	Sim
status	cadeia de caracteres ou nulo		No
tipo	enumeração	O tipo da saída da chamada da ferramenta de shell local. Sempre `local_shell_call_output`. Valores possíveis: `local_shell_call_output`	Sim

OpenAI.OutputItemMcpApprovalRequest

Solicitação de aprovação do MCP

Uma solicitação de aprovação humana de uma invocação de ferramenta.

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma string JSON de argumentos para a ferramenta.	Sim
id	cadeia	A ID exclusiva da solicitação de aprovação.	Sim
nome	cadeia	O nome da ferramenta a ser executada.	Sim
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que está fazendo a solicitação.	Sim
tipo	enumeração	O tipo do item. 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 do MCP.

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia	A ID da solicitação de aprovação que está sendo respondida.	Sim
aprovar	boolean	Se a solicitação foi aprovada.	Sim
id	cadeia	A ID exclusiva da resposta de aprovação	Sim
reason	cadeia de caracteres ou nulo		No
tipo	enumeração	O tipo do item. 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.

Nome	Tipo	Description	Obrigatório
erro	OpenAI.RealtimeMCPError		No
id	cadeia	A ID exclusiva da lista.	Sim
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP.	Sim
tools	matriz de OpenAI.MCPListToolsTool	As ferramentas disponíveis no servidor.	Sim
tipo	enumeração	O tipo do item. 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.

Nome	Tipo	Description	Obrigatório
approval_request_id	cadeia de caracteres ou nulo		No
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta.	Sim
erro	OpenAI.RealtimeMCPError		No
id	cadeia	A ID exclusiva da chamada de ferramenta.	Sim
nome	cadeia	O nome da ferramenta que foi executada.	Sim
saída	cadeia de caracteres ou nulo		No
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que executa a ferramenta.	Sim
status	OpenAI.MCPToolCallStatus		No
tipo	enumeração	O tipo do item. Sempre `mcp_call`. Valores possíveis: `mcp_call`	Sim

OpenAI.OutputItemOutputMessage

Mensagem de saída

Uma mensagem de saída do modelo.

Nome	Tipo	Description	Obrigatório
conteúdo	matriz de OpenAI.OutputMessageContent	O conteúdo da mensagem de saída.	Sim
id	cadeia	A identificação única 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
status	enumeração	O status da entrada da mensagem. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens de entrada são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Sim
tipo	enumeração	O tipo da mensagem de saída. Sempre `message`. Valores possíveis: `output_message`	Sim

OpenAI.OutputItemReasoningItem

Reasoning

Nome	Tipo	Description	Obrigatório
conteúdo	matriz de OpenAI.ReasoningTextContent	Conteúdo de texto de raciocínio.	No
encrypted_content	cadeia de caracteres ou nulo		No
id	cadeia	O identificador exclusivo do conteúdo de raciocínio.	Sim
status	enumeração	A situação do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	No
resumo	array de OpenAI.ResumoTextoConteúdo	Conteúdo de resumo de raciocínio.	Sim
tipo	enumeração	O tipo do objeto. Sempre `reasoning`. Valores possíveis: `reasoning`	Sim

OpenAI.OutputItemToolSearchCall

Nome	Tipo	Description	Obrigatório	Default
arguments		Argumentos usados para a chamada de busca de ferramenta.	Sim
call_id	cadeia de caracteres ou nulo		Sim
created_by	cadeia	O identificador do ator que criou o item.	No
execução	OpenAI.ToolSearchExecutionType		Sim
id	cadeia	O ID único do item de chamada de busca da ferramenta.	Sim
status	OpenAI.FunctionCallStatus		Sim
tipo	enumeração	O tipo do item. Sempre `tool_search_call`. Valores possíveis: `tool_search_call`	Sim	tool_search_call

OpenAI.OutputItemToolSearchOutput

Nome	Tipo	Description	Obrigatório	Default
call_id	cadeia de caracteres ou nulo		Sim
created_by	cadeia	O identificador do ator que criou o item.	No
execução	OpenAI.ToolSearchExecutionType		Sim
id	cadeia	O ID único do item de saída da busca da ferramenta.	Sim
status	OpenAI.FunctionCallOutputStatusEnum		Sim
tools	matriz de OpenAI.Tool	As definições carregadas de ferramentas retornadas pela busca de ferramenta.	Sim
tipo	enumeração	O tipo do item. Sempre `tool_search_output`. Valores possíveis: `tool_search_output`	Sim	tool_search_output

OpenAI.OutputItemType

Property Valor

Type cadeia

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 busca na web

Os resultados de uma chamada de ferramenta de pesquisa na Web.

Nome	Tipo	Description	Obrigatório
ação	OpenAI.WebSearchActionSearch ou OpenAI.WebSearchActionOpenPage ou OpenAI.WebSearchActionFind	Um objeto que descreve a ação específica executada nesta chamada de pesquisa na Web. Inclui detalhes sobre como o modelo usou a web (busca, open_page, find_in_page).	Sim
id	cadeia	A ID exclusiva da chamada da ferramenta de pesquisa na Web.	Sim
status	enumeração	O status da chamada da ferramenta de pesquisa na Web. Valores possíveis: `in_progress`, , `searching`, `completedfailed`	Sim
tipo	enumeração	O tipo da chamada da ferramenta de pesquisa na Web. Sempre `web_search_call`. Valores possíveis: `web_search_call`	Sim

OpenAI.OutputMessageContent

Discriminador para OpenAI.OutputMessageContent

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

Digite um valor	Schema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.OutputMessageContentType		Sim

OpenAI.OutputMessageContentOutputTextContent

Texto de saída

Uma saída de texto do modelo.

Nome	Tipo	Description	Obrigatório	Default
annotations	matriz de OpenAI.Annotation	As anotações da saída de texto.	Sim
logprobs	matriz de OpenAI.LogProb		Sim
enviar SMS	cadeia	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.

Nome	Tipo	Description	Obrigatório	Default
Recusa	cadeia	A explicação da recusa do modelo.	Sim
tipo	enumeração	O tipo da recusa. Sempre `refusal`. Valores possíveis: `refusal`	Sim	Recusa

OpenAI.OutputMessageContentType

Property	Valor
Type	cadeia
Valores	`output_text` `refusal`

OpenAI.Prompt

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

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

OpenAI.RankerVersionType

Property	Valor
Type	cadeia
Valores	`auto` `default-2024-11-15`

OpenAI.RankingOptions

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

OpenAI.RealtimeMCPError

Discriminador para OpenAI.RealtimeMCPError

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

Digite um valor	Schema
`protocol_error`	OpenAI.RealtimeMCPProtocolError
`tool_execution_error`	OpenAI.RealtimeMCPToolExecutionError
`http_error`	OpenAI.RealtimeMCPHTTPError

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.RealtimeMcpErrorType		Sim

OpenAI.RealtimeMCPHTTPError

Erro HTTP MCP em tempo real

Nome	Tipo	Description	Obrigatório
codificar	inteiro		Sim
mensagem	cadeia		Sim
tipo	enumeração	Valores possíveis: `http_error`	Sim

OpenAI.RealtimeMCPProtocolError

Erro do protocolo MCP em tempo real

Nome	Tipo	Description	Obrigatório
codificar	inteiro		Sim
mensagem	cadeia		Sim
tipo	enumeração	Valores possíveis: `protocol_error`	Sim

OpenAI.RealtimeMCPToolExecutionError

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

Nome	Tipo	Description	Obrigatório	Default
mensagem	cadeia		Sim
tipo	enumeração	Valores possíveis: `tool_execution_error`	Sim

OpenAI.RealtimeMcpErrorType

Property	Valor
Type	cadeia
Valores	`protocol_error` `tool_execution_error` `http_error`

OpenAI.Reasoning

Reasoning

somente modelos gpt-5 e série o Opções de configuração para modelos de raciocínio.

Nome	Tipo	Description	Obrigatório
Esforço	Esforço de Raciocínio da OpenAI	Restringe o esforço no raciocínio para modelos de raciocínio. Os valores com suporte no momento são `none`, , `minimal`, `low`, `medium`, `high`e `xhigh`. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados sobre o raciocínio em uma resposta. - `gpt-5.1` o padrão é `none`, que não executa o raciocínio. Os valores de raciocínio com suporte são`gpt-5.1`, e `nonelowmedium`.`high` Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. - Todos os modelos antes `gpt-5.1` do padrão para `medium` o esforço de raciocínio e não dão suporte `none`. - O `gpt-5-pro` modelo usa como padrão o esforço de raciocínio (e só dá `high` suporte). - `xhigh` há suporte para todos os modelos após `gpt-5.1-codex-max`.	No
generate_summary	cadeia de caracteres ou nulo		No
resumo	cadeia de caracteres ou nulo		No

Esforço de Raciocínio da OpenAI

Limita o esforço de raciocínio em modelos de raciocínio. Os valores com suporte no momento são none, , minimal, low, medium, highe xhigh. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta.

gpt-5.1 o padrão é none, que não executa o raciocínio. Os valores de raciocínio com suporte sãogpt-5.1, e nonelowmedium.high Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1.
Todos os modelos antes gpt-5.1 do padrão para medium o esforço de raciocínio e não dão suporte none.
O gpt-5-pro modelo usa como padrão o esforço de raciocínio (e só dá high suporte).
xhigh há suporte para todos os modelos após gpt-5.1-codex-max.

Property	Valor
Description	Restringe o esforço no raciocínio para modelos de raciocínio. Os valores com suporte no momento são `none`, , `minimal`, `low`, `medium`, `high`e `xhigh`. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados sobre o raciocínio em uma resposta. - `gpt-5.1` o padrão é `none`, que não executa o raciocínio. Os valores de raciocínio com suporte são`gpt-5.1`, e `nonelowmedium`.`high` Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1. - Todos os modelos antes `gpt-5.1` do padrão para `medium` o esforço de raciocínio e não dão suporte `none`. - O `gpt-5-pro` modelo usa como padrão o esforço de raciocínio (e só dá `high` suporte). - `xhigh` há suporte para todos os modelos após `gpt-5.1-codex-max`.
Type	cadeia
Valores	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

Texto do raciocínio

Texto de raciocínio do modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	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

Nome	Tipo	Description	Obrigatório	Default
em segundo plano	booliano ou nulo		No
concluído_em	cadeia de caracteres ou nulo		No
content_filters	matriz de AzureContentFilterForResponsesAPI	Os resultados do filtro de conteúdo da RAI.	No
conversa	OpenAI.ConversationReference ou nulo		No
criado_em	inteiro (unixtime)	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Sim
erro	OpenAI.ResponseError ou nulo		Sim
id	cadeia	Identificador exclusivo para esta resposta.	Sim
incomplete_details	OpenAI.ResponseIncompleteDetails ou null		Sim
instructions	cadeia de caracteres ou matriz de OpenAI.InputItem ou nulo		Sim
max_output_tokens	inteiro ou nulo		No
max_tool_calls	inteiro ou nulo		No
metadados	OpenAI.Metadata ou nulo		No
modelo	cadeia	ID do modelo usada para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma ampla gama de modelos com diferentes funcionalidades, desempenho características e pontos de preço. Consulte o guia de modelos para navegar e comparar os modelos disponíveis.	No
objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Sim
saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Sim
output_text	cadeia de caracteres ou nulo		No
parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
previous_response_id	cadeia de caracteres ou nulo		No
solicitação	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	No
prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo.	No
prompt_cache_retention	cadeia de caracteres ou nulo		No
reasoning	OpenAI.Reasoning ou nulo		No
safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. Os IDs devem ser uma string que identifique unicamente cada usuário, com um comprimento máximo de 64 caracteres. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Restrições: maxComprimento: 64	No
status	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
Temperatura	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o Capacidades do modelo, como busca na web Ou busca de arquivos. Saiba mais sobre Ferramentas embutidas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre função chamando. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
top_logprobs	inteiro ou nulo		No
top_p	número ou nulo		No
truncation	cadeia de caracteres ou nulo		No
uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos.	No

OpenAI.ResponseAudioDeltaEvent

Emitido quando há uma resposta de áudio parcial.

Nome	Tipo	Description	Obrigatório
delta	cadeia	Uma parte dos bytes de áudio de resposta codificados em Base64. Restrições: codificação: base64	Sim
sequence_number	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.

Nome	Tipo	Description	Obrigatório	Default
sequence_number	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.

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

OpenAI.ResponseAudioTranscriptDoneEvent

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

Nome	Tipo	Description	Obrigatório	Default
sequence_number	inteiro	O número de sequência desse 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 snippet de código parcial é transmitido pelo interpretador de código.

Nome	Tipo	Description	Obrigatório
delta	cadeia	O snippet de código parcial que está sendo transmitido pelo interpretador de código.	Sim
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretador de código.	Sim
output_index	inteiro	O índice do item de saída na resposta para a qual o código está sendo transmitido.	Sim
sequence_number	inteiro	O número de sequência desse evento, usado para ordenar 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 snippet de código é finalizado pelo interpretador de código.

Nome	Tipo	Description	Obrigatório
codificar	cadeia	A saída final do snippet de código pelo intérprete de código.	Sim
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretador de código.	Sim
output_index	inteiro	O índice do item de saída na resposta para a qual o código é finalizado.	Sim
sequence_number	inteiro	O número de sequência desse evento, usado para ordenar 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.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretador de código.	Sim
output_index	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	inteiro	O número de sequência desse evento, usado para ordenar 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.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretador de código.	Sim
output_index	inteiro	O índice do item de saída na resposta para a qual a chamada do interpretador de código está em andamento.	Sim
sequence_number	inteiro	O número de sequência desse evento, usado para ordenar 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 snippet de código.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretador de código.	Sim
output_index	inteiro	O índice do item de saída na resposta para a qual o interpretador de código está interpretando o código.	Sim
sequence_number	inteiro	O número de sequência desse evento, usado para ordenar 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 é concluída.

Nome	Tipo	Description	Obrigatório	Default
Resposta	OpenAI.Response		Sim
└─ plano de fundo	booliano ou nulo		No
└─ completed_at	string ou nulo (unixTimestamp)		No
└─ content_filters	matriz de AzureContentFilterForResponsesAPI	Os resultados do filtro de conteúdo da RAI.	No
└─ conversa	OpenAI.ConversationReference ou nulo		No
└─ created_at	inteiro (unixtime)	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Sim
└─ erro	OpenAI.ResponseError ou nulo		Sim
└─ id	cadeia	Identificador exclusivo para esta resposta.	Sim
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails ou null		Sim
└─ instruções	cadeia de caracteres ou matriz de OpenAI.InputItem ou nulo		Sim
└─ max_output_tokens (número máximo de tokens de saída)	inteiro ou nulo		No
└─ max_tool_calls	inteiro ou nulo		No
└─ metadados	OpenAI.Metadata ou nulo		No
└─ modelo	cadeia	ID do modelo usada para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma ampla gama de modelos com diferentes funcionalidades, desempenho características e pontos de preço. Consulte o guia de modelos para navegar e comparar os modelos disponíveis.	No
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Sim
└─ saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Sim
└─ texto_de_saida	cadeia de caracteres ou nulo		No
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
└─ ID_de_resposta_anterior	cadeia de caracteres ou nulo		No
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	No
└─ prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo.	No
└─ prompt_cache_retention	cadeia de caracteres ou nulo		No
└─ raciocínio	OpenAI.Reasoning ou nulo		No
└─ safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. Os IDs devem ser uma string que identifique unicamente cada usuário, com um comprimento máximo de 64 caracteres. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Restrições: maxComprimento: 64	No
└─ estado	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatura	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o Capacidades do modelo, como busca na web Ou busca de arquivos. Saiba mais sobre Ferramentas embutidas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre função chamando. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
└─ top_logprobs	inteiro ou nulo		No
└─ top_p	número ou nulo		No	1
└─ truncamento	cadeia de caracteres ou nulo		No	desabilitado
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos.	No
sequence_number	inteiro	O número sequencial para esse 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.

Nome	Tipo	Description	Obrigatório
content_index	inteiro	O índice da parte de conteúdo que foi adicionada.	Sim
item_id	cadeia	A ID do item de saída ao qual a parte de conteúdo foi adicionada.	Sim
output_index	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	inteiro	O número de sequência desse 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.

Nome	Tipo	Description	Obrigatório
content_index	inteiro	O índice da parte de conteúdo que está concluída.	Sim
item_id	cadeia	A ID do item de saída ao qual a parte de conteúdo foi adicionada.	Sim
output_index	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	inteiro	O número de sequência desse 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 emitido quando uma resposta é criada.

Nome	Tipo	Description	Obrigatório	Default
Resposta	OpenAI.Response		Sim
└─ plano de fundo	booliano ou nulo		No
└─ completed_at	string ou nulo (unixTimestamp)		No
└─ content_filters	matriz de AzureContentFilterForResponsesAPI	Os resultados do filtro de conteúdo da RAI.	No
└─ conversa	OpenAI.ConversationReference ou nulo		No
└─ created_at	inteiro (unixtime)	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Sim
└─ erro	OpenAI.ResponseError ou nulo		Sim
└─ id	cadeia	Identificador exclusivo para esta resposta.	Sim
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails ou null		Sim
└─ instruções	cadeia de caracteres ou matriz de OpenAI.InputItem ou nulo		Sim
└─ max_output_tokens (número máximo de tokens de saída)	inteiro ou nulo		No
└─ max_tool_calls	inteiro ou nulo		No
└─ metadados	OpenAI.Metadata ou nulo		No
└─ modelo	cadeia	ID do modelo usada para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma ampla gama de modelos com diferentes funcionalidades, desempenho características e pontos de preço. Consulte o guia de modelos para navegar e comparar os modelos disponíveis.	No
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Sim
└─ saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Sim
└─ texto_de_saida	cadeia de caracteres ou nulo		No
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
└─ ID_de_resposta_anterior	cadeia de caracteres ou nulo		No
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	No
└─ prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo.	No
└─ prompt_cache_retention	cadeia de caracteres ou nulo		No
└─ raciocínio	OpenAI.Reasoning ou nulo		No
└─ safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. Os IDs devem ser uma string que identifique unicamente cada usuário, com um comprimento máximo de 64 caracteres. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Restrições: maxComprimento: 64	No
└─ estado	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatura	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o Capacidades do modelo, como busca na web Ou busca de arquivos. Saiba mais sobre Ferramentas embutidas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre função chamando. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
└─ top_logprobs	inteiro ou nulo		No
└─ top_p	número ou nulo		No	1
└─ truncamento	cadeia de caracteres ou nulo		No	desabilitado
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos.	No
sequence_number	inteiro	O número sequencial para esse 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) para a entrada de uma chamada de ferramenta personalizada.

Nome	Tipo	Description	Obrigatório
delta	cadeia	Os dados de entrada incrementais (delta) para a chamada de ferramenta personalizada.	Sim
item_id	cadeia	Identificador exclusivo para o item de API associado a esse evento.	Sim
output_index	inteiro	O índice da saída ao qual esse delta se aplica.	Sim
sequence_number	inteiro	O número de sequência desse evento.	Sim
tipo	enumeração	O identificador de tipo de evento. Valores possíveis: `response.custom_tool_call_input.delta`	Sim

OpenAI.ResponseCustomToolCallInputDoneEvent

RespostaCustomToolChamadaEntradaFeita

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

Nome	Tipo	Description	Obrigatório
entrada	cadeia	Os dados de entrada completos para a chamada de ferramenta personalizada.	Sim
item_id	cadeia	Identificador exclusivo para o item de API associado a esse evento.	Sim
output_index	inteiro	O índice da saída ao qual este evento se aplica.	Sim
sequence_number	inteiro	O número de sequência desse evento.	Sim
tipo	enumeração	O identificador de tipo de evento. Valores possíveis: `response.custom_tool_call_input.done`	Sim

OpenAI.ResponseError

Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.

Nome	Tipo	Description	Obrigatório	Default
codificar	OpenAI.ResponseErrorCode	O código de erro da resposta.	Sim
mensagem	cadeia	Uma descrição legível pelo humano do erro.	Sim

OpenAI.ResponseErrorCode

O código de erro da resposta.

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

OpenAI.ResponseErrorEvent

Emitido quando ocorre um erro.

Nome	Tipo	Description	Obrigatório
codificar	cadeia de caracteres ou nulo		Sim
mensagem	cadeia	A mensagem de erro.	Sim
param	cadeia de caracteres ou nulo		Sim
sequence_number	inteiro	O número de sequência desse evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `error`. Valores possíveis: `error`	Sim

OpenAI.ResponseFailedEvent

Um evento emitido quando uma resposta falha.

Nome	Tipo	Description	Obrigatório	Default
Resposta	OpenAI.Response		Sim
└─ plano de fundo	booliano ou nulo		No
└─ completed_at	string ou nulo (unixTimestamp)		No
└─ content_filters	matriz de AzureContentFilterForResponsesAPI	Os resultados do filtro de conteúdo da RAI.	No
└─ conversa	OpenAI.ConversationReference ou nulo		No
└─ created_at	inteiro (unixtime)	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Sim
└─ erro	OpenAI.ResponseError ou nulo		Sim
└─ id	cadeia	Identificador exclusivo para esta resposta.	Sim
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails ou null		Sim
└─ instruções	cadeia de caracteres ou matriz de OpenAI.InputItem ou nulo		Sim
└─ max_output_tokens (número máximo de tokens de saída)	inteiro ou nulo		No
└─ max_tool_calls	inteiro ou nulo		No
└─ metadados	OpenAI.Metadata ou nulo		No
└─ modelo	cadeia	ID do modelo usada para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma ampla gama de modelos com diferentes funcionalidades, desempenho características e pontos de preço. Consulte o guia de modelos para navegar e comparar os modelos disponíveis.	No
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Sim
└─ saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Sim
└─ texto_de_saida	cadeia de caracteres ou nulo		No
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
└─ ID_de_resposta_anterior	cadeia de caracteres ou nulo		No
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	No
└─ prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo.	No
└─ prompt_cache_retention	cadeia de caracteres ou nulo		No
└─ raciocínio	OpenAI.Reasoning ou nulo		No
└─ safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. Os IDs devem ser uma string que identifique unicamente cada usuário, com um comprimento máximo de 64 caracteres. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Restrições: maxComprimento: 64	No
└─ estado	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatura	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o Capacidades do modelo, como busca na web Ou busca de arquivos. Saiba mais sobre Ferramentas embutidas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre função chamando. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
└─ top_logprobs	inteiro ou nulo		No
└─ top_p	número ou nulo		No	1
└─ truncamento	cadeia de caracteres ou nulo		No	desabilitado
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos.	No
sequence_number	inteiro	O número de sequência desse 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).

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item de saída que a chamada de pesquisa de arquivo é iniciada.	Sim
output_index	inteiro	O índice do item de saída que a chamada de pesquisa de arquivo é iniciada.	Sim
sequence_number	inteiro	O número de sequência desse 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.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item de saída que a chamada de pesquisa de arquivo é iniciada.	Sim
output_index	inteiro	O índice do item de saída que a chamada de pesquisa de arquivo é iniciada.	Sim
sequence_number	inteiro	O número de sequência desse 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á em andamento.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item de saída que a chamada de pesquisa de arquivo é iniciada.	Sim
output_index	inteiro	O índice do item de saída que a chamada de pesquisa de arquivo está pesquisando.	Sim
sequence_number	inteiro	O número de sequência desse 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 de argumentos parciais de chamada de função.

Nome	Tipo	Description	Obrigatório
delta	cadeia	O delta de argumentos de chamada de função que é adicionado.	Sim
item_id	cadeia	A ID do item de saída ao qual o delta de argumentos de chamada de função é adicionado.	Sim
output_index	inteiro	O índice do item de saída ao qual o delta de argumentos de chamada de função é adicionado.	Sim
sequence_number	inteiro	O número de sequência desse 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.

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

OpenAI.ResponseImageGenCallCompletedEvent

RespostaImageGenChamadaEventoConcluído

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

Nome	Tipo	Description	Obrigatório
item_id	cadeia	O identificador exclusivo do item de geração de imagem que está sendo processado.	Sim
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Sim
sequence_number	inteiro	O número de sequência desse 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

RespostaImageGenCallGenerating Event

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

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

OpenAI.ResponseImageGenCallInProgressEvent

RespostaImageGeChamadaEmProgressoEvento

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

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

OpenAI.ResponseImageGenCallPartialImageEvent

RespostaImageGenChamadaTPartialImageEvent

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

Nome	Tipo	Description	Obrigatório
item_id	cadeia	O identificador exclusivo do item de geração de imagem que está sendo processado.	Sim
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Sim
partial_image_b64	cadeia	Dados de imagem parciais codificados em Base64, adequados para renderização como uma imagem.	Sim
partial_image_index	inteiro	Índice baseado em 0 para a imagem parcial (o back-end é baseado em 1, mas é baseado em 0 para o usuário).	Sim
sequence_number	inteiro	O número de sequência do item de geração de imagem que está sendo 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.

Nome	Tipo	Description	Obrigatório	Default
Resposta	OpenAI.Response		Sim
└─ plano de fundo	booliano ou nulo		No
└─ completed_at	string ou nulo (unixTimestamp)		No
└─ content_filters	matriz de AzureContentFilterForResponsesAPI	Os resultados do filtro de conteúdo da RAI.	No
└─ conversa	OpenAI.ConversationReference ou nulo		No
└─ created_at	inteiro (unixtime)	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Sim
└─ erro	OpenAI.ResponseError ou nulo		Sim
└─ id	cadeia	Identificador exclusivo para esta resposta.	Sim
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails ou null		Sim
└─ instruções	cadeia de caracteres ou matriz de OpenAI.InputItem ou nulo		Sim
└─ max_output_tokens (número máximo de tokens de saída)	inteiro ou nulo		No
└─ max_tool_calls	inteiro ou nulo		No
└─ metadados	OpenAI.Metadata ou nulo		No
└─ modelo	cadeia	ID do modelo usada para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma ampla gama de modelos com diferentes funcionalidades, desempenho características e pontos de preço. Consulte o guia de modelos para navegar e comparar os modelos disponíveis.	No
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Sim
└─ saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Sim
└─ texto_de_saida	cadeia de caracteres ou nulo		No
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
└─ ID_de_resposta_anterior	cadeia de caracteres ou nulo		No
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	No
└─ prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo.	No
└─ prompt_cache_retention	cadeia de caracteres ou nulo		No
└─ raciocínio	OpenAI.Reasoning ou nulo		No
└─ safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. Os IDs devem ser uma string que identifique unicamente cada usuário, com um comprimento máximo de 64 caracteres. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Restrições: maxComprimento: 64	No
└─ estado	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatura	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o Capacidades do modelo, como busca na web Ou busca de arquivos. Saiba mais sobre Ferramentas embutidas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre função chamando. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
└─ top_logprobs	inteiro ou nulo		No
└─ top_p	número ou nulo		No	1
└─ truncamento	cadeia de caracteres ou nulo		No	desabilitado
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos.	No
sequence_number	inteiro	O número de sequência desse evento.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.in_progress`. Valores possíveis: `response.in_progress`	Sim

OpenAI.ResponseIncompleteDetails

Nome	Tipo	Description	Obrigatório	Default
reason	enumeração	Valores possíveis: `max_output_tokens`, `content_filter`	No

OpenAI.ResponseIncompleteEvent

Um evento emitido quando uma resposta é concluída como incompleta.

Nome	Tipo	Description	Obrigatório	Default
Resposta	OpenAI.Response		Sim
└─ plano de fundo	booliano ou nulo		No
└─ completed_at	string ou nulo (unixTimestamp)		No
└─ content_filters	matriz de AzureContentFilterForResponsesAPI	Os resultados do filtro de conteúdo da RAI.	No
└─ conversa	OpenAI.ConversationReference ou nulo		No
└─ created_at	inteiro (unixtime)	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Sim
└─ erro	OpenAI.ResponseError ou nulo		Sim
└─ id	cadeia	Identificador exclusivo para esta resposta.	Sim
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails ou null		Sim
└─ instruções	cadeia de caracteres ou matriz de OpenAI.InputItem ou nulo		Sim
└─ max_output_tokens (número máximo de tokens de saída)	inteiro ou nulo		No
└─ max_tool_calls	inteiro ou nulo		No
└─ metadados	OpenAI.Metadata ou nulo		No
└─ modelo	cadeia	ID do modelo usada para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma ampla gama de modelos com diferentes funcionalidades, desempenho características e pontos de preço. Consulte o guia de modelos para navegar e comparar os modelos disponíveis.	No
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Sim
└─ saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Sim
└─ texto_de_saida	cadeia de caracteres ou nulo		No
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
└─ ID_de_resposta_anterior	cadeia de caracteres ou nulo		No
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	No
└─ prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo.	No
└─ prompt_cache_retention	cadeia de caracteres ou nulo		No
└─ raciocínio	OpenAI.Reasoning ou nulo		No
└─ safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. Os IDs devem ser uma string que identifique unicamente cada usuário, com um comprimento máximo de 64 caracteres. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Restrições: maxComprimento: 64	No
└─ estado	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatura	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o Capacidades do modelo, como busca na web Ou busca de arquivos. Saiba mais sobre Ferramentas embutidas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre função chamando. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
└─ top_logprobs	inteiro ou nulo		No
└─ top_p	número ou nulo		No	1
└─ truncamento	cadeia de caracteres ou nulo		No	desabilitado
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos.	No
sequence_number	inteiro	O número de sequência desse 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.

Nome	Tipo	Description	Obrigatório
dados	matriz de OpenAI.ItemResource	Uma lista de itens usados para gerar essa resposta.	Sim
first_id	cadeia	A ID do primeiro item da lista.	Sim
has_more	boolean	Se há mais itens disponíveis.	Sim
last_id	cadeia	A ID do último item da lista.	Sim
objeto	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 específico em uma determinada posição na sequência. Valores de logprob menos negativos (superiores) indicam maior confiança do modelo nessa opção de token.

Nome	Tipo	Description	Obrigatório
logprob	número	A probabilidade de log desse token.	Sim
símbolo	cadeia	Um possível token de texto.	Sim
top_logprobs	matriz de OpenAI.ResponseLogProbTopLogprobs	As probabilidades logarítmicas de até 20 dos tokens mais prováveis.	No

OpenAI.ResponseLogProbTopLogprobs

Nome	Tipo	Description	Obrigatório	Default
logprob	número		No
símbolo	cadeia		No

OpenAI.ResponseMCPCallArgumentsDeltaEvent

RespostaMCPCtodosArgumentosDeltaEvento

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

Nome	Tipo	Description	Obrigatório
delta	cadeia	Uma cadeia de caracteres JSON que contém a atualização parcial para os argumentos da chamada da ferramenta MCP.	Sim
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado.	Sim
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Sim
sequence_number	inteiro	O número de sequência desse 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 de uma chamada de ferramenta MCP são finalizados.

Nome	Tipo	Description	Obrigatório
arguments	cadeia	Uma cadeia de caracteres JSON que contém os argumentos finalizados para a chamada da ferramenta MCP.	Sim
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado.	Sim
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Sim
sequence_number	inteiro	O número de sequência desse evento.	Sim
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call_arguments.concluído'. Valores possíveis: `response.mcp_call_arguments.done`	Sim

OpenAI.ResponseMCPCallCompletedEvent

ResponseMCPCallCompletedEvent

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

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

OpenAI.ResponseMCPCallFailedEvent

RespostaMCPCallFailedEvent

Emitido quando uma chamada de ferramenta MCP falha.

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

OpenAI.ResponseMCPCallInProgressEvent

RespostaMCPCallInProgressEvent

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

Nome	Tipo	Description	Obrigatório
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado.	Sim
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Sim
sequence_number	inteiro	O número de sequência desse evento.	Sim
tipo	enumeração	O tipo de evento. O estado sempre é 'response.mcp_call.in_progress'. Valores possíveis: `response.mcp_call.in_progress`	Sim

OpenAI.ResponseMCPListToolsCompletedEvent

RespostaMCPListFerramentasCompletadasEvento

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

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item de chamada da ferramenta MCP que produziu essa saída.	Sim
output_index	inteiro	O índice do item de saída que foi processado.	Sim
sequence_number	inteiro	O número de sequência desse 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.

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

OpenAI.ResponseMCPListToolsInProgressEvent

RespostaMCPListToolsInProgressEvent

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

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item de chamada da ferramenta MCP que está sendo processado.	Sim
output_index	inteiro	O índice do item de saída que está sendo processado.	Sim
sequence_number	inteiro	O número de sequência desse 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.

Nome	Tipo	Description	Obrigatório
item	OpenAI.OutputItem		Sim
└─ tipo	OpenAI.OutputItemType		Sim
output_index	inteiro	O índice do item de saída que foi adicionado.	Sim
sequence_number	inteiro	O número de sequência desse 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.

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

OpenAI.ResponseOutputTextAnnotationAddedEvent

RespostaSaídaTextoAnotaçãoAdicionadoEvento

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

Nome	Tipo	Description	Obrigatório
anotação	OpenAI.Annotation	Uma anotação que se aplica a um intervalo de texto de saída.	Sim
└─ tipo	OpenAI.AnnotationType		Sim
annotation_index	inteiro	O índice da anotação na parte de conteúdo.	Sim
content_index	inteiro	O índice da parte de conteúdo dentro do item de saída.	Sim
item_id	cadeia	O identificador exclusivo do item ao qual a anotação está sendo adicionada.	Sim
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Sim
sequence_number	inteiro	O número de sequência desse 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 a serem substituídos por variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros tipos de entrada de resposta, como imagens ou arquivos.

Tipo: objeto

OpenAI.ResponseQueuedEvent

EventoRespostaNa FilaDa Resposta

Emitido quando uma resposta é enfileirada e aguardando para ser processada.

Nome	Tipo	Description	Obrigatório	Default
Resposta	OpenAI.Response		Sim
└─ plano de fundo	booliano ou nulo		No
└─ completed_at	string ou nulo (unixTimestamp)		No
└─ content_filters	matriz de AzureContentFilterForResponsesAPI	Os resultados do filtro de conteúdo da RAI.	No
└─ conversa	OpenAI.ConversationReference ou nulo		No
└─ created_at	inteiro (unixtime)	Unix timestamp (em segundos) de quando esta Resposta foi criada.	Sim
└─ erro	OpenAI.ResponseError ou nulo		Sim
└─ id	cadeia	Identificador exclusivo para esta resposta.	Sim
└─ detalhes_incompletos	OpenAI.ResponseIncompleteDetails ou null		Sim
└─ instruções	cadeia de caracteres ou matriz de OpenAI.InputItem ou nulo		Sim
└─ max_output_tokens (número máximo de tokens de saída)	inteiro ou nulo		No
└─ max_tool_calls	inteiro ou nulo		No
└─ metadados	OpenAI.Metadata ou nulo		No
└─ modelo	cadeia	ID do modelo usada para gerar a resposta, como `gpt-4o` ou `o3`. OpenAI oferece uma ampla gama de modelos com diferentes funcionalidades, desempenho características e pontos de preço. Consulte o guia de modelos para navegar e comparar os modelos disponíveis.	No
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Sim
└─ saída	matriz de OpenAI.OutputItem	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na `output` matriz são dependentes na resposta do modelo. - Em vez de acessar o primeiro item na `output` matriz e supondo que seja uma `assistant` mensagem com o conteúdo gerado por o modelo, você pode considerar o uso da propriedade `output_text` em que Suportado por SDKs.	Sim
└─ texto_de_saida	cadeia de caracteres ou nulo		No
└─ chamadas_de_ferramenta_em_paralelo	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Sim	Verdade
└─ ID_de_resposta_anterior	cadeia de caracteres ou nulo		No
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	No
└─ prompt_cache_key	cadeia	Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o `user` campo.	No
└─ prompt_cache_retention	cadeia de caracteres ou nulo		No
└─ raciocínio	OpenAI.Reasoning ou nulo		No
└─ safety_identifier	cadeia	Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI. Os IDs devem ser uma string que identifique unicamente cada usuário, com um comprimento máximo de 64 caracteres. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação. Restrições: maxComprimento: 64	No
└─ estado	enumeração	O status da geração de resposta. Um de `completed`, `failed` `in_progress`, `cancelled`ou `queuedincomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatura	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. Damos suporte às seguintes categorias de ferramentas: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem o Capacidades do modelo, como busca na web Ou busca de arquivos. Saiba mais sobre Ferramentas embutidas. - Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre Ferramentas MCP. - Chamadas de função (ferramentas personalizadas): funções definidas por você, habilitando o modelo para chamar seu próprio código com argumentos fortemente tipado e saídas. Saiba mais sobre função chamando. Você também pode usar ferramentas personalizadas para chamar seu próprio código.	No
└─ top_logprobs	inteiro ou nulo		No
└─ top_p	número ou nulo		No	1
└─ truncamento	cadeia de caracteres ou nulo		No	desabilitado
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	No
└─ usuário	cadeia de caracteres (preterida)	Este campo está sendo substituído por `safety_identifier` .`prompt_cache_key` Em vez disso, use `prompt_cache_key` para manter otimizações de cache. Um identificador estável para os usuários finais. Usado para aumentar as taxas de ocorrência de cache, melhor bucketing solicitações semelhantes e para ajudar o OpenAI a detectar e prevenir abusos.	No
sequence_number	inteiro	O número sequencial para esse evento.	Sim
tipo	enumeração	O tipo de evento. Sempre 'response.enfileirado'. Valores possíveis: `response.queued`	Sim

OpenAI.ResponseReasoningSummaryPartAddedEvent

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

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item à qual essa parte de resumo está associada.	Sim
output_index	inteiro	O índice do item de saída ao qual essa parte de resumo está associada.	Sim
part	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Sim
└─ texto	cadeia		Sim
└─ tipo	enumeração	Valores possíveis: `summary_text`	Sim
sequence_number	inteiro	O número de sequência desse evento.	Sim
summary_index	inteiro	O índice da parte de resumo dentro do resumo do raciocínio.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_part.added`. Valores possíveis: `response.reasoning_summary_part.added`	Sim

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia		Sim
tipo	enumeração	Valores possíveis: `summary_text`	Sim

OpenAI.ResponseReasoningSummaryPartDoneEvent

Emitido quando uma parte do resumo do raciocínio é concluída.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	A ID do item à qual essa parte de resumo está associada.	Sim
output_index	inteiro	O índice do item de saída ao qual essa parte de resumo está associada.	Sim
part	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Sim
└─ texto	cadeia		Sim
└─ tipo	enumeração	Valores possíveis: `summary_text`	Sim
sequence_number	inteiro	O número de sequência desse evento.	Sim
summary_index	inteiro	O índice da parte de resumo dentro do resumo do raciocínio.	Sim
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_part.done`. Valores possíveis: `response.reasoning_summary_part.done`	Sim

OpenAI.ResponseReasoningSummaryPartDoneEventPart

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia		Sim
tipo	enumeração	Valores possíveis: `summary_text`	Sim

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Emitido quando um delta é adicionado a um texto de resumo lógico.

Nome	Tipo	Description	Obrigatório
delta	cadeia	O delta de texto que foi adicionado ao resumo.	Sim
item_id	cadeia	A ID do item ao qual este delta de texto de resumo está associado.	Sim
output_index	inteiro	O índice do item de saída ao qual este delta de texto de resumo está associado.	Sim
sequence_number	inteiro	O número de sequência desse evento.	Sim
summary_index	inteiro	O índice da parte de resumo dentro do resumo do raciocínio.	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.

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

OpenAI.ResponseReasoningTextDeltaEvent

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

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

OpenAI.ResponseReasoningTextDoneEvent

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

Nome	Tipo	Description	Obrigatório
content_index	inteiro	A parte do índice do conteúdo de raciocínio.	Sim
item_id	cadeia	A ID do item ao qual esse texto de raciocínio está associado.	Sim
output_index	inteiro	O índice do item de saída ao qual esse texto de raciocínio está associado.	Sim
sequence_number	inteiro	O número de sequência desse evento.	Sim
enviar SMS	cadeia	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.

Nome	Tipo	Description	Obrigatório
content_index	inteiro	O índice da parte de conteúdo à qual o texto de recusa é adicionado.	Sim
delta	cadeia	O texto de recusa que é adicionado.	Sim
item_id	cadeia	A ID do item de saída ao qual o texto de recusa é adicionado.	Sim
output_index	inteiro	O índice do item de saída ao qual o texto de recusa é adicionado.	Sim
sequence_number	inteiro	O número de sequência desse 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.

Nome	Tipo	Description	Obrigatório
content_index	inteiro	O índice da parte de conteúdo que o texto de recusa é finalizado.	Sim
item_id	cadeia	A ID do item de saída em que o texto de recusa é finalizado.	Sim
output_index	inteiro	O índice do item de saída em que o texto de recusa é finalizado.	Sim
Recusa	cadeia	O texto finalizado de recusa.	Sim
sequence_number	inteiro	O número de sequência desse 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

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

Digite um valor	Schema
`response.audio.done`	OpenAI.ResponseAudioDoneEvent
`response.audio.transcript.delta`	OpenAI.ResponseAudioTranscriptDeltaEvent
`response.audio.transcript.done`	OpenAI.RespostaTranscriçãoÁudioFeitoEventoFeito
`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.ResponseCustomToolCallInputDoneDone
`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çãoEventoAdicionado
`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

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ResponseStreamEventType		Sim

OpenAI.ResponseStreamEventType

Property Valor

Type cadeia

Valores response.audio.delta
response.audio.done
response.audio.transcript.delta
response.audio.transcript.done
response.code_interpreter_call_code.delta
response.code_interpreter_call_code.done
response.code_interpreter_call.completed
response.code_interpreter_call.in_progress
response.code_interpreter_call.interpreting
response.completed
response.content_part.added
response.content_part.done
response.created
error
response.file_search_call.completed
response.file_search_call.in_progress
response.file_search_call.searching
response.function_call_arguments.delta
response.function_call_arguments.done
response.in_progress
response.failed
response.incomplete
response.output_item.added
response.output_item.done
response.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 de streaming. Defina isso somente quando você definir stream: true.

Nome	Tipo	Description	Obrigatório	Default
include_obfuscation	boolean	Quando true, a ofuscação de fluxo será habilitada. Adiciones de ofuscação de fluxo caracteres aleatórios para um `obfuscation` campo em eventos delta de streaming para normalize os tamanhos de carga como uma mitigação para determinados ataques de canal lateral. Esses campos de ofuscação são incluídos por padrão, mas adicionam uma pequena quantidade de sobrecarga para o fluxo de dados. Você pode definir `include_obfuscation` como false para otimizar para largura de banda se você confiar nos links de rede entre seu aplicativo e a API OpenAI.	No

OpenAI.ResponseTextDeltaEvent

Emitido quando há um delta de texto adicional.

Nome	Tipo	Description	Obrigatório
content_index	inteiro	O índice da parte de conteúdo à qual o delta de texto foi adicionado.	Sim
delta	cadeia	O delta de texto que foi adicionado.	Sim
item_id	cadeia	A ID do item de saída ao qual o delta de texto foi adicionado.	Sim
logprobs	matriz de OpenAI.ResponseLogProb	As probabilidades de log dos tokens no delta.	Sim
output_index	inteiro	O índice do item de saída ao qual o delta de texto foi adicionado.	Sim
sequence_number	inteiro	O número sequencial para esse 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.

Nome	Tipo	Description	Obrigatório
content_index	inteiro	O índice da parte de conteúdo que o conteúdo do texto é finalizado.	Sim
item_id	cadeia	A ID do item de saída em que o conteúdo do texto é finalizado.	Sim
logprobs	matriz de OpenAI.ResponseLogProb	As probabilidades de log dos tokens no delta.	Sim
output_index	inteiro	O índice do item de saída que o conteúdo do texto é finalizado.	Sim
sequence_number	inteiro	O número sequencial para esse evento.	Sim
enviar SMS	cadeia	O conteúdo do texto 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 sem formatação ou dados JSON estruturados. Saiba mais:

Entradas e saídas de texto
Saídas estruturadas

Nome	Tipo	Description	Obrigatório	Default
format	OpenAI.TextResponseFormatConfiguration	Um objeto que especifica o formato que o modelo deve gerar. `{ "type": "json_schema" }` Configurar habilita saídas estruturadas, que garante que o modelo corresponda ao esquema JSON fornecido. Saiba mais no O formato padrão é `{ "type": "text" }` sem opções adicionais. Não recomendado para modelos gpt-4o e mais recentes: Definir para `{ "type": "json_object" }` habilita o modo JSON mais antigo, que garante que a mensagem gerada pelo modelo seja JSON válida. Usando `json_schema` é preferencial para modelos que dão suporte a isso.	No
detalhamento	OpenAI.Verbosity	Restringe a verbosidade da resposta do modelo. Valores mais baixos resultarão em respostas mais concisas, enquanto valores mais altos resultarão em respostas mais detalhadas. Os valores com suporte no momento são `low`, `medium`e `high`.	No

OpenAI.ResponseUsage

Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, uma divisão de tokens de saída e o total de tokens usados.

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

OpenAI.ResponseUsageInputTokensDetails

Nome	Tipo	Description	Obrigatório	Default
cached_tokens	inteiro		Sim

OpenAI.ResponseUsageOutputTokensDetails

Nome	Tipo	Description	Obrigatório	Default
reasoning_tokens	inteiro		Sim

OpenAI.ResponseWebSearchCallCompletedEvent

Observação: web_search ainda não está disponível por meio do Azure OpenAI.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	ID exclusiva para o item de saída associado à chamada de pesquisa na Web.	Sim
output_index	inteiro	O índice do item de saída ao qual a chamada de pesquisa na Web está associada.	Sim
sequence_number	inteiro	O número de sequência da chamada de pesquisa na Web que está sendo 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

Observação: web_search ainda não está disponível por meio do Azure OpenAI.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	ID exclusiva para o item de saída associado à chamada de pesquisa na Web.	Sim
output_index	inteiro	O índice do item de saída ao qual a chamada de pesquisa na Web está associada.	Sim
sequence_number	inteiro	O número de sequência da chamada de pesquisa na Web que está sendo 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

Observação: web_search ainda não está disponível por meio do Azure OpenAI.

Nome	Tipo	Description	Obrigatório
item_id	cadeia	ID exclusiva para o item de saída associado à chamada de pesquisa na Web.	Sim
output_index	inteiro	O índice do item de saída ao qual a chamada de pesquisa na Web está associada.	Sim
sequence_number	inteiro	O número de sequência da chamada de pesquisa na Web que está sendo 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.

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

OpenAI.ScrollParam

Scroll

Uma ação de rolagem.

Nome	Tipo	Description	Obrigatório	Default
keys	matriz de cadeia de caracteres ou nulo		No
scroll_x	inteiro	A distância de rolagem horizontal.	Sim
scroll_y	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	Rolar
x	inteiro	A coordenada x em que a rolagem ocorreu.	Sim
y	inteiro	A coordenada y em que a rolagem ocorreu.	Sim

OpenAI.SearchContentType

Property	Valor
Type	cadeia
Valores	`text` `image`

OpenAI.SearchContextSize

Property	Valor
Type	cadeia
Valores	`low` `medium` `high`

OpenAI.SkillReferenceParam

Nome	Tipo	Description	Obrigatório	Default
skill_id	cadeia	O ID da habilidade mencionada. Restrições: minLength: 1, maxLength: 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	Versão opcional de habilidade. Use um inteiro positivo ou 'mais recente'. Omita o padrão de nome.	No

OpenAI.SpecificApplyPatchParam

Escolha específica de ferramenta de aplicação

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

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	A ferramenta a ser chamada. Sempre `apply_patch`. Valores possíveis: `apply_patch`	Sim	apply_patch

OpenAI.SpecificFunctionShellParam

Escolha específica da ferramenta shell

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

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	A ferramenta a ser chamada. Sempre `shell`. Valores possíveis: `shell`	Sim	shell

OpenAI.SummaryTextContent

Texto resumido

Um texto de resumo do modelo.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	Um resumo da saída de raciocínio do modelo até agora.	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 de texto.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia		Sim
tipo	enumeração	Valores possíveis: `text`	Sim	enviar SMS

OpenAI.TextResponseFormatConfiguration

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

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

Discriminador para OpenAI.TextResponseFormatConfiguration

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

Digite um valor	Schema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.TextResponseFormatConfigurationType		Sim

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Objeto JSON

Formato de resposta de objeto JSON. Um método mais antigo de geração de respostas JSON. O uso json_schema é recomendado para modelos que dão suporte a ele. Observe que o modelo não gerará JSON sem uma mensagem do sistema ou do usuário instruindo-o a fazer isso.

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

OpenAI.TextResponseFormatConfigurationResponseFormatText

Text

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

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

OpenAI.TextResponseFormatConfigurationType

Property	Valor
Type	cadeia
Valores	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

Esquema JSON

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

Nome	Tipo	Description	Obrigatório
description	cadeia	Uma descrição do formato de resposta, usado pelo modelo para determinar como responder no formato.	No
nome	cadeia	O nome do formato de resposta. Deve ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com um comprimento máximo de 64.	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	booliano 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

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

Digite um valor	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

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ToolType		Sim

OpenAI.ToolChoiceAllowed

Ferramentas permitidas

Restringe as ferramentas disponíveis para o modelo a um conjunto predefinido.

Nome	Tipo	Description	Obrigatório
mode	enumeração	Restringe as ferramentas disponíveis para o modelo a um conjunto predefinido. `auto` permite que o modelo escolha entre as ferramentas permitidas e gere um mensagem. `required` requer que o modelo chame uma ou mais das ferramentas permitidas. Valores possíveis: `auto`, `required`	Sim
tools	matriz de objeto	Uma lista de definições de ferramentas que o modelo deve ter permissão para chamar. Para a API de Respostas, a lista de definições de ferramentas pode ser semelhante a: `json<br> [ { "type": "function", "name": "get_weather" }, { "type": "mcp", "server_label": "deepwiki" }, { "type": "image_generation" } ]<br>`	Sim
tipo	enumeração	Tipo de configuração de ferramenta permitido. 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 internas.

Nome	Tipo	Description	Obrigatório	Default
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 internas.

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

OpenAI.EscolhaFerramentaComputadorUse

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

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

OpenAI.ToolChoiceComputerUsePreview

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

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

OpenAI.ToolChoiceCustom

Ferramenta personalizada

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

Nome	Tipo	Description	Obrigatório	Default
nome	cadeia	O nome da ferramenta personalizada a ser chamada.	Sim
tipo	enumeração	Para chamada de ferramenta personalizada, 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 internas.

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

OpenAI.ToolChoiceFunction

Ferramenta de função

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

Nome	Tipo	Description	Obrigatório	Default
nome	cadeia	O nome da função a ser chamada.	Sim
tipo	enumeração	Para a 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 internas.

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

OpenAI.ToolChoiceMCP

Ferramenta MCP

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

Nome	Tipo	Description	Obrigatório
nome	cadeia de caracteres ou nulo		No
etiqueta_do_servidor	cadeia	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 ferramenta (se houver) é chamada pelo modelo. none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem. auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas. required significa que o modelo deve chamar uma ou mais ferramentas.

Property	Valor
Type	cadeia
Valores	`none` `auto` `required`

OpenAI.ToolChoiceParam

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

Discriminador para OpenAI.ToolChoiceParam

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

Digite um valor	Schema
`allowed_tools`	OpenAI.ToolChoiceAllowed
`mcp`	OpenAI.ToolChoiceMCP
`custom`	OpenAI.ToolChoiceCustom
`apply_patch`	OpenAI.SpecificApplyPatchParam
`shell`	OpenAI.SpecificFunctionShellParam
`file_search`	OpenAI.ToolChoiceFileSearch
`web_search_preview`	OpenAI.ToolChoiceWebSearchPreview
`computer_use_preview`	OpenAI.ToolChoiceComputerUsePreview
`web_search_preview_2025_03_11`	OpenAI.ToolChoiceWebSearchPreview20250311
`image_generation`	OpenAI.ToolChoiceImageGeneration
`code_interpreter`	OpenAI.ToolChoiceCodeInterpreter
`computer`	OpenAI.ToolChoiceComputer
`computer_use`	OpenAI.EscolhaFerramentaComputadorUse
`function`	OpenAI.ToolChoiceFunction

Nome	Tipo	Description	Obrigatório	Default
tipo	OpenAI.ToolChoiceParamType		Sim

OpenAI.ToolChoiceParamType

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

OpenAI.ToolChoiceWebSearchPreview

Observação: web_search ainda não está disponível por meio do Azure OpenAI.

Nome	Tipo	Description	Obrigatório	Default
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 internas.

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	Valores possíveis: `web_search_preview_2025_03_11`	Sim

OpenAI.ToolSearchExecutionType

Property	Valor
Type	cadeia
Valores	`server` `client`

OpenAI.ToolSearchToolParam

Ferramenta de busca de ferramentas

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

Nome	Tipo	Description	Obrigatório	Default
description	cadeia de caracteres ou nulo		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
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. Damos suporte às seguintes categorias de ferramentas:

Ferramentas integradas: Ferramentas fornecidas pela OpenAI que ampliam as capacidades do modelo, como busca na web ou busca de arquivos. Saiba mais sobre ferramentas embutidas.
Ferramentas mcp: integrações com sistemas de terceiros por meio de servidores MCP personalizados ou conectores predefinidos, como Google Drive e SharePoint. Saiba mais sobre as Ferramentas MCP.
Chamadas de função (ferramentas personalizadas): Funções definidas por você, permitindo que o modelo chame seu próprio código com argumentos e saídas fortemente tipadas. Saiba mais sobre a chamada de função. Você também pode usar ferramentas personalizadas para chamar seu próprio código.

Matriz de: OpenAI.Tool

OpenAI.TopLogProb

Probabilidade logaritmética máxima

A probabilidade de log superior de um token.

Nome	Tipo	Obrigatório
bytes	matriz de inteiro	Sim
logprob	número	Sim
símbolo	cadeia	Sim

OpenAI.TypeParam

Type

Uma ação para digitar texto.

Nome	Tipo	Description	Obrigatório	Default
enviar SMS	cadeia	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 da URL

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

Nome	Tipo	Description	Obrigatório	Default
end_index	inteiro	O índice do último caractere da citação de URL na mensagem.	Sim
start_index	inteiro	O índice do primeiro caractere da citação de URL na mensagem.	Sim
title	cadeia	O título do recurso da Web.	Sim
tipo	enumeração	O tipo da citação de URL. Sempre `url_citation`. Valores possíveis: `url_citation`	Sim	url_citation
url	cadeia de caracteres (uri)	URL do recurso da 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 detalhadas. Os valores com suporte no momento 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 detalhadas. Os valores com suporte no momento são `low`, `medium`e `high`.
Type	cadeia
Valores	`low` `medium` `high`

OpenAI.WaitParam

Wait

Uma ação de espera.

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

OpenAI.WebSearchActionFind

Encontre ação

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

Nome	Tipo	Description	Obrigatório
padrão	cadeia	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	cadeia de caracteres (uri)	A URL da página pesquisou o padrão.	Sim

OpenAI.WebSearchActionOpenPage

Ação de abrir página

Tipo de ação "open_page" – abre uma URL específica dos resultados da pesquisa.

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	O tipo de ação. Valores possíveis: `open_page`	Sim
url	cadeia de caracteres ou nulo	A URL aberta pelo modelo.	No

OpenAI.WebSearchActionSearch

Ação de busca

Tipo de ação "pesquisa" – executa uma consulta de pesquisa na Web.

Nome	Tipo	Description	Obrigatório
Consultas	matriz de strings	As consultas de pesquisa.	No
consulta	cadeia de caracteres (preterida)	[PRETERIDO] A consulta de pesquisa.	Sim
Fontes	matriz de OpenAI.WebSearchActionSearchSources	As fontes usadas na pesquisa.	No
tipo	enumeração	O tipo de ação. Valores possíveis: `search`	Sim

OpenAI.WebSearchActionSearchSources

Nome	Tipo	Description	Obrigatório	Default
tipo	enumeração	Valores possíveis: `url`	Sim
url	cadeia de caracteres (uri)		Sim

OpenAI.WebSearchApproximateLocation

Localização aproximada na busca na web

O local aproximado do usuário.

Nome	Tipo	Description	Obrigatório	Default
Cidade	cadeia de caracteres ou nulo		No
country	cadeia de caracteres ou nulo		No
região	cadeia de caracteres ou nulo		No
timezone	cadeia de caracteres ou nulo		No
tipo	enumeração	O tipo de aproximação de local. Sempre `approximate`. Valores possíveis: `approximate`	Sim	aproximado

OpenAI.WebSearchPreviewTool

Prévia de busca na web

Observação: web_search ainda não está disponível por meio do Azure OpenAI.

Nome	Tipo	Description	Obrigatório	Default
search_content_types	array de OpenAI.SearchContentType		No
tamanho_do_contexto_de_busca	OpenAI.SearchContextSize		No
tipo	enumeração	O tipo da ferramenta de pesquisa na Web. Um dos `web_search_preview` ou `web_search_preview_2025_03_11`. Valores possíveis: `web_search_preview`	Sim	web_search_preview
localização_do_usuario	OpenAI.ApproximateLocation ou nulo		No

OpenAI.WebSearchTool

Pesquisa na Web

Observação: web_search ainda não está disponível por meio do Azure OpenAI.

Nome	Tipo	Description	Obrigatório	Default
Filtros	OpenAI.WebSearchToolFilters ou nulo		No
tamanho_do_contexto_de_busca	enumeração	Diretrizes de alto nível para a quantidade de espaço de janela de contexto a ser usada para a pesquisa. Uma opção entre `low`, `medium` ou `high`. `medium` é o padrão. Valores possíveis: `low`, , `mediumhigh`	No	meio
tipo	enumeração	O tipo da ferramenta de pesquisa na Web. Um dos `web_search` ou `web_search_2025_08_26`. Valores possíveis: `web_search`	Sim	pesquisa na web
localização_do_usuario	OpenAI.WebSearchApproximateLocation ou null		No

OpenAI.WebSearchToolFilters

Nome	Tipo	Description	Obrigatório	Default
allowed_domains	matriz de cadeia de caracteres ou nulo		No

Last updated on 2026-07-10