Azure OpenAI respuestas

Versión de API: v1

Server:{endpoint}/openai/v1 — APIs de modelos Fundición de IA de Azure

Variables de servidor:

Variable	Predeterminado	Description
endpoint		Un endpoint compatible con APIs de Fundición de IA de Azure Models, incluyendo protocolo y nombre de host. Por ejemplo: https://westus.api.cognitive.microsoft.com).

Autenticación

ApiKeyAuth (clave API)

Pasa tu clave API en la api-key cabecera.

ApiKeyAuth_ (clave API)

Pasa tu clave API en la authorization cabecera.

OAuth2Auth (OAuth 2.0)

Flow: implícito

Dirección URL de autorización:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos:

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

Requisitos de seguridad

Los endpoints aceptan cualquiera de los siguientes métodos de autenticación:

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

Crear respuesta

POST {endpoint}/openai/v1/responses

Crea una respuesta modelo.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	server	Sí	string	Un endpoint compatible con APIs de Fundición de IA de Azure Models, incluyendo protocolo y nombre de host. Por ejemplo: https://westus.api.cognitive.microsoft.com).
versión de la API	query	No	string Valores posibles: `v1`, `preview`	La versión explícita de la API de modelos de Fundición de IA de Azure que se va a usar para esta solicitud. `v1` si no se especifica lo contrario.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
fondo	booleano o null		No
conversación	OpenAI.ConversationParam o null		No
incluír	matriz de OpenAI.IncludeEnum o null		No
input	OpenAI.InputParam	Entradas de texto, imagen o archivo al modelo, usadas para generar una respuesta. Aprende más: - Entradas y salidas de texto - Entradas de imagen - Entradas de archivo - Estado de conversación - Llamada a funciones	No
instructions	string o null		No
max_output_tokens	entero o null		No
max_tool_calls	entero o null		No
metadatos	OpenAI.Metadata o null		No
model	string	Id. de modelo usado para generar la respuesta, como `gpt-4o` o `o3`. OpenAI ofrece una amplia gama de modelos con diferentes funcionalidades, rendimiento características y puntos de precio. Consulte la guía del modelo. para examinar y comparar los modelos disponibles.	No
parallel_tool_calls	booleano o null		No
previous_response_id	string o null		No
prompt	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Obtenga más información.	No
prompt_cache_key	string	Usado por OpenAI para almacenar en caché las respuestas de solicitudes similares para optimizar las tasas de aciertos de caché. Reemplaza el `user` campo. Obtenga más información.	No
prompt_cache_retention	string o null		No
reasoning	OpenAI.Reasoning o null		No
safety_identifier	string	Identificador estable que se usa para ayudar a detectar usuarios de la aplicación que pueden estar infringiendo las directivas de uso de OpenAI. Los identificadores deben ser una cadena que identifique de forma única a cada usuario. Se recomienda aplicar un hash a su nombre de usuario o dirección de correo electrónico para evitar enviarnos información de identificación. Obtenga más información.	No
store	booleano o null		No
stream	booleano o null		No
stream_options	OpenAI.ResponseStreamOptions o null		No
temperatura	number o null		No
text	OpenAI.ResponseTextParam	Opciones de configuración para una respuesta de texto del modelo. Puede ser simple texto o datos JSON estructurados. Aprende más: - Entradas y salidas de texto - Salidas estructuradas	No
tool_choice	OpenAI.ToolChoiceParam	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
tools	OpenAI.ToolsArray	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda de archivos. - Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, habilitando el modelo para llamar a su propio código.	No
top_logprobs	entero o null		No
top_p	number o null		No
truncation	string o null		No
user	string (en desuso)	Este campo se va a reemplazar por `safety_identifier` y `prompt_cache_key`. Use `prompt_cache_key` en su lugar para mantener las optimizaciones de almacenamiento en caché. Identificador estable para los usuarios finales. Se usa para aumentar las tasas de aciertos de caché mediante una mejor creación de depósitos de solicitudes similares y para ayudar a OpenAI a detectar y evitar abusos. Obtenga más información.	No

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	object
text/event-stream	object

Nombre	Tipo	Description	Obligatorio	Predeterminado
fondo	booleano o null		No
completado_en	string o null		No
content_filters	matriz de AzureContentFilterForResponsesAPI	Los resultados del filtro de contenido de RAI.	Sí
conversación	OpenAI.ConversationReference o null		No
fecha_de_creación	entero (unixtime)	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
error	OpenAI.ResponseError o null		Sí
id	string	Identificador único de esta respuesta.	Sí
incomplete_details	OpenAI.ResponseIncompleteDetails o null		Sí
instructions	cadena o matriz de OpenAI.InputItem o null		Sí
max_output_tokens	entero o null		No
max_tool_calls	entero o null		No
metadatos	OpenAI.Metadata o null		No
model	string	Id. de modelo usado para generar la respuesta, como `gpt-4o` o `o3`. OpenAI ofrece una amplia gama de modelos con diferentes funcionalidades, rendimiento características y puntos de precio. Consulte la guía del modelo. para examinar y comparar los modelos disponibles.	No
object	enum	El tipo de objeto de este recurso: siempre se establece en `response`. Valores posibles: `response`	Sí
output	matriz de OpenAI.OutputItem	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la `output` matriz dependen en la respuesta del modelo. - En lugar de tener acceso al primer elemento de la `output` matriz y suponiendo que es un `assistant` mensaje con el contenido generado por el modelo, podría considerar la posibilidad de usar la propiedad `output_text` donde compatible con los SDK.	Sí
output_text	string o null		No
parallel_tool_calls	boolean	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	Sí	True
previous_response_id	string o null		No
prompt	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Obtenga más información.	No
prompt_cache_key	string	Usado por OpenAI para almacenar en caché las respuestas de solicitudes similares para optimizar las tasas de aciertos de caché. Reemplaza el `user` campo. Obtenga más información.	No
prompt_cache_retention	string o null		No
reasoning	OpenAI.Reasoning o null		No
safety_identifier	string	Identificador estable que se usa para ayudar a detectar usuarios de la aplicación que pueden estar infringiendo las directivas de uso de OpenAI. Los identificadores deben ser una cadena que identifique de forma única a cada usuario. Se recomienda aplicar un hash a su nombre de usuario o dirección de correo electrónico para evitar enviarnos información de identificación. Obtenga más información.	No
status	enum	Estado de la generación de respuesta. Uno de `completed`, , `failed` `in_progress`, `cancelled`, `queued`o `incomplete`. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
temperatura	number o null		No
text	OpenAI.ResponseTextParam	Opciones de configuración para una respuesta de texto del modelo. Puede ser simple texto o datos JSON estructurados. Aprende más: - Entradas y salidas de texto - Salidas estructuradas	No
tool_choice	OpenAI.ToolChoiceParam	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
tools	OpenAI.ToolsArray	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Se admiten las siguientes categorías de herramientas: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda web o búsqueda de archivos. Más información sobre herramientas integradas. - Herramientas de MCP: integraciones con sistemas de terceros a través de servidores MCP personalizados o conectores predefinidos, como Google Drive y SharePoint. Más información sobre Herramientas de MCP. - Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, permitir que el modelo llame a su propio código con argumentos fuertemente tipados y salidas. Más información sobre llamada a función. También puede usar herramientas personalizadas para llamar a su propio código.	No
top_logprobs	entero o null		No
top_p	number o null		No
truncation	string o null		No
uso	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
user	string (en desuso)	Este campo se va a reemplazar por `safety_identifier` y `prompt_cache_key`. Use `prompt_cache_key` en su lugar para mantener las optimizaciones de almacenamiento en caché. Identificador estable para los usuarios finales. Se usa para aumentar las tasas de aciertos de caché mediante una mejor creación de depósitos de solicitudes similares y para ayudar a OpenAI a detectar y evitar abusos. Obtenga más información.	No

Encabezados de respuesta:

Encabezado	Tipo	Description
apim-request-id	string	Identificador de solicitud que se usa para solucionar problemas.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	object

Nombre	Tipo	Obligatorio
código	string o null	Sí
inner_error		No
message	string	Sí
param	string o null	Sí
type	string	Sí

Encabezados de respuesta:

Encabezado	Tipo	Description
apim-request-id	string	Identificador de solicitud que se usa para solucionar problemas.

Examples

Example

Creación de una respuesta de modelo

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

Obtener respuesta

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

Recupera una respuesta de modelo con el identificador especificado.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	server	Sí	string	Un endpoint compatible con APIs de Fundición de IA de Azure Models, incluyendo protocolo y nombre de host. Por ejemplo: https://westus.api.cognitive.microsoft.com).
versión de la API	query	No	string Valores posibles: `v1`, `preview`	La versión explícita de la API de modelos de Fundición de IA de Azure que se va a usar para esta solicitud. `v1` si no se especifica lo contrario.
response_id	path	Sí	string
include[]	query	No	array	Campos adicionales que se van a incluir en la respuesta. Consulte el parámetro include para la creación de respuestas anterior para obtener más información.
stream	query	No	boolean	Si se establece en true, los datos de respuesta del modelo se transmitirán al cliente a medida que se generan mediante eventos enviados por el servidor. Serialización: explotar: falso
starting_after	query	No	entero (int32)	Número de secuencia del evento después del cual se va a iniciar el streaming. Serialización: explotar: falso
include_obfuscation	query	No	boolean	Cuando sea true, se habilitará la ofuscación de la secuencia. La ofuscación de secuencias agrega caracteres aleatorios a un `obfuscation` campo en eventos delta de streaming para normalizar los tamaños de carga como una mitigación de determinados ataques de canal lateral. Estos campos de ofuscación se incluyen de forma predeterminada, pero agregan una pequeña cantidad de sobrecarga al flujo de datos. Puede establecer en `include_obfuscation` false para optimizar el ancho de banda si confía en los vínculos de red entre la aplicación y la API de OpenAI. Serialización: explotar: falso

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	object

Nombre	Tipo	Description	Obligatorio	Predeterminado
fondo	booleano o null		No
completado_en	string o null		No
content_filters	matriz de AzureContentFilterForResponsesAPI	Los resultados del filtro de contenido de RAI.	Sí
conversación	OpenAI.ConversationReference o null		No
fecha_de_creación	entero (unixtime)	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
error	OpenAI.ResponseError o null		Sí
id	string	Identificador único de esta respuesta.	Sí
incomplete_details	OpenAI.ResponseIncompleteDetails o null		Sí
instructions	cadena o matriz de OpenAI.InputItem o null		Sí
max_output_tokens	entero o null		No
max_tool_calls	entero o null		No
metadatos	OpenAI.Metadata o null		No
model	string	Id. de modelo usado para generar la respuesta, como `gpt-4o` o `o3`. OpenAI ofrece una amplia gama de modelos con diferentes funcionalidades, rendimiento características y puntos de precio. Consulte la guía del modelo. para examinar y comparar los modelos disponibles.	No
object	enum	El tipo de objeto de este recurso: siempre se establece en `response`. Valores posibles: `response`	Sí
output	matriz de OpenAI.OutputItem	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la `output` matriz dependen en la respuesta del modelo. - En lugar de tener acceso al primer elemento de la `output` matriz y suponiendo que es un `assistant` mensaje con el contenido generado por el modelo, podría considerar la posibilidad de usar la propiedad `output_text` donde compatible con los SDK.	Sí
output_text	string o null		No
parallel_tool_calls	boolean	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	Sí	True
previous_response_id	string o null		No
prompt	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Obtenga más información.	No
prompt_cache_key	string	Usado por OpenAI para almacenar en caché las respuestas de solicitudes similares para optimizar las tasas de aciertos de caché. Reemplaza el `user` campo. Obtenga más información.	No
prompt_cache_retention	string o null		No
reasoning	OpenAI.Reasoning o null		No
safety_identifier	string	Identificador estable que se usa para ayudar a detectar usuarios de la aplicación que pueden estar infringiendo las directivas de uso de OpenAI. Los identificadores deben ser una cadena que identifique de forma única a cada usuario. Se recomienda aplicar un hash a su nombre de usuario o dirección de correo electrónico para evitar enviarnos información de identificación. Obtenga más información.	No
status	enum	Estado de la generación de respuesta. Uno de `completed`, , `failed` `in_progress`, `cancelled`, `queued`o `incomplete`. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
temperatura	number o null		No
text	OpenAI.ResponseTextParam	Opciones de configuración para una respuesta de texto del modelo. Puede ser simple texto o datos JSON estructurados. Aprende más: - Entradas y salidas de texto - Salidas estructuradas	No
tool_choice	OpenAI.ToolChoiceParam	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
tools	OpenAI.ToolsArray	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Se admiten las siguientes categorías de herramientas: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda web o búsqueda de archivos. Más información sobre herramientas integradas. - Herramientas de MCP: integraciones con sistemas de terceros a través de servidores MCP personalizados o conectores predefinidos, como Google Drive y SharePoint. Más información sobre Herramientas de MCP. - Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, permitir que el modelo llame a su propio código con argumentos fuertemente tipados y salidas. Más información sobre llamada a función. También puede usar herramientas personalizadas para llamar a su propio código.	No
top_logprobs	entero o null		No
top_p	number o null		No
truncation	string o null		No
uso	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
user	string (en desuso)	Este campo se va a reemplazar por `safety_identifier` y `prompt_cache_key`. Use `prompt_cache_key` en su lugar para mantener las optimizaciones de almacenamiento en caché. Identificador estable para los usuarios finales. Se usa para aumentar las tasas de aciertos de caché mediante una mejor creación de depósitos de solicitudes similares y para ayudar a OpenAI a detectar y evitar abusos. Obtenga más información.	No

Encabezados de respuesta:

Encabezado	Tipo	Description
apim-request-id	string	Identificador de solicitud que se usa para solucionar problemas.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	object

Nombre	Tipo	Obligatorio
código	string o null	Sí
inner_error		No
message	string	Sí
param	string o null	Sí
type	string	Sí

Encabezados de respuesta:

Encabezado	Tipo	Description
apim-request-id	string	Identificador de solicitud que se usa para solucionar problemas.

Eliminar respuesta

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

Elimina una respuesta por identificador.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	server	Sí	string	Un endpoint compatible con APIs de Fundición de IA de Azure Models, incluyendo protocolo y nombre de host. Por ejemplo: https://westus.api.cognitive.microsoft.com).
versión de la API	query	No	string Valores posibles: `v1`, `preview`	La versión explícita de la API de modelos de Fundición de IA de Azure que se va a usar para esta solicitud. `v1` si no se especifica lo contrario.
response_id	path	Sí	string

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	object

Nombre	Tipo	Description	Obligatorio
eliminado	enum	Valores posibles: `True`	Sí
id	string		Sí
object	enum	Valores posibles: `response.deleted`	Sí

Encabezados de respuesta:

Encabezado	Tipo	Description
apim-request-id	string	Identificador de solicitud que se usa para solucionar problemas.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	object

Nombre	Tipo	Obligatorio
código	string o null	Sí
inner_error		No
message	string	Sí
param	string o null	Sí
type	string	Sí

Encabezados de respuesta:

Encabezado	Tipo	Description
apim-request-id	string	Identificador de solicitud que se usa para solucionar problemas.

Cancelar respuesta

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

Cancela una respuesta de modelo con el identificador especificado. Solo se pueden cancelar las respuestas creadas con el parámetro en segundo plano establecido en true.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	server	Sí	string	Un endpoint compatible con APIs de Fundición de IA de Azure Models, incluyendo protocolo y nombre de host. Por ejemplo: https://westus.api.cognitive.microsoft.com).
versión de la API	query	No	string Valores posibles: `v1`, `preview`	La versión explícita de la API de modelos de Fundición de IA de Azure que se va a usar para esta solicitud. `v1` si no se especifica lo contrario.
response_id	path	Sí	string

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	object

Nombre	Tipo	Description	Obligatorio	Predeterminado
fondo	booleano o null		No
completado_en	string o null		No
content_filters	matriz de AzureContentFilterForResponsesAPI	Los resultados del filtro de contenido de RAI.	Sí
conversación	OpenAI.ConversationReference o null		No
fecha_de_creación	entero (unixtime)	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
error	OpenAI.ResponseError o null		Sí
id	string	Identificador único de esta respuesta.	Sí
incomplete_details	OpenAI.ResponseIncompleteDetails o null		Sí
instructions	cadena o matriz de OpenAI.InputItem o null		Sí
max_output_tokens	entero o null		No
max_tool_calls	entero o null		No
metadatos	OpenAI.Metadata o null		No
model	string	Id. de modelo usado para generar la respuesta, como `gpt-4o` o `o3`. OpenAI ofrece una amplia gama de modelos con diferentes funcionalidades, rendimiento características y puntos de precio. Consulte la guía del modelo. para examinar y comparar los modelos disponibles.	No
object	enum	El tipo de objeto de este recurso: siempre se establece en `response`. Valores posibles: `response`	Sí
output	matriz de OpenAI.OutputItem	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la `output` matriz dependen en la respuesta del modelo. - En lugar de tener acceso al primer elemento de la `output` matriz y suponiendo que es un `assistant` mensaje con el contenido generado por el modelo, podría considerar la posibilidad de usar la propiedad `output_text` donde compatible con los SDK.	Sí
output_text	string o null		No
parallel_tool_calls	boolean	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	Sí	True
previous_response_id	string o null		No
prompt	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Obtenga más información.	No
prompt_cache_key	string	Usado por OpenAI para almacenar en caché las respuestas de solicitudes similares para optimizar las tasas de aciertos de caché. Reemplaza el `user` campo. Obtenga más información.	No
prompt_cache_retention	string o null		No
reasoning	OpenAI.Reasoning o null		No
safety_identifier	string	Identificador estable que se usa para ayudar a detectar usuarios de la aplicación que pueden estar infringiendo las directivas de uso de OpenAI. Los identificadores deben ser una cadena que identifique de forma única a cada usuario. Se recomienda aplicar un hash a su nombre de usuario o dirección de correo electrónico para evitar enviarnos información de identificación. Obtenga más información.	No
status	enum	Estado de la generación de respuesta. Uno de `completed`, , `failed` `in_progress`, `cancelled`, `queued`o `incomplete`. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
temperatura	number o null		No
text	OpenAI.ResponseTextParam	Opciones de configuración para una respuesta de texto del modelo. Puede ser simple texto o datos JSON estructurados. Aprende más: - Entradas y salidas de texto - Salidas estructuradas	No
tool_choice	OpenAI.ToolChoiceParam	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
tools	OpenAI.ToolsArray	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Se admiten las siguientes categorías de herramientas: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda web o búsqueda de archivos. Más información sobre herramientas integradas. - Herramientas de MCP: integraciones con sistemas de terceros a través de servidores MCP personalizados o conectores predefinidos, como Google Drive y SharePoint. Más información sobre Herramientas de MCP. - Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, permitir que el modelo llame a su propio código con argumentos fuertemente tipados y salidas. Más información sobre llamada a función. También puede usar herramientas personalizadas para llamar a su propio código.	No
top_logprobs	entero o null		No
top_p	number o null		No
truncation	string o null		No
uso	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
user	string (en desuso)	Este campo se va a reemplazar por `safety_identifier` y `prompt_cache_key`. Use `prompt_cache_key` en su lugar para mantener las optimizaciones de almacenamiento en caché. Identificador estable para los usuarios finales. Se usa para aumentar las tasas de aciertos de caché mediante una mejor creación de depósitos de solicitudes similares y para ayudar a OpenAI a detectar y evitar abusos. Obtenga más información.	No

Encabezados de respuesta:

Encabezado	Tipo	Description
apim-request-id	string	Identificador de solicitud que se usa para solucionar problemas.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	object

Nombre	Tipo	Obligatorio
código	string o null	Sí
inner_error		No
message	string	Sí
param	string o null	Sí
type	string	Sí

Encabezados de respuesta:

Encabezado	Tipo	Description
apim-request-id	string	Identificador de solicitud que se usa para solucionar problemas.

Enumerar elementos de entrada

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

Devuelve una lista de elementos de entrada para una respuesta determinada.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	server	Sí	string	Un endpoint compatible con APIs de Fundición de IA de Azure Models, incluyendo protocolo y nombre de host. Por ejemplo: https://westus.api.cognitive.microsoft.com).
versión de la API	query	No	string Valores posibles: `v1`, `preview`	La versión explícita de la API de modelos de Fundición de IA de Azure que se va a usar para esta solicitud. `v1` si no se especifica lo contrario.
response_id	path	Sí	string
limit	query	No	entero (int32)	Límite en el número de objetos que se van a devolver. El límite puede oscilar entre 1 y 100 y el valor predeterminado es 20. Serialización: explotar: falso
order	query	No	string Valores posibles: `asc`, `desc`	Criterio de ordenación por la `created_at` marca de tiempo de los objetos. `asc` para orden ascendente y`desc` para orden descendente. Serialización: explotar: falso
después	query	No	string	Cursor para su uso en la paginación. `after` es un identificador de objeto que define su lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos, finalizando con obj_foo, La llamada subsiguiente puede incluir after=obj_foo para obtener la siguiente página de la lista. Serialización: explotar: falso
before	query	No	string	Cursor para su uso en la paginación. `before` es un identificador de objeto que define su lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos, finalizando con obj_foo, La llamada posterior puede incluir before=obj_foo para capturar la página anterior de la lista. Serialización: explotar: falso

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	OpenAI.ResponseItemList

Encabezados de respuesta:

Encabezado	Tipo	Description
apim-request-id	string	Identificador de solicitud que se usa para solucionar problemas.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	object

Nombre	Tipo	Obligatorio
código	string o null	Sí
inner_error		No
message	string	Sí
param	string o null	Sí
type	string	Sí

Encabezados de respuesta:

Encabezado	Tipo	Description
apim-request-id	string	Identificador de solicitud que se usa para solucionar problemas.

Components

AzureAIFoundryModelsApiVersion

Propiedad	Value
Type	string
Valores	`v1` `preview`

AzureContentFilterBlocklistResult

Colección de resultados de filtrado true/false para listas de bloqueo personalizadas configuradas.

Nombre	Tipo	Description	Obligatorio	Predeterminado
details	matriz de objeto	Los pares de identificadores individuales de lista de bloqueos y si han dado lugar a una acción de filtrado.	No
filtered	boolean	Valor que indica si alguna de las listas de bloqueados detalladas produjo una acción de filtrado.	Sí

AzureContentFilterCompletionTextSpan

Representación de un fragmento de texto de finalización tal como lo usan los resultados del filtro de contenido de Azure OpenAI.

Nombre	Tipo	Description	Obligatorio	Predeterminado
completion_end_offset	entero (int32)	Desplazamiento del primer punto de código UTF32 que se excluye del intervalo. Este campo siempre es igual a completion_start_offset para intervalos vacíos. Este campo siempre es mayor que completion_start_offset para intervalos no vacíos.	Sí
completion_start_offset	entero (int32)	Desplazamiento del punto de código UTF32 que comienza el intervalo.	Sí

AzureContentFilterCompletionTextSpanDetectionResult

Nombre	Tipo	Description	Obligatorio
details	matriz de AzureContentFilterCompletionTextSpan	Información detallada sobre los intervalos de texto de finalización detectados.	Sí
detectado	boolean	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	Sí
filtered	boolean	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	Sí

AzureContentFilterCustomTopicResult

Colección de resultados de filtrado true/false para temas personalizados configurados.

Nombre	Tipo	Description	Obligatorio	Predeterminado
details	matriz de objeto	Pares de identificadores de tema individuales y si se detectan.	No
filtered	boolean	Valor que indica si alguno de los temas detallados produjo una acción de filtrado.	Sí

AzureContentFilterDetectionResult

Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se detectó y si el contenido se filtró.

Nombre	Tipo	Description	Obligatorio	Predeterminado
detectado	boolean	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	Sí
filtered	boolean	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	Sí

AzureContentFilterForResponsesAPI

Nombre	Tipo	Description	Obligatorio
bloqueado	boolean	Indique si la respuesta está bloqueada.	Sí
content_filter_offsets	AzureContentFilterResultOffsets		Sí
content_filter_results	AzureContentFilterResultsForResponsesAPI		Sí
└─ listas_de_bloqueo_personalizadas	AzureContentFilterBlocklistResult	Colección de resultados de filtrado binario para listas de bloqueo personalizadas configuradas.	No
└─ temas_personalizados	AzureContentFilterCustomTopicResult	Colección de resultados de filtrado binario para temas personalizados configurados.	No
└─ Error	object	Si está presente, detalles sobre un error que impidió que se completara la evaluación del filtrado de contenido.	No
└─ código	entero (int32)	Un código distinto legible por la máquina asociado al error.	Sí
└─ Mensaje	string	Mensaje legible asociado al error.	Sí
└─ odio	AzureContentFilterSeverityResult	Categoría de filtro de contenido que puede hacer referencia a cualquier contenido que ataque o use pejorante o discriminatorio. idioma con referencia a una persona o grupo de identidades en función de determinados atributos diferenciadores de estos grupos incluyendo, entre otros, la raza, la etnia, la nacionalidad, la identidad y la expresión de género, la orientación sexual, religión, estado de inmigración, estado de capacidad, apariencia personal y tamaño corporal.	No
└─ ataque_indirecto	AzureContentFilterDetectionResult	Resultado de detección que describe los ataques en sistemas con tecnología de modelos de IA generativos que pueden producirse cada vez una aplicación procesa la información que no ha creado directamente el desarrollador de la aplicación o el usuario.	No
└─ liberar	AzureContentFilterDetectionResult	Resultado de detección que describe los ataques de inyección de mensajes de usuario, donde los usuarios malintencionados aprovechan deliberadamente vulnerabilidades del sistema al comportamiento no autorizado del LLM. Esto podría dar lugar a contenido inapropiado generación o infracciones de restricciones impuestas por el sistema.	Sí
└" personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Resultado de detección que describe las coincidencias con la información de identificación personal con subcategorías configurables.	No
└─ blasfemia	AzureContentFilterDetectionResult	Resultado de la detección que identifica si el lenguaje de objeción es crudo, vulgar o de otro modo está presente en contenido.	No
└" protected_material_code	object	Resultado de detección que describe una coincidencia con el código con licencia u otro material de origen protegido.	No
└─ cita	object	Si está disponible, los detalles de la cita que describen la licencia asociada y su ubicación.	No
└─ URL	string (URI)	Dirección URL asociada a la licencia.	No
└─ Licencia	string	Nombre o identificador de la licencia asociada a la detección.	No
└─ detectado	boolean	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	Sí
└* filtrado	boolean	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	Sí
└" protected_material_text	AzureContentFilterDetectionResult	Resultado de detección que describe una coincidencia con el texto protegido bajo derechos de autor u otro estado.	No
└─ autolesión	AzureContentFilterSeverityResult	Categoría de filtro de contenido que describe el lenguaje relacionado con las acciones físicas destinadas a hacer daño, lesiones, dañar el cuerpo de uno mismo o matarse.	No
└— sexual	AzureContentFilterSeverityResult	Categoría de filtro de contenido para lenguaje relacionado con órganos anatómicos y genitales, relaciones románticas, actos representados en términos eróticos o cariñosos, embarazos, actos sexuales físicos, incluidos aquellos representados como agresión o un acto sexual forzado violento contra la voluntad de uno, prostitución, pornografía y abuso.	No
└" task_adherence	AzureContentFilterDetectionResult	Resultado de detección que indica si el flujo de ejecución sigue manteniendo el plan.	Sí
└" ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
└─ violencia	AzureContentFilterSeverityResult	Categoría de filtro de contenido para lenguaje relacionado con acciones físicas destinadas a dañar, dañar, dañar o matar alguien o algo; describe armas, armas y entidades relacionadas, como manufacturas, asociaciones, legislación, etc.	No
tipo_de_fuente	string	Nombre del tipo de origen del mensaje.	Sí

AzureContentFilterPersonallyIdentifiableInformationResult

Resultado de la detección de filtros de contenido para información de identificación personal que incluye extensiones perjudiciales.

Nombre	Tipo	Description	Obligatorio
detectado	boolean	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	Sí
filtered	boolean	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	Sí
redacted_text	string	Texto censurado con información de PII quitada o enmascarada.	No
sub_categories	matriz de AzurePiiSubCategoryResult	Resultados detallados de PIIHarmSubCategory(s) individuales.	No

AzureContentFilterResultOffsets

Nombre	Tipo	Obligatorio
check_offset	entero (int32)	Sí
end_offset	entero (int32)	Sí
start_offset	entero (int32)	Sí

AzureContentFilterResultsForResponsesAPI

Nombre	Tipo	Description	Obligatorio
custom_blocklists	AzureContentFilterBlocklistResult	Colección de resultados de filtrado true/false para listas de bloqueo personalizadas configuradas.	No
└─ detalles	matriz de objeto	Los pares de identificadores individuales de lista de bloqueos y si han dado lugar a una acción de filtrado.	No
└* filtrado	boolean	Valor que indica si la lista de bloqueados generó una acción de filtrado.	Sí
└─ id.	string	Identificador de la lista de bloques personalizada evaluada.	Sí
└* filtrado	boolean	Valor que indica si alguna de las listas de bloqueados detalladas produjo una acción de filtrado.	Sí
custom_topics	AzureContentFilterCustomTopicResult	Colección de resultados de filtrado true/false para temas personalizados configurados.	No
└─ detalles	matriz de objeto	Pares de identificadores de tema individuales y si se detectan.	No
└─ detectado	boolean	Valor que indica si se detecta el tema.	Sí
└─ id.	string	Identificador del tema personalizado evaluado.	Sí
└* filtrado	boolean	Valor que indica si alguno de los temas detallados produjo una acción de filtrado.	Sí
error	object	Si está presente, detalles sobre un error que impidió que se completara la evaluación del filtrado de contenido.	No
└─ código	entero (int32)	Un código distinto legible por la máquina asociado al error.	Sí
└─ Mensaje	string	Mensaje legible asociado al error.	Sí
odio	AzureContentFilterSeverityResult	Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se ha filtrado y cuál es la calidad el nivel de gravedad del contenido se ha evaluado con respecto a la configuración del filtro de contenido de la categoría.	No
└* filtrado	boolean	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	Sí
└─ gravedad	enum	La gravedad etiquetada del contenido. Valores posibles: `safe`, `low`, `medium`, `high`	Sí
indirect_attack	AzureContentFilterDetectionResult	Elemento de resultado del filtro de contenido etiquetado que indica si se detectó el contenido y si el contenido era filtrada.	No
└─ detectado	boolean	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	Sí
└* filtrado	boolean	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	Sí
jailbreak	AzureContentFilterDetectionResult	Elemento de resultado del filtro de contenido etiquetado que indica si se detectó el contenido y si el contenido era filtrada.	Sí
└─ detectado	boolean	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	Sí
└* filtrado	boolean	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	Sí
personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Resultado de la detección de filtros de contenido para información de identificación personal que incluye extensiones perjudiciales.	No
└" redacted_text	string	Texto censurado con información de PII quitada o enmascarada.	No
└─ sub_categorías	matriz de AzurePiiSubCategoryResult	Resultados detallados de PIIHarmSubCategory(s) individuales.	No
soece	AzureContentFilterDetectionResult	Elemento de resultado del filtro de contenido etiquetado que indica si se detectó el contenido y si el contenido era filtrada.	No
└─ detectado	boolean	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	Sí
└* filtrado	boolean	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	Sí
protected_material_code	object	Resultado de detección que describe una coincidencia con el código con licencia u otro material de origen protegido.	No
└─ cita	object	Si está disponible, los detalles de la cita que describen la licencia asociada y su ubicación.	No
└─ URL	string (URI)	Dirección URL asociada a la licencia.	No
└─ Licencia	string	Nombre o identificador de la licencia asociada a la detección.	No
└─ detectado	boolean	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	Sí
└* filtrado	boolean	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	Sí
protected_material_text	AzureContentFilterDetectionResult	Elemento de resultado del filtro de contenido etiquetado que indica si se detectó el contenido y si el contenido era filtrada.	No
└─ detectado	boolean	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	Sí
└* filtrado	boolean	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	Sí
self_harm	AzureContentFilterSeverityResult	Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se ha filtrado y cuál es la calidad el nivel de gravedad del contenido se ha evaluado con respecto a la configuración del filtro de contenido de la categoría.	No
└* filtrado	boolean	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	Sí
└─ gravedad	enum	La gravedad etiquetada del contenido. Valores posibles: `safe`, `low`, `medium`, `high`	Sí
sexual	AzureContentFilterSeverityResult	Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se ha filtrado y cuál es la calidad el nivel de gravedad del contenido se ha evaluado con respecto a la configuración del filtro de contenido de la categoría.	No
└* filtrado	boolean	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	Sí
└─ gravedad	enum	La gravedad etiquetada del contenido. Valores posibles: `safe`, `low`, `medium`, `high`	Sí
task_adherence	AzureContentFilterDetectionResult	Elemento de resultado del filtro de contenido etiquetado que indica si se detectó el contenido y si el contenido era filtrada.	Sí
└─ detectado	boolean	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	Sí
└* filtrado	boolean	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	Sí
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
violencia	AzureContentFilterSeverityResult	Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se ha filtrado y cuál es la calidad el nivel de gravedad del contenido se ha evaluado con respecto a la configuración del filtro de contenido de la categoría.	No
└* filtrado	boolean	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	Sí
└─ gravedad	enum	La gravedad etiquetada del contenido. Valores posibles: `safe`, `low`, `medium`, `high`	Sí

AzureContentFilterSeverityResult

Elemento de resultado de filtro de contenido etiquetado que indica si se filtró el contenido y cuál era el nivel de gravedad cualitativo del contenido, según se evaluó en relación con el filtro de contenido configurado para la categoría.

Nombre	Tipo	Description	Obligatorio	Predeterminado
filtered	boolean	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	Sí
severity	enum	La gravedad etiquetada del contenido. Valores posibles: `safe`, `low`, `medium`, `high`	Sí

AzurePiiSubCategoryResult

Detalles del resultado de PIIHarmSubCategory(s) individuales.

Nombre	Tipo	Description	Obligatorio
detectado	boolean	Indica si se detectó la subcategoría de contenido con etiqueta en el contenido.	Sí
filtered	boolean	Si la detección de contenido dio lugar a una acción de filtrado de contenido para esta subcategoría.	Sí
redactada	boolean	Si el contenido se redactó para esta subcategoría.	Sí
sub_category	string	PiIHarmSubCategory que se evaluó.	Sí

OpenAI.Annotation

Anotación que se aplica a un intervalo de texto de salida.

Discriminador para OpenAI.Annotation

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de valor	Schema
`file_citation`	OpenAI.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.AnnotationType		Sí

OpenAI.AnnotationType

Propiedad	Value
Type	string
Valores	`file_citation` `url_citation` `container_file_citation` `file_path`

OpenAI.ApplyPatchCallOutputStatus

Propiedad	Value
Type	string
Valores	`completed` `failed`

OpenAI.ApplyPatchCallStatus

Propiedad	Value
Type	string
Valores	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

Aplicar la operación de creación de archivo con parche

Instrucción que describe cómo crear un archivo a través de la herramienta apply_patch.

Nombre	Tipo	Description	Obligatorio	Predeterminado
diferencias	string	Diff que se va a aplicar.	Sí
path	string	Ruta de acceso del archivo que se va a crear.	Sí
type	enum	Cree un nuevo archivo con la diferencia proporcionada. Valores posibles: `create_file`	Sí	create_file

OpenAI.ApplyPatchDeleteFileOperation

Aplicar la operación de eliminación de archivos con parche

Instrucción que describe cómo eliminar un archivo a través de la herramienta apply_patch.

Nombre	Tipo	Description	Obligatorio	Predeterminado
path	string	Ruta de acceso del archivo que se va a eliminar.	Sí
type	enum	Elimine el archivo especificado. Valores posibles: `delete_file`	Sí	delete_file

OpenAI.ApplyPatchFileOperation

Aplicar operación de parche

Una de las operaciones de create_file, delete_file o update_file aplicadas a través de apply_patch.

Discriminador para OpenAI.ApplyPatchFileOperation

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de valor	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ApplyPatchFileOperationType		Sí

OpenAI.ApplyPatchFileOperationType

Propiedad	Value
Type	string
Valores	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

Aplicar herramienta de parche

Permite al asistente crear, eliminar o actualizar archivos mediante diferencias unificadas.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de la herramienta. Siempre `apply_patch`. Valores posibles: `apply_patch`	Sí	apply_patch

OpenAI.ApplyPatchUpdateFileOperation

Aplicar operación de actualización de archivo de parche

Instrucción que describe cómo actualizar un archivo a través de la herramienta apply_patch.

Nombre	Tipo	Description	Obligatorio	Predeterminado
diferencias	string	Diff que se va a aplicar.	Sí
path	string	Ruta de acceso del archivo que se va a actualizar.	Sí
type	enum	Actualice un archivo existente con la diferencia proporcionada. Valores posibles: `update_file`	Sí	update_file

OpenAI.ApproximateLocation

Nombre	Tipo	Description	Obligatorio	Predeterminado
ciudad	string o null		No
country	string o null		No
region	string o null		No
zona horaria	string o null		No
type	enum	Tipo de aproximación de ubicación. Siempre `approximate`. Valores posibles: `approximate`	Sí	Aproximado

OpenAI.ClickButtonType

Propiedad	Value
Type	string
Valores	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

Haga clic en

Una acción de clic.

Nombre	Tipo	Description	Obligatorio	Predeterminado
button	OpenAI.ClickButtonType		Sí
type	enum	Especifica el tipo de evento. Para una acción de clic, esta propiedad siempre `click`es . Valores posibles: `click`	Sí	click
x	integer	Coordenada x donde se produjo el clic.	Sí
y	integer	Coordenada y donde se produjo el clic.	Sí

OpenAI.CodeInterpreterContainerAuto

CodeInterpreterToolAuto

Configuración de un contenedor de intérpretes de código. Opcionalmente, especifique los identificadores de los archivos en los que ejecutar el código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
identificadores de archivos	matriz de cadenas	Lista opcional de archivos cargados para que estén disponibles para tu código. Restricciones: máximoObjetos: 50	No
límite_de_memoria	OpenAI.ContainerMemoryLimit o null		No
type	enum	Siempre `auto`. Valores posibles: `auto`	Sí	auto

OpenAI.CodeInterpreterOutputImage

Imagen de salida del intérprete de código

Salida de la imagen del intérprete de código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de la salida. Siempre `image`. Valores posibles: `image`	Sí	imagen
url	string (URI)	Dirección URL de la salida de la imagen del intérprete de código.	Sí

OpenAI.CodeInterpreterOutputLogs

Registros de salida del intérprete de código

La salida de registros del intérprete de código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
logs	string	La salida de registros del intérprete de código.	Sí
type	enum	Tipo de la salida. Siempre `logs`. Valores posibles: `logs`	Sí	logs

OpenAI.CodeInterpreterTool

Intérprete de código

Herramienta que ejecuta código de Python para ayudar a generar una respuesta a un mensaje.

Nombre	Tipo	Description	Obligatorio	Predeterminado
container	string o OpenAI.CodeInterpreterContainerAuto	Contenedor del intérprete de código. Puede ser un identificador de contenedor o un objeto que especifica los identificadores de archivo cargados para que estén disponibles para el código, junto con un configuración opcional `memory_limit` .	Sí
type	enum	Tipo de la herramienta de intérprete de código. Siempre `code_interpreter`. Valores posibles: `code_interpreter`	Sí

OpenAI.ComparisonFilter

Filtro de comparación

Filtro usado para comparar una clave de atributo especificada con un valor determinado mediante una operación de comparación definida.

Nombre	Tipo	Description	Obligatorio	Predeterminado
key	string	Clave que se va a comparar con el valor.	Sí
type	enum	Especifica el operador de comparación: `eq`, , `negtgteltlte`, , . `innin` - `eq`:Iguales - `ne`: no es igual a - `gt`: mayor que - `gte`: mayor o igual que - `lt`: menor que - `lte`: menor o igual que - `in`: en - `nin`: no en Valores posibles: `eq`, `ne`, `gt`, `gte`, , `lt`, `lte`	Sí	eq
value	string o number o boolean o array de OpenAI.ComparisonFilterValueItems	Valor que se va a comparar con la clave de atributo; admite tipos de cadena, número o booleano.	Sí

OpenAI.ComparisonFilterValueItems

Este esquema acepta uno de los siguientes tipos:

cadena
número

OpenAI.CompoundFilter

Filtro compuesto

Combine varios filtros mediante and o or.

Nombre	Tipo	Description	Obligatorio	Predeterminado
filtros	matriz de OpenAI.ComparisonFilter o objeto	Conjunto de filtros para combinar. Los elementos pueden ser `ComparisonFilter` o `CompoundFilter`.	Sí
type	enum	Tipo de operación: `and` o `or`. Valores posibles: `and`, `or`	Sí

OpenAI.ComputerAction

Discriminador para OpenAI.ComputerAction

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de valor	Schema
`click`	OpenAI.ClickParam
`double_click`	OpenAI.DoubleClickAction
`drag`	OpenAI.Drag
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.Move
`screenshot`	OpenAI.Screenshot
`scroll`	OpenAI.Scroll
`type`	OpenAI.Type
`wait`	OpenAI.Wait

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ComputerActionType		Sí

OpenAI.ComputerActionType

Propiedad	Value
Type	string
Valores	`click` `double_click` `drag` `keypress` `move` `screenshot` `scroll` `type` `wait`

OpenAI.ComputerCallSafetyCheckParam

Una comprobación de seguridad pendiente para la llamada del equipo.

Nombre	Tipo	Description	Obligatorio
código	string o null		No
id	string	Identificador de la comprobación de seguridad pendiente.	Sí
message	string o null		No

OpenAI.ComputerEnvironment

Propiedad	Value
Type	string
Valores	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerScreenshotImage

Imagen de captura de pantalla del equipo que se usa con la herramienta de uso del equipo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
ID del archivo	string	Identificador de un archivo cargado que contiene la captura de pantalla.	No
image_url	string (URI)	Dirección URL de la imagen de captura de pantalla.	No
type	enum	Especifica el tipo de evento. Para una captura de pantalla del equipo, esta propiedad es establezca siempre en `computer_screenshot`. Valores posibles: `computer_screenshot`	Sí	computer_screenshot

OpenAI.HerramientaDeVistaPreviaDeUsoDeComputadora

Vista previa del uso del ordenador

Herramienta que controla un equipo virtual.

Nombre	Tipo	Description	Obligatorio	Predeterminado
altura_de_pantalla	integer	La altura de la pantalla del ordenador.	Sí
ancho_de_pantalla	integer	Ancho de la pantalla del equipo.	Sí
environment	OpenAI.ComputerEnvironment		Sí
type	enum	Tipo de la herramienta para el uso de la computadora. Siempre `computer_use_preview`. Valores posibles: `computer_use_preview`	Sí	computer_use_preview

OpenAI.ContainerFileCitationBody

Cita de archivo contenedor

Cita de un archivo de contenedor usado para generar una respuesta de modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
container_id	string	Identificador del archivo de contenedor.	Sí
end_index	integer	Índice del último carácter de la cita del archivo de contenedor en el mensaje.	Sí
ID del archivo	string	Identificador del archivo.	Sí
filename	string	Nombre de archivo del archivo de contenedor mencionado.	Sí
start_index	integer	Índice del primer carácter de la cita del archivo de contenedor en el mensaje.	Sí
type	enum	Tipo de la cita del archivo de contenedor. Siempre `container_file_citation`. Valores posibles: `container_file_citation`	Sí	container_file_citation

OpenAI.ContainerMemoryLimit

Propiedad	Value
Type	string
Valores	`1g` `4g` `16g` `64g`

OpenAI.ConversationParam

Conversación a la que pertenece esta respuesta. Los elementos de esta conversación se anteponen a input_items para esta solicitud de respuesta. Los elementos de entrada y los elementos de salida de esta respuesta se agregan automáticamente a esta conversación una vez completada esta respuesta.

Tipo: string o OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

Objeto de conversación

Conversación a la que pertenece esta respuesta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	string	Identificador único de la conversación.	Sí

OpenAI.ConversationReference

Conversación

Conversación a la que pertenece esta respuesta. Los elementos de entrada y los elementos de salida de esta respuesta se agregaron automáticamente a esta conversación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	string	Identificador único de la conversación a la que estaba asociada esta respuesta.	Sí

OpenAI.CreateResponse

Nombre	Tipo	Description	Obligatorio
fondo	booleano o null		No
conversación	OpenAI.ConversationParam o null		No
incluír	matriz de OpenAI.IncludeEnum o null		No
input	OpenAI.InputParam	Entradas de texto, imagen o archivo al modelo, usadas para generar una respuesta. Aprende más: - Entradas y salidas de texto - Entradas de imagen - Entradas de archivo - Estado de conversación - Llamada a funciones	No
instructions	string o null		No
max_output_tokens	entero o null		No
max_tool_calls	entero o null		No
metadatos	OpenAI.Metadata o null		No
model	string	Id. de modelo usado para generar la respuesta, como `gpt-4o` o `o3`. OpenAI ofrece una amplia gama de modelos con diferentes funcionalidades, rendimiento características y puntos de precio. Consulte la guía del modelo. para examinar y comparar los modelos disponibles.	No
parallel_tool_calls	booleano o null		No
previous_response_id	string o null		No
prompt	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Obtenga más información.	No
prompt_cache_key	string	Usado por OpenAI para almacenar en caché las respuestas de solicitudes similares para optimizar las tasas de aciertos de caché. Reemplaza el `user` campo. Obtenga más información.	No
prompt_cache_retention	string o null		No
reasoning	OpenAI.Reasoning o null		No
safety_identifier	string	Identificador estable que se usa para ayudar a detectar usuarios de la aplicación que pueden estar infringiendo las directivas de uso de OpenAI. Los identificadores deben ser una cadena que identifique de forma única a cada usuario. Se recomienda aplicar un hash a su nombre de usuario o dirección de correo electrónico para evitar enviarnos información de identificación. Obtenga más información.	No
store	booleano o null		No
stream	booleano o null		No
stream_options	OpenAI.ResponseStreamOptions o null		No
temperatura	number o null		No
text	OpenAI.ResponseTextParam	Opciones de configuración para una respuesta de texto del modelo. Puede ser simple texto o datos JSON estructurados. Aprende más: - Entradas y salidas de texto - Salidas estructuradas	No
tool_choice	OpenAI.ToolChoiceParam	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
tools	OpenAI.ToolsArray	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda de archivos. - Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, habilitando el modelo para llamar a su propio código.	No
top_logprobs	entero o null		No
top_p	number o null		No
truncation	string o null		No
user	string (en desuso)	Este campo se va a reemplazar por `safety_identifier` y `prompt_cache_key`. Use `prompt_cache_key` en su lugar para mantener las optimizaciones de almacenamiento en caché. Identificador estable para los usuarios finales. Se usa para aumentar las tasas de aciertos de caché mediante una mejor creación de depósitos de solicitudes similares y para ayudar a OpenAI a detectar y evitar abusos. Obtenga más información.	No

OpenAI.CustomGrammarFormatParam

Formato gramatical

Gramática definida por el usuario.

Nombre	Tipo	Description	Obligatorio	Predeterminado
definición	string	Definición de gramática.	Sí
sintaxis	OpenAI.GrammarSyntax1		Sí
type	enum	Formato de gramática. Siempre `grammar`. Valores posibles: `grammar`	Sí	gramática

OpenAI.CustomTextFormatParam

Formato de texto

Texto de forma libre sin restricciones.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Formato de texto sin restricciones. Siempre `text`. Valores posibles: `text`	Sí	text

OpenAI.CustomToolParam

Herramienta personalizada

Una herramienta personalizada que procesa la entrada mediante un formato especificado. Más información sobre las herramientas personalizadas

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Descripción opcional de la herramienta personalizada, que se usa para proporcionar más contexto.	No
format	OpenAI.CustomToolParamFormat	Formato de entrada de la herramienta personalizada. El valor predeterminado es texto sin restricciones.	No
└─ Tipo	OpenAI.CustomToolParamFormatType		Sí
nombre	string	Nombre de la herramienta personalizada, que se usa para identificarla en las llamadas a herramientas.	Sí
type	enum	Tipo de la herramienta personalizada. Siempre `custom`. Valores posibles: `custom`	Sí	custom

OpenAI.CustomToolParamFormat

Formato de entrada de la herramienta personalizada. El valor predeterminado es texto sin restricciones.

Discriminador para OpenAI.CustomToolParamFormat

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de valor	Schema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.CustomToolParamFormatType		Sí

OpenAI.CustomToolParamFormatType

Propiedad	Value
Type	string
Valores	`text` `grammar`

OpenAI.DoubleClickAction

DoubleClick

Una acción de doble clic.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Especifica el tipo de evento. Para una acción de doble clic, esta propiedad siempre se establece en `double_click`. Valores posibles: `double_click`	Sí	double_click
x	integer	Coordenada x donde se produjo el doble clic.	Sí
y	integer	Coordenada y donde se produjo el doble clic.	Sí

OpenAI.Drag

Drag

Una acción de arrastre.

Nombre	Tipo	Description	Obligatorio	Predeterminado
path	matriz de OpenAI.DragPoint	Matriz de coordenadas que representa la trayectoria de la acción de arrastre. Las coordenadas aparecerán como una matriz de objetos, por ejemplo, `<br> [<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br> ]<br>`	Sí
type	enum	Especifica el tipo de evento. Para una acción de arrastre, esta propiedad es establezca siempre en `drag`. Valores posibles: `drag`	Sí	Resistencia

OpenAI.DragPoint

Coordinate

Un par de coordenadas x/y, por ejemplo { x: 100, y: 200 }, .

Nombre	Tipo	Description	Obligatorio	Predeterminado
x	integer	Coordenada x.	Sí
y	integer	La coordenada y.	Sí

OpenAI.EasyInputMessage

Mensaje de entrada

Una entrada de mensaje al modelo con un rol que indica el seguimiento de instrucciones dentro de una jerarquía. Las instrucciones dadas con el developer rol o system tienen prioridad sobre las instrucciones dadas con el user rol. Los mensajes con el rol assistant se presumen generados por el modelo en interacciones anteriores.

Nombre	Tipo	Description	Obligatorio
contenido	string o OpenAI.InputMessageContentList	Entrada de texto, imagen o audio al modelo, que se usa para generar una respuesta. También puede contener respuestas anteriores del asistente.	Sí
role	enum	Rol de la entrada del mensaje. Uno de `user`, `assistant`, `system`, o `developer`. Valores posibles: `user`, `assistant`, `system`, `developer`	Sí
type	enum	Tipo de la entrada del mensaje. Siempre `message`. Valores posibles: `message`	Sí

OpenAI.FileCitationBody

Cita del archivo

Cita a un archivo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
ID del archivo	string	Identificador del archivo.	Sí
filename	string	Nombre de archivo del archivo citado.	Sí
index	integer	Índice del archivo en la lista de archivos.	Sí
type	enum	Tipo de la cita de archivo. Siempre `file_citation`. Valores posibles: `file_citation`	Sí	file_citation

OpenAI.FilePath

Ruta de acceso del archivo

Ruta de acceso a un archivo.

Nombre	Tipo	Description	Obligatorio
ID del archivo	string	Identificador del archivo.	Sí
index	integer	Índice del archivo en la lista de archivos.	Sí
type	enum	Tipo de la ruta de acceso del archivo. Siempre `file_path`. Valores posibles: `file_path`	Sí

OpenAI.FileSearchTool

Búsqueda de archivos

Herramienta que busca contenido relevante de los archivos cargados.

Nombre	Tipo	Description	Obligatorio	Predeterminado
filtros	OpenAI.Filters o null		No
número_máximo_de_resultados	integer	Número máximo de resultados que se van a devolver. Este número debe estar comprendido entre 1 y 50 inclusive.	No
opciones_de_clasificación	OpenAI.RankingOptions		No
└" hybrid_search	OpenAI.HybridSearchOptions	Ponderaciones que controlan la forma en que la fusión de clasificación recíproca equilibra las coincidencias semánticas de incrustación frente a coincidencias de palabras clave dispersas cuando se habilita la búsqueda híbrida.	No
└─ clasificador	OpenAI.RankerVersionType	Clasificador que se va a usar para la búsqueda de archivos.	No
└─ umbral_de_puntuación	número	Umbral de puntuación para la búsqueda de archivos, un número comprendido entre 0 y 1. Los números más cercanos a 1 intentarán devolver solo los resultados más relevantes, pero pueden devolver menos resultados.	No
type	enum	Tipo de la herramienta de búsqueda de archivos. Siempre `file_search`. Valores posibles: `file_search`	Sí	file_search
vector_store_ids	matriz de cadenas	Identificadores de los almacenes vectoriales que se van a buscar.	Sí

OpenAI.FileSearchToolCallResults

Nombre	Tipo	Obligatorio
attributes	OpenAI.VectorStoreFileAttributes o null	No
ID del archivo	string	No
filename	string	No
puntuación	número (flotador)	No
text	string	No

OpenAI.Filters

Tipo: OpenAI.ComparisonFilter o OpenAI.CompoundFilter

OpenAI.FunctionAndCustomToolCallOutput

Discriminador para OpenAI.FunctionAndCustomToolCallOutput

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de valor	Schema
`input_text`	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
`input_image`	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.FunctionAndCustomToolCallOutputType		Sí

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Archivo de entrada

Entrada de archivo para el modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
file_data	string	Contenido del archivo que se va a enviar al modelo.	No
ID del archivo	string o null		No
file_url	string (URI)	Dirección URL del archivo que se va a enviar al modelo.	No
filename	string	Nombre del archivo que se va a enviar al modelo.	No
type	enum	Tipo del elemento de entrada. Siempre `input_file`. Valores posibles: `input_file`	Sí	input_file

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Imagen de entrada

Entrada de imagen en el modelo. Obtenga información sobre las entradas de imagen.

Nombre	Tipo	Description	Obligatorio	Predeterminado
detail	OpenAI.ImageDetail		Sí
ID del archivo	string o null		No
image_url	string o null		No
type	enum	Tipo del elemento de entrada. Siempre `input_image`. Valores posibles: `input_image`	Sí	input_image

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Texto de entrada

Entrada de texto al modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
text	string	Entrada de texto en el modelo.	Sí
type	enum	Tipo del elemento de entrada. Siempre `input_text`. Valores posibles: `input_text`	Sí	input_text

OpenAI.FunctionAndCustomToolCallOutputType

Propiedad	Value
Type	string
Valores	`input_text` `input_image` `input_file`

OpenAI.FunctionShellAction

Acción de los ejecutivos de Shell

Ejecute un comando de shell.

Nombre	Tipo	Obligatorio
commands	matriz de cadenas	Sí
max_output_length	entero o null	Sí
tiempo_de_espera_ms	entero o null	Sí

OpenAI.FunctionShellCallOutputContent

Contenido de salida de las llamadas de shell

Contenido de una salida de llamada de herramienta de shell que se emitió.

Nombre	Tipo	Description	Obligatorio
created_by	string	Identificador del actor que creó el elemento.	No
resultado	OpenAI.FunctionShellCallOutputOutcome	Representa un resultado de salida (con un código de salida) o un resultado de tiempo de espera para un fragmento de salida de llamada de shell.	Sí
└─ Tipo	OpenAI.FunctionShellCallOutputOutcomeType		Sí
stderr	string	Salida de error estándar capturada.	Sí
stdout	string	Salida estándar capturada.	Sí

OpenAI.FunctionShellCallOutputExitOutcome

Resultado de salida de la llamada shell

Indica que los comandos del shell finalizaron y devolvieron un código de salida.

Nombre	Tipo	Description	Obligatorio	Predeterminado
exit_code	integer	Salga del código del proceso de shell.	Sí
type	enum	Tipo de resultado. Siempre `exit`. Valores posibles: `exit`	Sí	exit

OpenAI.FunctionShellCallOutputOutcome

Resultado de la llamada shell

Representa un resultado de salida (con un código de salida) o un resultado de tiempo de espera para un fragmento de salida de llamada de shell.

Discriminador para OpenAI.FunctionShellCallOutputOutcome

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de valor	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcome
`exit`	OpenAI.FunctionShellCallOutputExitOutcome

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.FunctionShellCallOutputOutcomeType		Sí

OpenAI.FunctionShellCallOutputOutcomeType

Propiedad	Value
Type	string
Valores	`timeout` `exit`

OpenAI.FunctionShellCallOutputTimeoutOutcome

Resultado de tiempo límite de la llamada shell

Indica que la llamada al shell superó el límite de tiempo configurado.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de resultado. Siempre `timeout`. Valores posibles: `timeout`	Sí	timeout

OpenAI.FunctionShellToolParam

Herramienta de concha

Herramienta que permite al modelo ejecutar comandos de shell.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de la herramienta de shell. Siempre `shell`. Valores posibles: `shell`	Sí	shell

OpenAI.FunctionTool

Function

Define una función en tu propio código a la que el modelo puede elegir llamar.

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string o null		No
nombre	string	El nombre de la función para llamar.	Sí
parameters	object o null		Sí
strict	booleano o null		Sí
type	enum	Tipo de la herramienta de funciones. Siempre `function`. Valores posibles: `function`	Sí	function

OpenAI.GrammarSyntax1

Propiedad	Value
Type	string
Valores	`lark` `regex`

OpenAI.HybridSearchOptions

Nombre	Tipo	Description	Obligatorio	Predeterminado
embedding_weight	número	El peso de la incrustación en la fusión de clasificación recíproca.	Sí
text_weight	número	Peso del texto en la fusión de clasificación recíproca.	Sí

OpenAI.ImageDetail

Propiedad	Value
Type	string
Valores	`low` `high` `auto`

OpenAI.ImageGenTool

Herramienta de generación de imágenes

Herramienta que genera imágenes mediante los modelos de imágenes GPT.

Modelos válidos:

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
fondo	enum	Tipo de fondo para la imagen generada. Uno de `transparent`, `opaque` o `auto`. Valor predeterminado: `auto`. Valores posibles: `transparent`, `opaque`, `auto`	No	auto
input_fidelity	OpenAI.InputFidelity o null		No
máscara_de_imagen_de_entrada	OpenAI.ImageGenToolInputImageMask		No
└─ file_id	string		No
└─ image_url	string		No
model	string (consulte los modelos válidos a continuación)		No
moderación	enum	Nivel de moderación de la imagen generada. Valor predeterminado: `auto`. Valores posibles: `auto`, `low`	No	auto
compresión_de_salida	integer	Nivel de compresión de la imagen de salida. Valor predeterminado: 100. Restricciones: min: 0, max: 100	No	100
formato_de_salida	enum	Formato de salida de la imagen generada. Uno de `png`, `webp`, o `jpeg`. Valor predeterminado: `png`. Valores posibles: `png`, `webp`, `jpeg`	No	png
imágenes_parciales	integer	Número de imágenes parciales que se van a generar en modo de streaming, de 0 (valor predeterminado) a 3. Restricciones: min: 0, max: 3	No
calidad	enum	Calidad de la imagen generada. Uno de los elementos `low`, `medium`, , `high` o `auto`. Valor predeterminado: `auto`. Valores posibles: `low`, `medium`, `high`, `auto`	No	auto
size	enum	Tamaño de la imagen generada. Uno de `1024x1024`, , `1024x1536` `1536x1024` o `auto`. Valor predeterminado: `auto`. Valores posibles: `1024x1024`, `1024x1536`, `1536x1024`, `auto`	No	auto
type	enum	Tipo de la herramienta de generación de imágenes. Siempre `image_generation`. Valores posibles: `image_generation`	Sí	image_generation

OpenAI.ImageGenToolInputImageMask

Nombre	Tipo	Description	Obligatorio	Predeterminado
ID del archivo	string		No
image_url	string		No

OpenAI.IncludeEnum

Especifique datos de salida adicionales que se incluirán en la respuesta del modelo. Los valores admitidos actualmente son:

web_search_call.action.sources: incluya los orígenes de la llamada a la herramienta de búsqueda web.
code_interpreter_call.outputs: incluye las salidas de la ejecución de código de Python en los elementos de llamada de la herramienta de intérprete de código.
computer_call_output.output.image_url: incluya direcciones URL de imagen desde la salida de la llamada del equipo.
file_search_call.results: incluya los resultados de búsqueda de la llamada a la herramienta de búsqueda de archivos.
message.input_image.image_url: incluya direcciones URL de imagen del mensaje de entrada.
message.output_text.logprobs: incluya logprobs con mensajes de asistente.
reasoning.encrypted_content: Incluye una versión cifrada de tokens de razonamiento en las salidas del elemento de razonamiento. Esto permite que los elementos de razonamiento se utilicen en conversaciones multiturno cuando se utiliza la API de Respuestas de manera sin estado (como cuando el store parámetro está configurado en false, o cuando una organización está inscrita en el programa de cero retención de datos).

Propiedad	Value
Descripción	Especifique datos de salida adicionales que se incluirán en la respuesta del modelo. Los valores admitidos actualmente son: - `web_search_call.action.sources`: Incluye las fuentes de la herramienta de búsqueda web. - `code_interpreter_call.outputs`: incluye las salidas de la ejecución de código de Python en los elementos de llamada de la herramienta de intérprete de código. - `computer_call_output.output.image_url`: incluya direcciones URL de imagen desde la salida de la llamada del equipo. - `file_search_call.results`: incluya los resultados de búsqueda de la llamada a la herramienta de búsqueda de archivos. - `message.input_image.image_url`: incluya las URL de las imágenes del mensaje de entrada. - `message.output_text.logprobs`: incluya logprobs con mensajes de asistente. - `reasoning.encrypted_content`: incluye una versión cifrada de tokens de razonamiento en las salidas del elemento de razonamiento. Esto permite que los elementos de razonamiento se utilicen en conversaciones multiturno cuando se utiliza la API de Respuestas de manera sin estado (como cuando el `store` parámetro está configurado en `false`, o cuando una organización está inscrita en el programa de cero retención de datos).
Type	string
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.InputContent

Discriminador para OpenAI.InputContent

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de valor	Schema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputContentInputImageContent
`input_file`	OpenAI.InputContentInputFileContent

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.InputContentType		Sí

OpenAI.InputContentInputFileContent

Archivo de entrada

Entrada de archivo para el modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
file_data	string	Contenido del archivo que se va a enviar al modelo.	No
ID del archivo	string o null		No
file_url	string (URI)	Dirección URL del archivo que se va a enviar al modelo.	No
filename	string	Nombre del archivo que se va a enviar al modelo.	No
type	enum	Tipo del elemento de entrada. Siempre `input_file`. Valores posibles: `input_file`	Sí	input_file

OpenAI.InputContentInputImageContent

Imagen de entrada

Entrada de imagen en el modelo. Obtenga información sobre las entradas de imagen.

Nombre	Tipo	Description	Obligatorio	Predeterminado
detail	OpenAI.ImageDetail		Sí
ID del archivo	string o null		No
image_url	string o null		No
type	enum	Tipo del elemento de entrada. Siempre `input_image`. Valores posibles: `input_image`	Sí	input_image

OpenAI.InputContentInputTextContent

Texto de entrada

Entrada de texto al modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
text	string	Entrada de texto en el modelo.	Sí
type	enum	Tipo del elemento de entrada. Siempre `input_text`. Valores posibles: `input_text`	Sí	input_text

OpenAI.InputContentType

Propiedad	Value
Type	string
Valores	`input_text` `input_image` `input_file`

OpenAI.InputFidelity

Controlar cuánto esfuerzo ejercerá el modelo para que coincida con el estilo y las características, especialmente las características faciales, de las imágenes de entrada. Este parámetro solo se admite para gpt-image-1. No se admite para gpt-image-1-mini. Admite high y low. Tiene como valor predeterminado low.

Propiedad	Value
Type	string
Valores	`high` `low`

OpenAI.InputFileContent

Archivo de entrada

Entrada de archivo para el modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
file_data	string	Contenido del archivo que se va a enviar al modelo.	No
ID del archivo	string o null		No
file_url	string (URI)	Dirección URL del archivo que se va a enviar al modelo.	No
filename	string	Nombre del archivo que se va a enviar al modelo.	No
type	enum	Tipo del elemento de entrada. Siempre `input_file`. Valores posibles: `input_file`	Sí	input_file

OpenAI.InputImageContent

Imagen de entrada

Entrada de imagen en el modelo. Obtenga información sobre las entradas de imagen.

Nombre	Tipo	Description	Obligatorio	Predeterminado
detail	OpenAI.ImageDetail		Sí
ID del archivo	string o null		No
image_url	string o null		No
type	enum	Tipo del elemento de entrada. Siempre `input_image`. Valores posibles: `input_image`	Sí	input_image

OpenAI.InputItem

Discriminador para OpenAI.InputItem

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de valor	Schema
`message`	OpenAI.EasyInputMessage
`item_reference`	OpenAI.ItemReferenceParam

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.InputItemType		Sí

OpenAI.InputItemType

Propiedad	Value
Type	string
Valores	`message` `item_reference`

OpenAI.InputMessageContentList

Lista de contenido de los elementos de entrada

Una lista de uno o varios elementos de entrada para el modelo, que contienen diferentes tipos de contenido.

Matriz de: OpenAI.InputContent

OpenAI.InputMessageResource

Nombre	Tipo	Description	Obligatorio
contenido	OpenAI.InputMessageContentList	Una lista de uno o varios elementos de entrada para el modelo, que contiene contenido diferente types.	Sí
id	string	Identificador único de la entrada del mensaje.	Sí
role	enum	Rol de la entrada del mensaje. Uno de`user`, `system` o `developer`. Valores posibles: `user`, `system`, `developer`	Sí
status	enum	Estado del elemento. Uno de `in_progress`, `completed`, o `incomplete`. Se rellena cuando los elementos se devuelven a través de la API. Valores posibles: `in_progress`, `completed`, `incomplete`	No
type	enum	Tipo de la entrada del mensaje. Siempre se establece en `message`. Valores posibles: `message`	Sí

OpenAI.InputParam

Entradas de texto, imagen o archivo al modelo, usadas para generar una respuesta. Aprende más:

Tipo: cadena o matriz de OpenAI.InputItem

Entradas de texto, imagen o archivo al modelo, usadas para generar una respuesta. Aprende más:

OpenAI.InputTextContent

Texto de entrada

Entrada de texto al modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
text	string	Entrada de texto en el modelo.	Sí
type	enum	Tipo del elemento de entrada. Siempre `input_text`. Valores posibles: `input_text`	Sí	input_text

OpenAI.ItemReferenceParam

Referencia de elemento

Identificador interno de un elemento al que se va a hacer referencia.

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	string	Identificador del elemento al que se va a hacer referencia.	Sí
type	enum	Tipo de elemento al que se va a hacer referencia. Siempre `item_reference`. Valores posibles: `item_reference`	Sí	item_reference

OpenAI.ItemResource

Elemento de contenido usado para generar una respuesta.

Discriminador para OpenAI.ItemResource

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de valor	Schema
`message`	OpenAI.InputMessageResource
`output_message`	OpenAI.ItemResourceOutputMessage
`file_search_call`	OpenAI.ItemResourceFileSearchToolCall
`computer_call`	OpenAI.ItemResourceComputerToolCall
`computer_call_output`	OpenAI.ItemResourceComputerToolCallOutputResource
`web_search_call`	OpenAI.ItemResourceWebSearchToolCall
`function_call`	OpenAI.ItemResourceFunctionToolCallResource
`function_call_output`	OpenAI.ItemResourceFunctionToolCallOutputResource
`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

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ItemResourceType		Sí

OpenAI.ItemResourceApplyPatchToolCall

Aplicar llamada a la herramienta de parche

Una llamada a herramienta que aplica diferencias de archivos mediante la creación, eliminación o actualización de archivos.

Nombre	Tipo	Description	Obligatorio	Predeterminado
call_id	string	Identificador único de la llamada a la herramienta de aplicación de revisión generada por el modelo.	Sí
created_by	string	Identificador de la entidad que creó esta llamada de herramienta.	No
id	string	Identificador único de la llamada a la herramienta aplicar revisión. Rellenado cuando este elemento se devuelve a través de la API.	Sí
operation	OpenAI.ApplyPatchFileOperation	Una de las operaciones de create_file, delete_file o update_file aplicadas a través de apply_patch.	Sí
└─ Tipo	OpenAI.ApplyPatchFileOperationType		Sí
status	OpenAI.ApplyPatchCallStatus		Sí
type	enum	Tipo del elemento. Siempre `apply_patch_call`. Valores posibles: `apply_patch_call`	Sí	apply_patch_call

OpenAI.ItemResourceApplyPatchToolCallOutput

Aplicar la salida de la llamada a la herramienta de parche

Salida emitida por una llamada a la herramienta apply patch.

Nombre	Tipo	Description	Obligatorio	Predeterminado
call_id	string	Identificador único de la llamada a la herramienta de aplicación de revisión generada por el modelo.	Sí
created_by	string	Identificador de la entidad que creó esta salida de llamada de herramienta.	No
id	string	Identificador único de la salida de llamada de la herramienta de aplicación de revisión. Rellenado cuando este elemento se devuelve a través de la API.	Sí
output	string o null		No
status	OpenAI.ApplyPatchCallOutputStatus		Sí
type	enum	Tipo del elemento. Siempre `apply_patch_call_output`. Valores posibles: `apply_patch_call_output`	Sí	apply_patch_call_output

OpenAI.ItemResourceCodeInterpreterToolCall

Llamada a la herramienta de intérprete de código

Una llamada de herramienta para ejecutar código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	string o null		Sí
container_id	string	Identificador del contenedor usado para ejecutar el código.	Sí
id	string	Identificador único de la llamada a la herramienta de intérprete de código.	Sí
salidas	matriz de OpenAI.CodeInterpreterOutputLogs o OpenAI.CodeInterpreterOutputImage o null		Sí
status	enum	Estado de la llamada a la herramienta de intérprete de código. Los valores válidos son `in_progress`, `completed`, `incomplete`, `interpreting`y `failed`. Valores posibles: `in_progress`, `completed`, `incomplete`, , `interpreting`, `failed`	Sí
type	enum	Tipo de la llamada a la herramienta de intérprete de código. Siempre `code_interpreter_call`. Valores posibles: `code_interpreter_call`	Sí	code_interpreter_call

OpenAI.ItemResourceComputerToolCall

Llamada de herramienta informática

Una llamada de herramienta a una herramienta de uso de equipo. Consulte la guía de uso del equipo para obtener más información.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acción	OpenAI.ComputerAction		Sí
call_id	string	Identificador que se usa al responder a la llamada de herramienta con salida.	Sí
id	string	Identificador único de la llamada al equipo.	Sí
pending_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam	Las comprobaciones de seguridad pendientes para la llamada al equipo.	Sí
status	enum	Estado del elemento. Uno de `in_progress`, `completed`, o `incomplete`. Se rellena cuando los elementos se devuelven a través de la API. Valores posibles: `in_progress`, `completed`, `incomplete`	Sí
type	enum	Tipo de llamada de computadora. Siempre `computer_call`. Valores posibles: `computer_call`	Sí	computer_call

OpenAI.ItemResourceComputerToolCallOutputResource

Nombre	Tipo	Description	Obligatorio	Predeterminado
acknowledged_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam	Las comprobaciones de seguridad notificadas por la API que han sido confirmadas por desarrollador.	No
call_id	string	Identificador de la llamada a la herramienta de equipo que generó la salida.	Sí
id	string	Identificador de la salida de la llamada de la herramienta de equipo.	No
output	OpenAI.ComputerScreenshotImage	Imagen de captura de pantalla del equipo que se usa con la herramienta de uso del equipo.	Sí
status	enum	Estado de la entrada del mensaje. Uno de `in_progress`, `completed`, o `incomplete`. Rellenado cuando los elementos de entrada se devuelven a través de la API. Valores posibles: `in_progress`, `completed`, `incomplete`	No
type	enum	Tipo de la salida de llamada de la herramienta de equipo. Siempre `computer_call_output`. Valores posibles: `computer_call_output`	Sí	computer_call_output

OpenAI.ItemResourceFileSearchToolCall

Llamada a la herramienta de búsqueda de archivos

Resultados de una llamada a la herramienta de búsqueda de archivos. Consulte la guía de búsqueda de archivos para obtener más información.

Nombre	Tipo	Description	Obligatorio
id	string	Identificador único de la llamada a la herramienta de búsqueda de archivos.	Sí
consultas	matriz de cadenas	Las consultas usadas para buscar archivos.	Sí
results	matriz de OpenAI.FileSearchToolCallResults o null		No
status	enum	Estado de la llamada a la herramienta de búsqueda de archivos. Uno de `in_progress`, `searching`, `incomplete` o `failed` Valores posibles: `in_progress`, `searching`, `completed`, , `incomplete`, `failed`	Sí
type	enum	Tipo de la llamada a la herramienta de búsqueda de archivos. Siempre `file_search_call`. Valores posibles: `file_search_call`	Sí

OpenAI.ItemResourceFunctionShellCall

Llamada de herramienta de shell

Una llamada a herramienta que ejecuta uno o varios comandos de shell en un entorno administrado.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acción	OpenAI.FunctionShellAction	Ejecute un comando de shell.	Sí
Comandos └	matriz de cadenas		Sí
└" max_output_length	entero o null		Sí
└" timeout_ms	entero o null		Sí
call_id	string	Identificador único de la llamada a la herramienta de shell generada por el modelo.	Sí
created_by	string	Identificador de la entidad que creó esta llamada de herramienta.	No
id	string	Identificador único de la llamada a la herramienta de shell. Rellenado cuando este elemento se devuelve a través de la API.	Sí
status	OpenAI.LocalShellCallStatus		Sí
type	enum	Tipo del elemento. Siempre `shell_call`. Valores posibles: `shell_call`	Sí	shell_call

OpenAI.ItemResourceFunctionShellCallOutput

Salida de llamada de shell

Salida de una llamada a la herramienta de shell que se emitió.

Nombre	Tipo	Description	Obligatorio	Predeterminado
call_id	string	Identificador único de la llamada a la herramienta de shell generada por el modelo.	Sí
created_by	string	Identificador del actor que creó el elemento.	No
id	string	Identificador único de la salida de la llamada de shell. Rellenado cuando este elemento se devuelve a través de la API.	Sí
max_output_length	entero o null		Sí
output	matriz de OpenAI.FunctionShellCallOutputContent	Matriz de contenido de salida de la llamada de shell	Sí
type	enum	Tipo de la salida de la llamada de shell. Siempre `shell_call_output`. Valores posibles: `shell_call_output`	Sí	shell_call_output

OpenAI.ItemResourceFunctionToolCallOutputResource

Nombre	Tipo	Description	Obligatorio
call_id	string	Identificador único de la llamada a la herramienta de función generada por el modelo.	Sí
id	string	Identificador único de la salida de la llamada de la herramienta de función. Rellenado cuando este elemento se devuelve a través de la API.	No
output	cadena o matriz de OpenAI.FunctionAndCustomToolCallOutput	Salida de la llamada de función generada por el código. Puede ser una cadena o una lista de contenido de salida.	Sí
status	enum	Estado del elemento. Uno de `in_progress`, `completed`, o `incomplete`. Se rellena cuando los elementos se devuelven a través de la API. Valores posibles: `in_progress`, `completed`, `incomplete`	No
type	enum	Tipo de la salida de la llamada de la herramienta de función. Siempre `function_call_output`. Valores posibles: `function_call_output`	Sí

OpenAI.ItemResourceFunctionToolCallResource

Nombre	Tipo	Description	Obligatorio
argumentos	string	Cadena JSON de los argumentos que se van a pasar a la función.	Sí
call_id	string	Identificador único de la llamada a la herramienta de función generada por el modelo.	Sí
id	string	Identificador único de la llamada a la herramienta de función.	No
nombre	string	Nombre de la función que se va a ejecutar.	Sí
status	enum	Estado del elemento. Uno de `in_progress`, `completed`, o `incomplete`. Se rellena cuando los elementos se devuelven a través de la API. Valores posibles: `in_progress`, `completed`, `incomplete`	No
type	enum	Tipo de la llamada a la herramienta de función. Siempre `function_call`. Valores posibles: `function_call`	Sí

OpenAI.ItemResourceImageGenToolCall

Llamada de generación de imágenes

Solicitud de generación de imágenes realizada por el modelo.

Nombre	Tipo	Description	Obligatorio
id	string	Identificador único de la llamada de generación de imágenes.	Sí
result	string o null		Sí
status	enum	Estado de la llamada de generación de imágenes. Valores posibles: `in_progress`, `completed`, `generating`, `failed`	Sí
type	enum	Tipo de la llamada de generación de imágenes. Siempre `image_generation_call`. Valores posibles: `image_generation_call`	Sí

OpenAI.ItemResourceLocalShellToolCall

Llamada local de shell

Una llamada de herramienta para ejecutar un comando en el shell local.

Nombre	Tipo	Description	Obligatorio
acción	OpenAI.LocalShellExecAction	Ejecute un comando de shell en el servidor.	Sí
call_id	string	Identificador único de la llamada a la herramienta de shell local generada por el modelo.	Sí
id	string	Identificador único de la llamada de shell local.	Sí
status	enum	Estado de la llamada de shell local. Valores posibles: `in_progress`, `completed`, `incomplete`	Sí
type	enum	Tipo de la llamada de shell local. Siempre `local_shell_call`. Valores posibles: `local_shell_call`	Sí

OpenAI.ItemResourceLocalShellToolCallOutput

Salida local de llamada de shell

Salida de una llamada a la herramienta de shell local.

Nombre	Tipo	Description	Obligatorio
id	string	Identificador único de la llamada a la herramienta de shell local generada por el modelo.	Sí
output	string	Cadena JSON de la salida de la llamada a la herramienta de shell local.	Sí
status	string o null		No
type	enum	Tipo de la salida de llamada de la herramienta de shell local. Siempre `local_shell_call_output`. Valores posibles: `local_shell_call_output`	Sí

OpenAI.ItemResourceMcpApprovalRequest

Solicitud de aprobación del MCP

Solicitud de aprobación humana de una invocación de herramienta.

Nombre	Tipo	Description	Obligatorio
argumentos	string	Cadena JSON de argumentos para la herramienta.	Sí
id	string	Identificador único de la solicitud de aprobación.	Sí
nombre	string	Nombre de la herramienta que se va a ejecutar.	Sí
etiqueta del servidor	string	Etiqueta del servidor MCP que realiza la solicitud.	Sí
type	enum	Tipo del elemento. Siempre `mcp_approval_request`. Valores posibles: `mcp_approval_request`	Sí

OpenAI.ItemResourceMcpApprovalResponseResource

Respuesta de aprobación del MCP

Respuesta a una solicitud de aprobación de MCP.

Nombre	Tipo	Description	Obligatorio
approval_request_id	string	Identificador de la solicitud de aprobación que está siendo respondida.	Sí
aprobar	boolean	Si se aprobó la solicitud.	Sí
id	string	Identificador único de la respuesta de aprobación	Sí
razón	string o null		No
type	enum	Tipo del elemento. Siempre `mcp_approval_response`. Valores posibles: `mcp_approval_response`	Sí

OpenAI.ItemResourceMcpListTools

Herramientas de listas MCP

Lista de herramientas disponibles en un servidor MCP.

Nombre	Tipo	Description	Obligatorio
error	string o null		No
id	string	Identificador único de la lista.	Sí
etiqueta del servidor	string	Etiqueta del servidor MCP.	Sí
tools	matriz de OpenAI.MCPListToolsToolsTool	Las herramientas disponibles en el servidor.	Sí
type	enum	Tipo del elemento. Siempre `mcp_list_tools`. Valores posibles: `mcp_list_tools`	Sí

OpenAI.ItemResourceMcpToolCall

Llamada a la herramienta MCP

Una invocación de una herramienta en un servidor MCP.

Nombre	Tipo	Description	Obligatorio
approval_request_id	string o null		No
argumentos	string	Cadena JSON de los argumentos pasados a la herramienta.	Sí
error	string o null		No
id	string	Identificador único de la llamada a la herramienta.	Sí
nombre	string	Nombre de la herramienta que se ejecutó.	Sí
output	string o null		No
etiqueta del servidor	string	Etiqueta del servidor MCP que ejecuta la herramienta.	Sí
status	OpenAI.MCPToolCallStatus		No
type	enum	Tipo del elemento. Siempre `mcp_call`. Valores posibles: `mcp_call`	Sí

OpenAI.ItemResourceOutputMessage

Mensaje de salida

Mensaje de salida del modelo.

Nombre	Tipo	Description	Obligatorio
contenido	matriz de OpenAI.OutputMessageContent	Contenido del mensaje de salida.	Sí
id	string	Identificador único del mensaje de salida.	Sí
role	enum	Rol del mensaje de salida. Siempre `assistant`. Valores posibles: `assistant`	Sí
status	enum	Estado de la entrada del mensaje. Uno de `in_progress`, `completed`, o `incomplete`. Rellenado cuando los elementos de entrada se devuelven a través de la API. Valores posibles: `in_progress`, `completed`, `incomplete`	Sí
type	enum	Tipo del mensaje de salida. Siempre `message`. Valores posibles: `output_message`	Sí

OpenAI.ItemResourceType

Propiedad	Value
Type	string
Valores	`message` `output_message` `file_search_call` `computer_call` `computer_call_output` `web_search_call` `function_call` `function_call_output` `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`

OpenAI.ItemResourceWebSearchToolCall

Llamada a la herramienta de búsqueda web

Resultados de una llamada a la herramienta de búsqueda web. Consulte la guía de búsqueda web para obtener más información.

Nombre	Tipo	Description	Obligatorio
acción	OpenAI.WebSearchActionSearch o OpenAI.WebSearchActionOpenPage o OpenAI.WebSearchActionFind	Objeto que describe la acción específica realizada en esta llamada de búsqueda web. Incluye detalles sobre cómo el modelo usó la web (búsqueda, open_page, búsqueda).	Sí
id	string	Identificador único de la llamada a la herramienta de búsqueda web.	Sí
status	enum	El estado de la llamada a la herramienta de búsqueda web. Valores posibles: `in_progress`, `searching`, `completed`, `failed`	Sí
type	enum	Tipo de llamada a la herramienta de búsqueda web. Siempre `web_search_call`. Valores posibles: `web_search_call`	Sí

OpenAI.KeyPressAction

KeyPress

Una colección de teclas presiona el modelo que desea realizar.

Nombre	Tipo	Description	Obligatorio	Predeterminado
keys	matriz de cadenas	La combinación de teclas que solicita que se presione el modelo. Se trata de una matriz de cadenas, cada una que representa una clave.	Sí
type	enum	Especifica el tipo de evento. Para una acción de keypress, esta propiedad siempre se establece en `keypress`. Valores posibles: `keypress`	Sí	Pulsación de teclas

OpenAI.LocalShellCallStatus

Propiedad	Value
Type	string
Valores	`in_progress` `completed` `incomplete`

OpenAI.LocalShellExecAction

Acción local del ejecutivo de shell

Ejecute un comando de shell en el servidor.

Nombre	Tipo	Description	Obligatorio	Predeterminado
comando	matriz de cadenas	Comando que se va a ejecutar.	Sí
Entorno	object	Variables de entorno que se van a establecer para el comando.	Sí
tiempo_de_espera_ms	entero o null		No
type	enum	Tipo de la acción de shell local. Siempre `exec`. Valores posibles: `exec`	Sí	exec
user	string o null		No
working_directory	string o null		No

OpenAI.LocalShellToolParam

Herramienta de concha local

Herramienta que permite al modelo ejecutar comandos de shell en un entorno local.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de la herramienta de shell local. Siempre `local_shell`. Valores posibles: `local_shell`	Sí	local_shell

OpenAI.LogProb

Probabilidad logarítmica

Probabilidad de registro de un token.

Nombre	Tipo	Obligatorio
bytes	matriz de enteros	Sí
logprob	número	Sí
token	string	Sí
top_logprobs	matriz de OpenAI.TopLogProb	Sí

OpenAI.MCPListToolsTool

Herramienta de listas MCP

Una herramienta disponible en un servidor MCP.

Nombre	Tipo	Description	Obligatorio
annotations	OpenAI.MCPListToolsToolAnnotations o null		No
description	string o null		No
input_schema	OpenAI.MCPListToolsToolInputSchema		Sí
nombre	string	Nombre de la herramienta.	Sí

OpenAI.MCPListToolsToolAnnotations

Tipo: objeto

OpenAI.MCPListToolsToolInputSchema

Tipo: objeto

OpenAI.MCPTool

Herramienta MCP

Asigne al modelo acceso a herramientas adicionales a través de servidores remotos del Protocolo de Contexto de Modelo (MCP). Más información sobre MCP.

Nombre	Tipo	Description	Obligatorio
herramientas_permitidas	matriz de cadena o OpenAI.MCPToolFilter o null		No
authorization	string	Un token de acceso de OAuth que se puede usar con un servidor MCP remoto, ya sea con una dirección URL de servidor MCP personalizada o un conector de servicio. La aplicación debe controlar el flujo de autorización de OAuth y proporcionar el token aquí.	No
connector_id	enum	Identificador de conectores de servicio, como los disponibles en ChatGPT. Uno de `server_url` o `connector_id` debe proporcionarse. Más información sobre el servicio conectores aquí. Los valores admitidos `connector_id` actualmente son: - Dropbox: `connector_dropbox` - Gmail: `connector_gmail` - Google Calendar: `connector_googlecalendar` - Google Drive: `connector_googledrive` - Microsoft Teams:`connector_microsoftteams` - Calendario de Outlook: `connector_outlookcalendar` - Correo electrónico de Outlook: `connector_outlookemail` - SharePoint:`connector_sharepoint` Valores posibles: `connector_dropbox`, `connector_gmail`, `connector_googlecalendar`, `connector_googledrive`, `connector_microsoftteams`, `connector_outlookcalendar`, , , `connector_outlookemailconnector_sharepoint`	No
headers	object o null		No
requerir_aprobación	OpenAI.MCPToolRequireApproval o string o null		No
server_description	string	Descripción opcional del servidor MCP, que se usa para proporcionar más contexto.	No
etiqueta del servidor	string	Etiqueta para este servidor MCP, que se usa para identificarlo en las llamadas a herramientas.	Sí
server_url	string (URI)	Dirección URL del servidor MCP. Uno de `server_url` o `connector_id` debe ser proporcionado.	No
type	enum	Tipo de la herramienta MCP. Siempre `mcp`. Valores posibles: `mcp`	Sí

OpenAI.MCPToolCallStatus

Propiedad	Value
Type	string
Valores	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

Filtro de herramientas MCP

Objeto de filtro para especificar qué herramientas se permiten.

Nombre	Tipo	Description	Obligatorio	Predeterminado
read_only	boolean	Indica si una herramienta modifica o no los datos o es de solo lectura. Si es El servidor MCP se anota con `readOnlyHint`, coincidirá con este filtro.	No
tool_names	matriz de cadenas	Lista de nombres de herramientas permitidos.	No

OpenAI.MCPToolRequireApproval

Nombre	Tipo	Description	Obligatorio	Predeterminado
Siempre	OpenAI.MCPToolFilter	Objeto de filtro para especificar qué herramientas se permiten.	No
nunca	OpenAI.MCPToolFilter	Objeto de filtro para especificar qué herramientas se permiten.	No

OpenAI.Metadata

Conjunto de 16 pares clave-valor que se pueden adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado y consultar objetos a través de la API o el panel. Las claves son cadenas con una longitud máxima de 64 caracteres. Los valores son cadenas con una longitud máxima de 512 caracteres.

Tipo: objeto

OpenAI.Move

Move

Una acción de movimiento del mouse.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Especifica el tipo de evento. Para una acción de movimiento, esta propiedad es establezca siempre en `move`. Valores posibles: `move`	Sí	trasladar
x	integer	Coordenada x a la que se va a mover.	Sí
y	integer	Coordenada y a la que se va a mover.	Sí

OpenAI.OutputContent

Discriminador para OpenAI.OutputContent

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de valor	Schema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.OutputContentType		Sí

OpenAI.OutputContentOutputTextContent

Texto de salida

Salida de texto del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
annotations	matriz de OpenAI.Annotation	Anotaciones de la salida de texto.	Sí
logprobs	matriz de OpenAI.LogProb		No
text	string	Salida de texto del modelo.	Sí
type	enum	Tipo del texto de salida. Siempre `output_text`. Valores posibles: `output_text`	Sí	output_text

OpenAI.OutputContentRefusalContent

Refusal

Una negativa del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
refusal	string	Explicación de la negativa del modelo.	Sí
type	enum	Tipo de denegación. Siempre `refusal`. Valores posibles: `refusal`	Sí	refusal

OpenAI.OutputContentType

Propiedad	Value
Type	string
Valores	`output_text` `refusal` `reasoning_text`

OpenAI.OutputItem

Discriminador para OpenAI.OutputItem

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de valor	Schema
`output_message`	OpenAI.OutputItemOutputMessage
`file_search_call`	OpenAI.OutputItemFileSearchToolCall
`function_call`	OpenAI.OutputItemFunctionToolCall
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`reasoning`	OpenAI.OutputItemReasoningItem
`compaction`	OpenAI.OutputItemCompactionBody
`image_generation_call`	OpenAI.OutputItemImageGenToolCall
`code_interpreter_call`	OpenAI.OutputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.OutputItemLocalShellToolCall
`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
`custom_tool_call`	OpenAI.OutputItemCustomToolCall

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.OutputItemType		Sí

OpenAI.OutputItemApplyPatchToolCall

Aplicar llamada a la herramienta de parche

Una llamada a herramienta que aplica diferencias de archivos mediante la creación, eliminación o actualización de archivos.

Nombre	Tipo	Description	Obligatorio	Predeterminado
call_id	string	Identificador único de la llamada a la herramienta de aplicación de revisión generada por el modelo.	Sí
created_by	string	Identificador de la entidad que creó esta llamada de herramienta.	No
id	string	Identificador único de la llamada a la herramienta aplicar revisión. Rellenado cuando este elemento se devuelve a través de la API.	Sí
operation	OpenAI.ApplyPatchFileOperation	Una de las operaciones de create_file, delete_file o update_file aplicadas a través de apply_patch.	Sí
└─ Tipo	OpenAI.ApplyPatchFileOperationType		Sí
status	OpenAI.ApplyPatchCallStatus		Sí
type	enum	Tipo del elemento. Siempre `apply_patch_call`. Valores posibles: `apply_patch_call`	Sí	apply_patch_call

OpenAI.OutputItemApplyPatchToolCallOutput

Aplicar la salida de la llamada a la herramienta de parche

Salida emitida por una llamada a la herramienta apply patch.

Nombre	Tipo	Description	Obligatorio	Predeterminado
call_id	string	Identificador único de la llamada a la herramienta de aplicación de revisión generada por el modelo.	Sí
created_by	string	Identificador de la entidad que creó esta salida de llamada de herramienta.	No
id	string	Identificador único de la salida de llamada de la herramienta de aplicación de revisión. Rellenado cuando este elemento se devuelve a través de la API.	Sí
output	string o null		No
status	OpenAI.ApplyPatchCallOutputStatus		Sí
type	enum	Tipo del elemento. Siempre `apply_patch_call_output`. Valores posibles: `apply_patch_call_output`	Sí	apply_patch_call_output

OpenAI.OutputItemCodeInterpreterToolCall

Llamada a la herramienta de intérprete de código

Una llamada de herramienta para ejecutar código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	string o null		Sí
container_id	string	Identificador del contenedor usado para ejecutar el código.	Sí
id	string	Identificador único de la llamada a la herramienta de intérprete de código.	Sí
salidas	matriz de OpenAI.CodeInterpreterOutputLogs o OpenAI.CodeInterpreterOutputImage o null		Sí
status	enum	Estado de la llamada a la herramienta de intérprete de código. Los valores válidos son `in_progress`, `completed`, `incomplete`, `interpreting`y `failed`. Valores posibles: `in_progress`, `completed`, `incomplete`, , `interpreting`, `failed`	Sí
type	enum	Tipo de la llamada a la herramienta de intérprete de código. Siempre `code_interpreter_call`. Valores posibles: `code_interpreter_call`	Sí	code_interpreter_call

OpenAI.OutputItemCompactionBody

Elemento de compactación

Un elemento de compactación generado por la v1/responses/compact API.

Nombre	Tipo	Description	Obligatorio	Predeterminado
created_by	string	Identificador del actor que creó el elemento.	No
encrypted_content	string	Contenido cifrado generado por compactación.	Sí
id	string	Identificador único del elemento de compactación.	Sí
type	enum	Tipo del elemento. Siempre `compaction`. Valores posibles: `compaction`	Sí	Compactación

OpenAI.OutputItemComputerToolCall

Llamada de herramienta informática

Una llamada de herramienta a una herramienta de uso de equipo. Consulte la guía de uso del equipo para obtener más información.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acción	OpenAI.ComputerAction		Sí
call_id	string	Identificador que se usa al responder a la llamada de herramienta con salida.	Sí
id	string	Identificador único de la llamada al equipo.	Sí
pending_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam	Las comprobaciones de seguridad pendientes para la llamada al equipo.	Sí
status	enum	Estado del elemento. Uno de `in_progress`, `completed`, o `incomplete`. Se rellena cuando los elementos se devuelven a través de la API. Valores posibles: `in_progress`, `completed`, `incomplete`	Sí
type	enum	Tipo de llamada de computadora. Siempre `computer_call`. Valores posibles: `computer_call`	Sí	computer_call

OpenAI.OutputItemCustomToolCall

Llamada a herramienta personalizada

Una llamada a una herramienta personalizada creada por el modelo.

Nombre	Tipo	Description	Obligatorio
call_id	string	Identificador usado para asignar esta llamada de herramienta personalizada a una salida de llamada de herramienta.	Sí
id	string	Identificador único de la llamada a la herramienta personalizada en la plataforma OpenAI.	No
input	string	Entrada de la llamada de herramienta personalizada generada por el modelo.	Sí
nombre	string	Nombre de la utilidad personalizada llamada.	Sí
type	enum	Tipo de la llamada a herramienta personalizada. Siempre `custom_tool_call`. Valores posibles: `custom_tool_call`	Sí

OpenAI.OutputItemFileSearchToolCall

Llamada a la herramienta de búsqueda de archivos

Resultados de una llamada a la herramienta de búsqueda de archivos. Consulte la guía de búsqueda de archivos para obtener más información.

Nombre	Tipo	Description	Obligatorio
id	string	Identificador único de la llamada a la herramienta de búsqueda de archivos.	Sí
consultas	matriz de cadenas	Las consultas usadas para buscar archivos.	Sí
results	matriz de OpenAI.FileSearchToolCallResults o null		No
status	enum	Estado de la llamada a la herramienta de búsqueda de archivos. Uno de `in_progress`, `searching`, `incomplete` o `failed` Valores posibles: `in_progress`, `searching`, `completed`, , `incomplete`, `failed`	Sí
type	enum	Tipo de la llamada a la herramienta de búsqueda de archivos. Siempre `file_search_call`. Valores posibles: `file_search_call`	Sí

OpenAI.OutputItemFunctionShellCall

Llamada de herramienta de shell

Una llamada a herramienta que ejecuta uno o varios comandos de shell en un entorno administrado.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acción	OpenAI.FunctionShellAction	Ejecute un comando de shell.	Sí
Comandos └	matriz de cadenas		Sí
└" max_output_length	entero o null		Sí
└" timeout_ms	entero o null		Sí
call_id	string	Identificador único de la llamada a la herramienta de shell generada por el modelo.	Sí
created_by	string	Identificador de la entidad que creó esta llamada de herramienta.	No
id	string	Identificador único de la llamada a la herramienta de shell. Rellenado cuando este elemento se devuelve a través de la API.	Sí
status	OpenAI.LocalShellCallStatus		Sí
type	enum	Tipo del elemento. Siempre `shell_call`. Valores posibles: `shell_call`	Sí	shell_call

OpenAI.OutputItemFunctionShellCallOutput

Salida de llamada de shell

Salida de una llamada a la herramienta de shell que se emitió.

Nombre	Tipo	Description	Obligatorio	Predeterminado
call_id	string	Identificador único de la llamada a la herramienta de shell generada por el modelo.	Sí
created_by	string	Identificador del actor que creó el elemento.	No
id	string	Identificador único de la salida de la llamada de shell. Rellenado cuando este elemento se devuelve a través de la API.	Sí
max_output_length	entero o null		Sí
output	matriz de OpenAI.FunctionShellCallOutputContent	Matriz de contenido de salida de la llamada de shell	Sí
type	enum	Tipo de la salida de la llamada de shell. Siempre `shell_call_output`. Valores posibles: `shell_call_output`	Sí	shell_call_output

OpenAI.OutputItemFunctionToolCall

Llamada a la herramienta de función

Una llamada de herramienta para ejecutar una función. Consulta la guía de llamadas de funciones para más información.

Nombre	Tipo	Description	Obligatorio
argumentos	string	Cadena JSON de los argumentos que se van a pasar a la función.	Sí
call_id	string	Identificador único de la llamada a la herramienta de función generada por el modelo.	Sí
id	string	Identificador único de la llamada a la herramienta de función.	No
nombre	string	Nombre de la función que se va a ejecutar.	Sí
status	enum	Estado del elemento. Uno de `in_progress`, `completed`, o `incomplete`. Se rellena cuando los elementos se devuelven a través de la API. Valores posibles: `in_progress`, `completed`, `incomplete`	No
type	enum	Tipo de la llamada a la herramienta de función. Siempre `function_call`. Valores posibles: `function_call`	Sí

OpenAI.OutputItemImageGenToolCall

Llamada de generación de imágenes

Solicitud de generación de imágenes realizada por el modelo.

Nombre	Tipo	Description	Obligatorio
id	string	Identificador único de la llamada de generación de imágenes.	Sí
result	string o null		Sí
status	enum	Estado de la llamada de generación de imágenes. Valores posibles: `in_progress`, `completed`, `generating`, `failed`	Sí
type	enum	Tipo de la llamada de generación de imágenes. Siempre `image_generation_call`. Valores posibles: `image_generation_call`	Sí

OpenAI.OutputItemLocalShellToolCall

Llamada local de shell

Una llamada de herramienta para ejecutar un comando en el shell local.

Nombre	Tipo	Description	Obligatorio
acción	OpenAI.LocalShellExecAction	Ejecute un comando de shell en el servidor.	Sí
call_id	string	Identificador único de la llamada a la herramienta de shell local generada por el modelo.	Sí
id	string	Identificador único de la llamada de shell local.	Sí
status	enum	Estado de la llamada de shell local. Valores posibles: `in_progress`, `completed`, `incomplete`	Sí
type	enum	Tipo de la llamada de shell local. Siempre `local_shell_call`. Valores posibles: `local_shell_call`	Sí

OpenAI.OutputItemMcpApprovalRequest

Solicitud de aprobación del MCP

Solicitud de aprobación humana de una invocación de herramienta.

Nombre	Tipo	Description	Obligatorio
argumentos	string	Cadena JSON de argumentos para la herramienta.	Sí
id	string	Identificador único de la solicitud de aprobación.	Sí
nombre	string	Nombre de la herramienta que se va a ejecutar.	Sí
etiqueta del servidor	string	Etiqueta del servidor MCP que realiza la solicitud.	Sí
type	enum	Tipo del elemento. Siempre `mcp_approval_request`. Valores posibles: `mcp_approval_request`	Sí

OpenAI.OutputItemMcpListTools

Herramientas de listas MCP

Lista de herramientas disponibles en un servidor MCP.

Nombre	Tipo	Description	Obligatorio
error	string o null		No
id	string	Identificador único de la lista.	Sí
etiqueta del servidor	string	Etiqueta del servidor MCP.	Sí
tools	matriz de OpenAI.MCPListToolsToolsTool	Las herramientas disponibles en el servidor.	Sí
type	enum	Tipo del elemento. Siempre `mcp_list_tools`. Valores posibles: `mcp_list_tools`	Sí

OpenAI.OutputItemMcpToolCall

Llamada a la herramienta MCP

Una invocación de una herramienta en un servidor MCP.

Nombre	Tipo	Description	Obligatorio
approval_request_id	string o null		No
argumentos	string	Cadena JSON de los argumentos pasados a la herramienta.	Sí
error	string o null		No
id	string	Identificador único de la llamada a la herramienta.	Sí
nombre	string	Nombre de la herramienta que se ejecutó.	Sí
output	string o null		No
etiqueta del servidor	string	Etiqueta del servidor MCP que ejecuta la herramienta.	Sí
status	OpenAI.MCPToolCallStatus		No
type	enum	Tipo del elemento. Siempre `mcp_call`. Valores posibles: `mcp_call`	Sí

OpenAI.OutputItemOutputMessage

Mensaje de salida

Mensaje de salida del modelo.

Nombre	Tipo	Description	Obligatorio
contenido	matriz de OpenAI.OutputMessageContent	Contenido del mensaje de salida.	Sí
id	string	Identificador único del mensaje de salida.	Sí
role	enum	Rol del mensaje de salida. Siempre `assistant`. Valores posibles: `assistant`	Sí
status	enum	Estado de la entrada del mensaje. Uno de `in_progress`, `completed`, o `incomplete`. Rellenado cuando los elementos de entrada se devuelven a través de la API. Valores posibles: `in_progress`, `completed`, `incomplete`	Sí
type	enum	Tipo del mensaje de salida. Siempre `message`. Valores posibles: `output_message`	Sí

OpenAI.OutputItemReasoningItem

Reasoning

Descripción de la cadena de pensamiento utilizada por un modelo de razonamiento al generar una respuesta. Asegúrese de incluir estos elementos en input la API de respuestas para los turnos posteriores de una conversación si administra manualmente el contexto.

Nombre	Tipo	Description	Obligatorio
contenido	matriz de OpenAI.ReasoningTextContent	Contenido de texto de razonamiento.	No
encrypted_content	string o null		No
id	string	Identificador único del contenido de razonamiento.	Sí
status	enum	Estado del elemento. Uno de `in_progress`, `completed`, o `incomplete`. Se rellena cuando los elementos se devuelven a través de la API. Valores posibles: `in_progress`, `completed`, `incomplete`	No
summary	matriz de OpenAI.Summary	Contenido de resumen de razonamiento.	Sí
type	enum	Tipo del objeto. Siempre `reasoning`. Valores posibles: `reasoning`	Sí

OpenAI.OutputItemType

Propiedad	Value
Type	string
Valores	`output_message` `file_search_call` `function_call` `web_search_call` `computer_call` `reasoning` `compaction` `image_generation_call` `code_interpreter_call` `local_shell_call` `shell_call` `shell_call_output` `apply_patch_call` `apply_patch_call_output` `mcp_call` `mcp_list_tools` `mcp_approval_request` `custom_tool_call`

OpenAI.OutputItemWebSearchToolCall

Llamada a la herramienta de búsqueda web

Resultados de una llamada a la herramienta de búsqueda web. Consulte la guía de búsqueda web para obtener más información.

Nombre	Tipo	Description	Obligatorio
acción	OpenAI.WebSearchActionSearch o OpenAI.WebSearchActionOpenPage o OpenAI.WebSearchActionFind	Objeto que describe la acción específica realizada en esta llamada de búsqueda web. Incluye detalles sobre cómo el modelo usó la web (búsqueda, open_page, búsqueda).	Sí
id	string	Identificador único de la llamada a la herramienta de búsqueda web.	Sí
status	enum	El estado de la llamada a la herramienta de búsqueda web. Valores posibles: `in_progress`, `searching`, `completed`, `failed`	Sí
type	enum	Tipo de llamada a la herramienta de búsqueda web. Siempre `web_search_call`. Valores posibles: `web_search_call`	Sí

OpenAI.OutputMessageContent

Discriminador para OpenAI.OutputMessageContent

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de valor	Schema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.OutputMessageContentType		Sí

OpenAI.OutputMessageContentOutputTextContent

Texto de salida

Salida de texto del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
annotations	matriz de OpenAI.Annotation	Anotaciones de la salida de texto.	Sí
logprobs	matriz de OpenAI.LogProb		No
text	string	Salida de texto del modelo.	Sí
type	enum	Tipo del texto de salida. Siempre `output_text`. Valores posibles: `output_text`	Sí	output_text

OpenAI.OutputMessageContentRefusalContent

Refusal

Una negativa del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
refusal	string	Explicación de la negativa del modelo.	Sí
type	enum	Tipo de denegación. Siempre `refusal`. Valores posibles: `refusal`	Sí	refusal

OpenAI.OutputMessageContentType

Propiedad	Value
Type	string
Valores	`output_text` `refusal`

OpenAI.Prompt

Referencia a una plantilla de solicitud y sus variables. Obtenga más información.

Nombre	Tipo	Description	Obligatorio
id	string	Identificador único de la plantilla de solicitud que se va a usar.	Sí
variables	OpenAI.ResponsePromptVariables o null		No
version	string o null		No

OpenAI.RankerVersionType

Propiedad	Value
Type	string
Valores	`auto` `default-2024-11-15`

OpenAI.RankingOptions

Nombre	Tipo	Description	Obligatorio
hybrid_search	OpenAI.HybridSearchOptions		No
└" embedding_weight	número	El peso de la incrustación en la fusión de clasificación recíproca.	Sí
└" text_weight	número	Peso del texto en la fusión de clasificación recíproca.	Sí
clasificador	OpenAI.RankerVersionType		No
umbral de puntuación	número	Umbral de puntuación para la búsqueda de archivos, un número comprendido entre 0 y 1. Los números más cercanos a 1 intentarán devolver solo los resultados más relevantes, pero pueden devolver menos resultados.	No

OpenAI.Reasoning

Reasoning

Modelos de serie gpt-5 y o solo Opciones de configuración para modelos de razonamiento.

Nombre	Tipo	Description	Obligatorio
effort	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de modelos de razonamiento. Actualmente, los valores admitidos son `none`, `minimal`, `low`, `medium`, `high`y `xhigh`. Reducir el esfuerzo de razonamiento puede dar lugar a respuestas más rápidas y menos tokens usados sobre el razonamiento en una respuesta. - `gpt-5.1` el valor predeterminado es `none`, que no realiza el razonamiento. Los valores de razonamiento admitidos para `gpt-5.1` son `none`, `low`, `medium`y `high`. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1. - Todos los modelos antes `gpt-5.1` del esfuerzo de razonamiento predeterminado `medium` y no admiten `none`. - El `gpt-5-pro` modelo tiene como valor predeterminado (y solo admite) `high` el esfuerzo de razonamiento. - `xhigh` se admite para todos los modelos después `gpt-5.1-codex-max`de .	No
generate_summary	string o null		No
summary	string o null		No

OpenAI.ReasoningEffort

Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Actualmente, los valores admitidos son none, minimal, low, medium, highy xhigh. Reducir el esfuerzo de razonamiento puede dar lugar a respuestas más rápidas y menos tokens usados en el razonamiento en una respuesta.

gpt-5.1 el valor predeterminado es none, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son none, low, mediumy high. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1.
Todos los modelos antes del gpt-5.1 esfuerzo de razonamiento predeterminado medium y no admiten none.
El gpt-5-pro modelo tiene como valor predeterminado (y solo admite) high el esfuerzo de razonamiento.
xhigh se admite para todos los modelos después gpt-5.1-codex-maxde .

Propiedad	Value
Descripción	Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Actualmente, los valores admitidos son `none`, `minimal`, `low`, `medium`, `high`y `xhigh`. Reducir el esfuerzo de razonamiento puede dar lugar a respuestas más rápidas y menos tokens usados en el razonamiento en una respuesta. - `gpt-5.1` el valor predeterminado es `none`, que no realiza el razonamiento. Los valores de razonamiento admitidos para `gpt-5.1` son `none`, `low`, `medium`y `high`. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1. - Todos los modelos antes `gpt-5.1` del esfuerzo de razonamiento predeterminado `medium` y no admiten `none`. - El `gpt-5-pro` modelo tiene como valor predeterminado (y solo admite) `high` el esfuerzo de razonamiento. - `xhigh` se admite para todos los modelos después `gpt-5.1-codex-max`de .
Type	string
Valores	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

RazonamientoTextoContenido

Texto de razonamiento del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
text	string	Texto de razonamiento del modelo.	Sí
type	enum	Tipo del texto de razonamiento. Siempre `reasoning_text`. Valores posibles: `reasoning_text`	Sí	reasoning_text

OpenAI.Response

El objeto respuesta

Nombre	Tipo	Description	Obligatorio	Predeterminado
fondo	booleano o null		No
completado_en	string o null		No
content_filters	matriz de AzureContentFilterForResponsesAPI	Los resultados del filtro de contenido de RAI.	Sí
conversación	OpenAI.ConversationReference o null		No
fecha_de_creación	entero (unixtime)	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
error	OpenAI.ResponseError o null		Sí
id	string	Identificador único de esta respuesta.	Sí
incomplete_details	OpenAI.ResponseIncompleteDetails o null		Sí
instructions	cadena o matriz de OpenAI.InputItem o null		Sí
max_output_tokens	entero o null		No
max_tool_calls	entero o null		No
metadatos	OpenAI.Metadata o null		No
model	string	Id. de modelo usado para generar la respuesta, como `gpt-4o` o `o3`. OpenAI ofrece una amplia gama de modelos con diferentes funcionalidades, rendimiento características y puntos de precio. Consulte la guía del modelo. para examinar y comparar los modelos disponibles.	No
object	enum	El tipo de objeto de este recurso: siempre se establece en `response`. Valores posibles: `response`	Sí
output	matriz de OpenAI.OutputItem	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la `output` matriz dependen en la respuesta del modelo. - En lugar de tener acceso al primer elemento de la `output` matriz y suponiendo que es un `assistant` mensaje con el contenido generado por el modelo, podría considerar la posibilidad de usar la propiedad `output_text` donde compatible con los SDK.	Sí
output_text	string o null		No
parallel_tool_calls	boolean	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	Sí	True
previous_response_id	string o null		No
prompt	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Obtenga más información.	No
prompt_cache_key	string	Usado por OpenAI para almacenar en caché las respuestas de solicitudes similares para optimizar las tasas de aciertos de caché. Reemplaza el `user` campo. Obtenga más información.	No
prompt_cache_retention	string o null		No
reasoning	OpenAI.Reasoning o null		No
safety_identifier	string	Identificador estable que se usa para ayudar a detectar usuarios de la aplicación que pueden estar infringiendo las directivas de uso de OpenAI. Los identificadores deben ser una cadena que identifique de forma única a cada usuario. Se recomienda aplicar un hash a su nombre de usuario o dirección de correo electrónico para evitar enviarnos información de identificación. Obtenga más información.	No
status	enum	Estado de la generación de respuesta. Uno de `completed`, , `failed` `in_progress`, `cancelled`, `queued`o `incomplete`. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
temperatura	number o null		No
text	OpenAI.ResponseTextParam	Opciones de configuración para una respuesta de texto del modelo. Puede ser simple texto o datos JSON estructurados. Aprende más: - Entradas y salidas de texto - Salidas estructuradas	No
tool_choice	OpenAI.ToolChoiceParam	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
tools	OpenAI.ToolsArray	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Se admiten las siguientes categorías de herramientas: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda web o búsqueda de archivos. Más información sobre herramientas integradas. - Herramientas de MCP: integraciones con sistemas de terceros a través de servidores MCP personalizados o conectores predefinidos, como Google Drive y SharePoint. Más información sobre Herramientas de MCP. - Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, permitir que el modelo llame a su propio código con argumentos fuertemente tipados y salidas. Más información sobre llamada a función. También puede usar herramientas personalizadas para llamar a su propio código.	No
top_logprobs	entero o null		No
top_p	number o null		No
truncation	string o null		No
uso	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
user	string (en desuso)	Este campo se va a reemplazar por `safety_identifier` y `prompt_cache_key`. Use `prompt_cache_key` en su lugar para mantener las optimizaciones de almacenamiento en caché. Identificador estable para los usuarios finales. Se usa para aumentar las tasas de aciertos de caché mediante una mejor creación de depósitos de solicitudes similares y para ayudar a OpenAI a detectar y evitar abusos. Obtenga más información.	No

OpenAI.ResponseAudioDeltaEvent

Se genera cuando hay una respuesta de audio parcial.

Nombre	Tipo	Description	Obligatorio
delta	string	Fragmento de bytes de audio de respuesta codificados en Base64. Restricciones: codificación: base64	Sí
sequence_number	integer	Número de secuencia para este fragmento de la respuesta del flujo.	Sí
type	enum	El tipo de evento. Siempre `response.audio.delta`. Valores posibles: `response.audio.delta`	Sí

OpenAI.ResponseAudioTranscriptDeltaEvent

Se genera cuando hay una transcripción parcial del audio.

Nombre	Tipo	Description	Obligatorio
delta	string	Transcripción parcial de la respuesta de audio.	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre `response.audio.transcript.delta`. Valores posibles: `response.audio.transcript.delta`	Sí

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Se genera cuando el intérprete de código transmite un fragmento de código parcial.

Nombre	Tipo	Description	Obligatorio
delta	string	Fragmento de código parcial que transmite el intérprete de código.	Sí
item_id	string	Identificador único del elemento de llamada de la herramienta de intérprete de código.	Sí
output_index	integer	Índice del elemento de salida en la respuesta para la que se transmite el código.	Sí
sequence_number	integer	Número de secuencia de este evento, usado para ordenar eventos de streaming.	Sí
type	enum	El tipo de evento. Siempre `response.code_interpreter_call_code.delta`. Valores posibles: `response.code_interpreter_call_code.delta`	Sí

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Se genera cuando una llamada al intérprete de código está en curso.

Nombre	Tipo	Description	Obligatorio
item_id	string	Identificador único del elemento de llamada de la herramienta de intérprete de código.	Sí
output_index	integer	Índice del elemento de salida en la respuesta para la que está en curso la llamada del intérprete de código.	Sí
sequence_number	integer	Número de secuencia de este evento, usado para ordenar eventos de streaming.	Sí
type	enum	El tipo de evento. Siempre `response.code_interpreter_call.in_progress`. Valores posibles: `response.code_interpreter_call.in_progress`	Sí

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Se genera cuando el intérprete de código interpreta activamente el fragmento de código.

Nombre	Tipo	Description	Obligatorio
item_id	string	Identificador único del elemento de llamada de la herramienta de intérprete de código.	Sí
output_index	integer	Índice del elemento de salida en la respuesta para la que el intérprete de código interpreta el código.	Sí
sequence_number	integer	Número de secuencia de este evento, usado para ordenar eventos de streaming.	Sí
type	enum	El tipo de evento. Siempre `response.code_interpreter_call.interpreting`. Valores posibles: `response.code_interpreter_call.interpreting`	Sí

OpenAI.ResponseContentPartAddedEvent

Se genera cuando se agrega una nueva parte de contenido.

Nombre	Tipo	Description	Obligatorio
content_index	integer	Índice del elemento de contenido que se agregó.	Sí
item_id	string	Identificador del elemento de salida al que se agregó la parte de contenido.	Sí
output_index	integer	Índice del elemento de salida al que se agregó la parte de contenido.	Sí
part	OpenAI.OutputContent		Sí
└─ Tipo	OpenAI.OutputContentType		Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre `response.content_part.added`. Valores posibles: `response.content_part.added`	Sí

OpenAI.ResponseCreatedEvent

Evento que se genera cuando se crea una respuesta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
respuesta	OpenAI.Response		Sí
└─ fondo	booleano o null		No
└" completed_at	cadena o nulo (unixTimestamp)		No
└" content_filters	matriz de AzureContentFilterForResponsesAPI	Los resultados del filtro de contenido de RAI.	Sí
Conversación └	OpenAI.ConversationReference o null		No
└─ created_at	entero (unixtime)	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
└─ Error	OpenAI.ResponseError o null		Sí
└─ id.	string	Identificador único de esta respuesta.	Sí
└─ detalles_incompletos	OpenAI.ResponseIncompleteDetails o null		Sí
└─ Instrucciones	cadena o matriz de OpenAI.InputItem o null		Sí
└─ max_output_tokens (máximo de tokens de salida)	entero o null		No
└─ «max_tool_calls»	entero o null		No
Metadatos └	OpenAI.Metadata o null		No
└─ modelo	string	Id. de modelo usado para generar la respuesta, como `gpt-4o` o `o3`. OpenAI ofrece una amplia gama de modelos con diferentes funcionalidades, rendimiento características y puntos de precio. Consulte la guía del modelo. para examinar y comparar los modelos disponibles.	No
└─ Objeto	enum	El tipo de objeto de este recurso: siempre se establece en `response`. Valores posibles: `response`	Sí
└─ salida	matriz de OpenAI.OutputItem	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la `output` matriz dependen en la respuesta del modelo. - En lugar de tener acceso al primer elemento de la `output` matriz y suponiendo que es un `assistant` mensaje con el contenido generado por el modelo, podría considerar la posibilidad de usar la propiedad `output_text` donde compatible con los SDK.	Sí
└─ texto_de_salida	string o null		No
└" parallel_tool_calls	boolean	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	Sí	True
└─ id_de_respuesta_anterior	string o null		No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Obtenga más información.	No
└" prompt_cache_key	string	Usado por OpenAI para almacenar en caché las respuestas de solicitudes similares para optimizar las tasas de aciertos de caché. Reemplaza el `user` campo. Obtenga más información.	No
└" prompt_cache_retention	string o null		No
└─ razonamiento	OpenAI.Reasoning o null		No
└" safety_identifier	string	Identificador estable que se usa para ayudar a detectar usuarios de la aplicación que pueden estar infringiendo las directivas de uso de OpenAI. Los identificadores deben ser una cadena que identifique de forma única a cada usuario. Se recomienda aplicar un hash a su nombre de usuario o dirección de correo electrónico para evitar enviarnos información de identificación. Obtenga más información.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de `completed`, , `failed` `in_progress`, `cancelled`, `queued`o `incomplete`. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└─ Temperatura	number o null		No	1
└─ texto	OpenAI.ResponseTextParam	Opciones de configuración para una respuesta de texto del modelo. Puede ser simple texto o datos JSON estructurados. Aprende más: - Entradas y salidas de texto - Salidas estructuradas	No
└─ selección_de_herramienta	OpenAI.ToolChoiceParam	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
└─ herramientas	OpenAI.ToolsArray	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Se admiten las siguientes categorías de herramientas: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda web o búsqueda de archivos. Más información sobre herramientas integradas. - Herramientas de MCP: integraciones con sistemas de terceros a través de servidores MCP personalizados o conectores predefinidos, como Google Drive y SharePoint. Más información sobre Herramientas de MCP. - Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, permitir que el modelo llame a su propio código con argumentos fuertemente tipados y salidas. Más información sobre llamada a función. También puede usar herramientas personalizadas para llamar a su propio código.	No
└" top_logprobs	entero o null		No
└─ top_p	number o null		No	1
└─ truncamiento	string o null		No	disabled
└─ uso	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
└─ Usuario	string (en desuso)	Este campo se va a reemplazar por `safety_identifier` y `prompt_cache_key`. Use `prompt_cache_key` en su lugar para mantener las optimizaciones de almacenamiento en caché. Identificador estable para los usuarios finales. Se usa para aumentar las tasas de aciertos de caché mediante una mejor creación de depósitos de solicitudes similares y para ayudar a OpenAI a detectar y evitar abusos. Obtenga más información.	No
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre `response.created`. Valores posibles: `response.created`	Sí

OpenAI.ResponseCustomToolCallInputDeltaEvent

RespuestaHerramienta PersonalizadaLlamadaEntradaDelta

Evento que representa una diferencia (actualización parcial) a la entrada de una llamada de herramienta personalizada.

Nombre	Tipo	Description	Obligatorio
delta	string	Datos de entrada incrementales (delta) para la llamada a la herramienta personalizada.	Sí
item_id	string	Identificador único del elemento de API asociado a este evento.	Sí
output_index	integer	Índice de la salida a la que se aplica esta diferencia.	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	Identificador del tipo de evento. Valores posibles: `response.custom_tool_call_input.delta`	Sí

OpenAI.ResponseError

Objeto de error devuelto cuando el modelo no puede generar una respuesta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	OpenAI.ResponseErrorCode	Código de error de la respuesta.	Sí
message	string	Descripción legible del error.	Sí

OpenAI.ResponseErrorCode

Código de error de la respuesta.

Propiedad	Value
Type	string
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

Se genera cuando se produce un error.

Nombre	Tipo	Description	Obligatorio
código	string o null		Sí
message	string	El mensaje de error.	Sí
param	string o null		Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre `error`. Valores posibles: `error`	Sí

OpenAI.ResponseFailedEvent

Evento que se genera cuando se produce un error en una respuesta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
respuesta	OpenAI.Response		Sí
└─ fondo	booleano o null		No
└" completed_at	cadena o nulo (unixTimestamp)		No
└" content_filters	matriz de AzureContentFilterForResponsesAPI	Los resultados del filtro de contenido de RAI.	Sí
Conversación └	OpenAI.ConversationReference o null		No
└─ created_at	entero (unixtime)	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
└─ Error	OpenAI.ResponseError o null		Sí
└─ id.	string	Identificador único de esta respuesta.	Sí
└─ detalles_incompletos	OpenAI.ResponseIncompleteDetails o null		Sí
└─ Instrucciones	cadena o matriz de OpenAI.InputItem o null		Sí
└─ max_output_tokens (máximo de tokens de salida)	entero o null		No
└─ «max_tool_calls»	entero o null		No
Metadatos └	OpenAI.Metadata o null		No
└─ modelo	string	Id. de modelo usado para generar la respuesta, como `gpt-4o` o `o3`. OpenAI ofrece una amplia gama de modelos con diferentes funcionalidades, rendimiento características y puntos de precio. Consulte la guía del modelo. para examinar y comparar los modelos disponibles.	No
└─ Objeto	enum	El tipo de objeto de este recurso: siempre se establece en `response`. Valores posibles: `response`	Sí
└─ salida	matriz de OpenAI.OutputItem	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la `output` matriz dependen en la respuesta del modelo. - En lugar de tener acceso al primer elemento de la `output` matriz y suponiendo que es un `assistant` mensaje con el contenido generado por el modelo, podría considerar la posibilidad de usar la propiedad `output_text` donde compatible con los SDK.	Sí
└─ texto_de_salida	string o null		No
└" parallel_tool_calls	boolean	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	Sí	True
└─ id_de_respuesta_anterior	string o null		No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Obtenga más información.	No
└" prompt_cache_key	string	Usado por OpenAI para almacenar en caché las respuestas de solicitudes similares para optimizar las tasas de aciertos de caché. Reemplaza el `user` campo. Obtenga más información.	No
└" prompt_cache_retention	string o null		No
└─ razonamiento	OpenAI.Reasoning o null		No
└" safety_identifier	string	Identificador estable que se usa para ayudar a detectar usuarios de la aplicación que pueden estar infringiendo las directivas de uso de OpenAI. Los identificadores deben ser una cadena que identifique de forma única a cada usuario. Se recomienda aplicar un hash a su nombre de usuario o dirección de correo electrónico para evitar enviarnos información de identificación. Obtenga más información.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de `completed`, , `failed` `in_progress`, `cancelled`, `queued`o `incomplete`. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└─ Temperatura	number o null		No	1
└─ texto	OpenAI.ResponseTextParam	Opciones de configuración para una respuesta de texto del modelo. Puede ser simple texto o datos JSON estructurados. Aprende más: - Entradas y salidas de texto - Salidas estructuradas	No
└─ selección_de_herramienta	OpenAI.ToolChoiceParam	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
└─ herramientas	OpenAI.ToolsArray	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Se admiten las siguientes categorías de herramientas: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda web o búsqueda de archivos. Más información sobre herramientas integradas. - Herramientas de MCP: integraciones con sistemas de terceros a través de servidores MCP personalizados o conectores predefinidos, como Google Drive y SharePoint. Más información sobre Herramientas de MCP. - Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, permitir que el modelo llame a su propio código con argumentos fuertemente tipados y salidas. Más información sobre llamada a función. También puede usar herramientas personalizadas para llamar a su propio código.	No
└" top_logprobs	entero o null		No
└─ top_p	number o null		No	1
└─ truncamiento	string o null		No	disabled
└─ uso	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
└─ Usuario	string (en desuso)	Este campo se va a reemplazar por `safety_identifier` y `prompt_cache_key`. Use `prompt_cache_key` en su lugar para mantener las optimizaciones de almacenamiento en caché. Identificador estable para los usuarios finales. Se usa para aumentar las tasas de aciertos de caché mediante una mejor creación de depósitos de solicitudes similares y para ayudar a OpenAI a detectar y evitar abusos. Obtenga más información.	No
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre `response.failed`. Valores posibles: `response.failed`	Sí

OpenAI.ResponseFileSearchCallInProgressEvent

Se genera cuando se inicia una llamada de búsqueda de archivos.

Nombre	Tipo	Description	Obligatorio
item_id	string	Identificador del elemento de salida con el que se inicia la llamada de búsqueda de archivos.	Sí
output_index	integer	Índice del elemento de salida que se inicia la llamada de búsqueda de archivos.	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre `response.file_search_call.in_progress`. Valores posibles: `response.file_search_call.in_progress`	Sí

OpenAI.ResponseFileSearchCallSearchingEvent

Se genera cuando una búsqueda de archivos está buscando actualmente.

Nombre	Tipo	Description	Obligatorio
item_id	string	Identificador del elemento de salida con el que se inicia la llamada de búsqueda de archivos.	Sí
output_index	integer	Índice del elemento de salida que la llamada de búsqueda de archivos está buscando.	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre `response.file_search_call.searching`. Valores posibles: `response.file_search_call.searching`	Sí

OpenAI.ResponseFormatJsonSchemaSchema

Esquema JSON

Esquema para el formato de respuesta, descrito como un objeto de esquema JSON. Obtenga información sobre cómo compilar esquemas JSON aquí.

Tipo: objeto

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Se genera cuando hay un delta de argumentos de llamada a función parciales.

Nombre	Tipo	Description	Obligatorio
delta	string	Los argumentos de llamada a función delta que se agregan.	Sí
item_id	string	Identificador del elemento de salida al que se agrega el delta de argumentos de llamada de función.	Sí
output_index	integer	Índice del elemento de salida al que se agrega el delta de argumentos de llamada de función.	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre `response.function_call_arguments.delta`. Valores posibles: `response.function_call_arguments.delta`	Sí

OpenAI.ResponseImageGenCallGeneratingEvent

ResponseImageGenCallGeneratingEvent

Se genera cuando una llamada a la herramienta de generación de imágenes genera activamente una imagen (estado intermedio).

Nombre	Tipo	Description	Obligatorio
item_id	string	Identificador único del elemento de generación de imágenes que se está procesando.	Sí
output_index	integer	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
sequence_number	integer	Número de secuencia del elemento de generación de imágenes que se está procesando.	Sí
type	enum	El tipo de evento. Siempre "response.image_generation_call.generating". Valores posibles: `response.image_generation_call.generating`	Sí

OpenAI.ResponseImageGenCallInProgressEvent

RespuestaImagenGenLlamadaEnProgresoEvento

Se genera cuando una llamada a la herramienta de generación de imágenes está en curso.

Nombre	Tipo	Description	Obligatorio
item_id	string	Identificador único del elemento de generación de imágenes que se está procesando.	Sí
output_index	integer	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
sequence_number	integer	Número de secuencia del elemento de generación de imágenes que se está procesando.	Sí
type	enum	El tipo de evento. Siempre "response.image_generation_call.in_progress". Valores posibles: `response.image_generation_call.in_progress`	Sí

OpenAI.ResponseImageGenCallPartialImageEvent

RespuestaImagenGenLlamadaEventoImagenParcial

Se genera cuando una imagen parcial está disponible durante el streaming de generación de imágenes.

Nombre	Tipo	Description	Obligatorio
item_id	string	Identificador único del elemento de generación de imágenes que se está procesando.	Sí
output_index	integer	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
partial_image_b64	string	Datos de imagen parcial codificados en Base64, adecuados para la representación como una imagen.	Sí
partial_image_index	integer	Índice basado en 0 para la imagen parcial (el back-end está basado en 1, pero se basa en 0 para el usuario).	Sí
sequence_number	integer	Número de secuencia del elemento de generación de imágenes que se está procesando.	Sí
type	enum	El tipo de evento. Siempre 'response.image_generation_call.partial_image'. Valores posibles: `response.image_generation_call.partial_image`	Sí

OpenAI.ResponseInProgressEvent

Se genera cuando la respuesta está en curso.

Nombre	Tipo	Description	Obligatorio	Predeterminado
respuesta	OpenAI.Response		Sí
└─ fondo	booleano o null		No
└" completed_at	cadena o nulo (unixTimestamp)		No
└" content_filters	matriz de AzureContentFilterForResponsesAPI	Los resultados del filtro de contenido de RAI.	Sí
Conversación └	OpenAI.ConversationReference o null		No
└─ created_at	entero (unixtime)	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
└─ Error	OpenAI.ResponseError o null		Sí
└─ id.	string	Identificador único de esta respuesta.	Sí
└─ detalles_incompletos	OpenAI.ResponseIncompleteDetails o null		Sí
└─ Instrucciones	cadena o matriz de OpenAI.InputItem o null		Sí
└─ max_output_tokens (máximo de tokens de salida)	entero o null		No
└─ «max_tool_calls»	entero o null		No
Metadatos └	OpenAI.Metadata o null		No
└─ modelo	string	Id. de modelo usado para generar la respuesta, como `gpt-4o` o `o3`. OpenAI ofrece una amplia gama de modelos con diferentes funcionalidades, rendimiento características y puntos de precio. Consulte la guía del modelo. para examinar y comparar los modelos disponibles.	No
└─ Objeto	enum	El tipo de objeto de este recurso: siempre se establece en `response`. Valores posibles: `response`	Sí
└─ salida	matriz de OpenAI.OutputItem	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la `output` matriz dependen en la respuesta del modelo. - En lugar de tener acceso al primer elemento de la `output` matriz y suponiendo que es un `assistant` mensaje con el contenido generado por el modelo, podría considerar la posibilidad de usar la propiedad `output_text` donde compatible con los SDK.	Sí
└─ texto_de_salida	string o null		No
└" parallel_tool_calls	boolean	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	Sí	True
└─ id_de_respuesta_anterior	string o null		No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Obtenga más información.	No
└" prompt_cache_key	string	Usado por OpenAI para almacenar en caché las respuestas de solicitudes similares para optimizar las tasas de aciertos de caché. Reemplaza el `user` campo. Obtenga más información.	No
└" prompt_cache_retention	string o null		No
└─ razonamiento	OpenAI.Reasoning o null		No
└" safety_identifier	string	Identificador estable que se usa para ayudar a detectar usuarios de la aplicación que pueden estar infringiendo las directivas de uso de OpenAI. Los identificadores deben ser una cadena que identifique de forma única a cada usuario. Se recomienda aplicar un hash a su nombre de usuario o dirección de correo electrónico para evitar enviarnos información de identificación. Obtenga más información.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de `completed`, , `failed` `in_progress`, `cancelled`, `queued`o `incomplete`. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└─ Temperatura	number o null		No	1
└─ texto	OpenAI.ResponseTextParam	Opciones de configuración para una respuesta de texto del modelo. Puede ser simple texto o datos JSON estructurados. Aprende más: - Entradas y salidas de texto - Salidas estructuradas	No
└─ selección_de_herramienta	OpenAI.ToolChoiceParam	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
└─ herramientas	OpenAI.ToolsArray	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Se admiten las siguientes categorías de herramientas: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda web o búsqueda de archivos. Más información sobre herramientas integradas. - Herramientas de MCP: integraciones con sistemas de terceros a través de servidores MCP personalizados o conectores predefinidos, como Google Drive y SharePoint. Más información sobre Herramientas de MCP. - Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, permitir que el modelo llame a su propio código con argumentos fuertemente tipados y salidas. Más información sobre llamada a función. También puede usar herramientas personalizadas para llamar a su propio código.	No
└" top_logprobs	entero o null		No
└─ top_p	number o null		No	1
└─ truncamiento	string o null		No	disabled
└─ uso	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
└─ Usuario	string (en desuso)	Este campo se va a reemplazar por `safety_identifier` y `prompt_cache_key`. Use `prompt_cache_key` en su lugar para mantener las optimizaciones de almacenamiento en caché. Identificador estable para los usuarios finales. Se usa para aumentar las tasas de aciertos de caché mediante una mejor creación de depósitos de solicitudes similares y para ayudar a OpenAI a detectar y evitar abusos. Obtenga más información.	No
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre `response.in_progress`. Valores posibles: `response.in_progress`	Sí

OpenAI.ResponseIncompleteDetails

Nombre	Tipo	Description	Obligatorio	Predeterminado
razón	enum	Valores posibles: `max_output_tokens`, `content_filter`	No

OpenAI.ResponseIncompleteEvent

Evento que se genera cuando una respuesta finaliza como incompleta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
respuesta	OpenAI.Response		Sí
└─ fondo	booleano o null		No
└" completed_at	cadena o nulo (unixTimestamp)		No
└" content_filters	matriz de AzureContentFilterForResponsesAPI	Los resultados del filtro de contenido de RAI.	Sí
Conversación └	OpenAI.ConversationReference o null		No
└─ created_at	entero (unixtime)	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
└─ Error	OpenAI.ResponseError o null		Sí
└─ id.	string	Identificador único de esta respuesta.	Sí
└─ detalles_incompletos	OpenAI.ResponseIncompleteDetails o null		Sí
└─ Instrucciones	cadena o matriz de OpenAI.InputItem o null		Sí
└─ max_output_tokens (máximo de tokens de salida)	entero o null		No
└─ «max_tool_calls»	entero o null		No
Metadatos └	OpenAI.Metadata o null		No
└─ modelo	string	Id. de modelo usado para generar la respuesta, como `gpt-4o` o `o3`. OpenAI ofrece una amplia gama de modelos con diferentes funcionalidades, rendimiento características y puntos de precio. Consulte la guía del modelo. para examinar y comparar los modelos disponibles.	No
└─ Objeto	enum	El tipo de objeto de este recurso: siempre se establece en `response`. Valores posibles: `response`	Sí
└─ salida	matriz de OpenAI.OutputItem	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la `output` matriz dependen en la respuesta del modelo. - En lugar de tener acceso al primer elemento de la `output` matriz y suponiendo que es un `assistant` mensaje con el contenido generado por el modelo, podría considerar la posibilidad de usar la propiedad `output_text` donde compatible con los SDK.	Sí
└─ texto_de_salida	string o null		No
└" parallel_tool_calls	boolean	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	Sí	True
└─ id_de_respuesta_anterior	string o null		No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Obtenga más información.	No
└" prompt_cache_key	string	Usado por OpenAI para almacenar en caché las respuestas de solicitudes similares para optimizar las tasas de aciertos de caché. Reemplaza el `user` campo. Obtenga más información.	No
└" prompt_cache_retention	string o null		No
└─ razonamiento	OpenAI.Reasoning o null		No
└" safety_identifier	string	Identificador estable que se usa para ayudar a detectar usuarios de la aplicación que pueden estar infringiendo las directivas de uso de OpenAI. Los identificadores deben ser una cadena que identifique de forma única a cada usuario. Se recomienda aplicar un hash a su nombre de usuario o dirección de correo electrónico para evitar enviarnos información de identificación. Obtenga más información.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de `completed`, , `failed` `in_progress`, `cancelled`, `queued`o `incomplete`. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└─ Temperatura	number o null		No	1
└─ texto	OpenAI.ResponseTextParam	Opciones de configuración para una respuesta de texto del modelo. Puede ser simple texto o datos JSON estructurados. Aprende más: - Entradas y salidas de texto - Salidas estructuradas	No
└─ selección_de_herramienta	OpenAI.ToolChoiceParam	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
└─ herramientas	OpenAI.ToolsArray	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Se admiten las siguientes categorías de herramientas: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda web o búsqueda de archivos. Más información sobre herramientas integradas. - Herramientas de MCP: integraciones con sistemas de terceros a través de servidores MCP personalizados o conectores predefinidos, como Google Drive y SharePoint. Más información sobre Herramientas de MCP. - Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, permitir que el modelo llame a su propio código con argumentos fuertemente tipados y salidas. Más información sobre llamada a función. También puede usar herramientas personalizadas para llamar a su propio código.	No
└" top_logprobs	entero o null		No
└─ top_p	number o null		No	1
└─ truncamiento	string o null		No	disabled
└─ uso	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
└─ Usuario	string (en desuso)	Este campo se va a reemplazar por `safety_identifier` y `prompt_cache_key`. Use `prompt_cache_key` en su lugar para mantener las optimizaciones de almacenamiento en caché. Identificador estable para los usuarios finales. Se usa para aumentar las tasas de aciertos de caché mediante una mejor creación de depósitos de solicitudes similares y para ayudar a OpenAI a detectar y evitar abusos. Obtenga más información.	No
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre `response.incomplete`. Valores posibles: `response.incomplete`	Sí

OpenAI.ResponseItemList

Lista de elementos de respuesta.

Nombre	Tipo	Description	Obligatorio
data	matriz de OpenAI.ItemResource	Lista de elementos usados para generar esta respuesta.	Sí
first_id	string	Identificador del primer elemento de la lista.	Sí
has_more	boolean	Si hay más elementos disponibles.	Sí
last_id	string	Identificador del último elemento de la lista.	Sí
object	enum	El tipo de objeto devuelto debe ser `list`. Valores posibles: `list`	Sí

OpenAI.ResponseLogProb

Un logprob es la probabilidad logarítmica que el modelo asigna a generar un token determinado en una posición determinada de la secuencia. Los valores de logprob menos negativos (superiores) indican una mayor confianza del modelo en esa opción de token.

Nombre	Tipo	Description	Obligatorio
logprob	número	Probabilidad de registro de este token.	Sí
token	string	Un posible token de texto.	Sí
top_logprobs	matriz de OpenAI.ResponseLogProbTopLogprobs	Probabilidad de registro de los 20 tokens más probables.	No

OpenAI.ResponseLogProbTopLogprobs

Nombre	Tipo	Description	Obligatorio	Predeterminado
logprob	número		No
token	string		No

OpenAI.ResponseMCPCallArgumentsDeltaEvent

RespuestaMCPCtodosArgumentosDeltaEvento

Se genera cuando hay una diferencia (actualización parcial) a los argumentos de una llamada a la herramienta MCP.

Nombre	Tipo	Description	Obligatorio
delta	string	Cadena JSON que contiene la actualización parcial a los argumentos de la llamada a la herramienta MCP.	Sí
item_id	string	Identificador único del elemento de llamada a la herramienta MCP que se está procesando.	Sí
output_index	integer	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre 'response.mcp_call_arguments.delta'. Valores posibles: `response.mcp_call_arguments.delta`	Sí

OpenAI.ResponseMCPCallFailedEvent

ResponseMCPCallFailedEvent

Se genera cuando se produce un error en una llamada a la herramienta MCP.

Nombre	Tipo	Description	Obligatorio
item_id	string	Identificador del elemento de llamada a la herramienta MCP que produjo un error.	Sí
output_index	integer	Índice del elemento de salida que produjo un error.	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre "response.mcp_call.failed". Valores posibles: `response.mcp_call.failed`	Sí

OpenAI.ResponseMCPCallInProgressEvent

ResponseMCPCallInProgressEvent

Se genera cuando una llamada a la herramienta MCP está en curso.

Nombre	Tipo	Description	Obligatorio
item_id	string	Identificador único del elemento de llamada a la herramienta MCP que se está procesando.	Sí
output_index	integer	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre "response.mcp_call.in_progress". Valores posibles: `response.mcp_call.in_progress`	Sí

OpenAI.ResponseMCPListToolsFailedEvent

RespuestaMCPListToolsFailedEvent

Se genera cuando se produce un error en el intento de enumerar las herramientas de MCP disponibles.

Nombre	Tipo	Description	Obligatorio
item_id	string	Identificador del elemento de llamada a la herramienta MCP que produjo un error.	Sí
output_index	integer	Índice del elemento de salida que produjo un error.	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre 'response.mcp_list_tools.failed'. Valores posibles: `response.mcp_list_tools.failed`	Sí

OpenAI.ResponseMCPListToolsInProgressEvent

RespuestaMCPListToolsInEnProgressEvent

Se genera cuando el sistema está en proceso de recuperar la lista de herramientas de MCP disponibles.

Nombre	Tipo	Description	Obligatorio
item_id	string	Identificador del elemento de llamada a la herramienta MCP que se está procesando.	Sí
output_index	integer	Índice del elemento de salida que se está procesando.	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre "response.mcp_list_tools.in_progress". Valores posibles: `response.mcp_list_tools.in_progress`	Sí

OpenAI.ResponseOutputItemAddedEvent

Se genera cuando se agrega un nuevo elemento de salida.

Nombre	Tipo	Description	Obligatorio
item	OpenAI.OutputItem		Sí
└─ Tipo	OpenAI.OutputItemType		Sí
output_index	integer	Índice del elemento de salida que se agregó.	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre `response.output_item.added`. Valores posibles: `response.output_item.added`	Sí

OpenAI.ResponseOutputTextAnnotationAddedEvent

RespuestaSalidaTextoAnotaciónEventoAñadido

Se genera cuando se agrega una anotación al contenido de texto de salida.

Nombre	Tipo	Description	Obligatorio
anotación	OpenAI.Annotation	Anotación que se aplica a un intervalo de texto de salida.	Sí
└─ Tipo	OpenAI.AnnotationType		Sí
annotation_index	integer	Índice de la anotación dentro de la parte de contenido.	Sí
content_index	integer	Índice del elemento de contenido dentro del elemento de salida.	Sí
item_id	string	Identificador único del elemento al que se va a agregar la anotación.	Sí
output_index	integer	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre 'response.output_text.annotation.added'. Valores posibles: `response.output_text.annotation.added`	Sí

OpenAI.ResponsePromptVariables

Prompt Variables

Asignación opcional de valores para sustituir por variables en el símbolo del sistema. Los valores de sustitución pueden ser cadenas u otros tipos de entrada de respuesta, como imágenes o archivos.

Tipo: objeto

OpenAI.ResponseQueuedEvent

ResponseQueuedEvent

Se genera cuando se pone en cola una respuesta y se espera a que se procese.

Nombre	Tipo	Description	Obligatorio	Predeterminado
respuesta	OpenAI.Response		Sí
└─ fondo	booleano o null		No
└" completed_at	cadena o nulo (unixTimestamp)		No
└" content_filters	matriz de AzureContentFilterForResponsesAPI	Los resultados del filtro de contenido de RAI.	Sí
Conversación └	OpenAI.ConversationReference o null		No
└─ created_at	entero (unixtime)	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
└─ Error	OpenAI.ResponseError o null		Sí
└─ id.	string	Identificador único de esta respuesta.	Sí
└─ detalles_incompletos	OpenAI.ResponseIncompleteDetails o null		Sí
└─ Instrucciones	cadena o matriz de OpenAI.InputItem o null		Sí
└─ max_output_tokens (máximo de tokens de salida)	entero o null		No
└─ «max_tool_calls»	entero o null		No
Metadatos └	OpenAI.Metadata o null		No
└─ modelo	string	Id. de modelo usado para generar la respuesta, como `gpt-4o` o `o3`. OpenAI ofrece una amplia gama de modelos con diferentes funcionalidades, rendimiento características y puntos de precio. Consulte la guía del modelo. para examinar y comparar los modelos disponibles.	No
└─ Objeto	enum	El tipo de objeto de este recurso: siempre se establece en `response`. Valores posibles: `response`	Sí
└─ salida	matriz de OpenAI.OutputItem	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la `output` matriz dependen en la respuesta del modelo. - En lugar de tener acceso al primer elemento de la `output` matriz y suponiendo que es un `assistant` mensaje con el contenido generado por el modelo, podría considerar la posibilidad de usar la propiedad `output_text` donde compatible con los SDK.	Sí
└─ texto_de_salida	string o null		No
└" parallel_tool_calls	boolean	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	Sí	True
└─ id_de_respuesta_anterior	string o null		No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Obtenga más información.	No
└" prompt_cache_key	string	Usado por OpenAI para almacenar en caché las respuestas de solicitudes similares para optimizar las tasas de aciertos de caché. Reemplaza el `user` campo. Obtenga más información.	No
└" prompt_cache_retention	string o null		No
└─ razonamiento	OpenAI.Reasoning o null		No
└" safety_identifier	string	Identificador estable que se usa para ayudar a detectar usuarios de la aplicación que pueden estar infringiendo las directivas de uso de OpenAI. Los identificadores deben ser una cadena que identifique de forma única a cada usuario. Se recomienda aplicar un hash a su nombre de usuario o dirección de correo electrónico para evitar enviarnos información de identificación. Obtenga más información.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de `completed`, , `failed` `in_progress`, `cancelled`, `queued`o `incomplete`. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└─ Temperatura	number o null		No	1
└─ texto	OpenAI.ResponseTextParam	Opciones de configuración para una respuesta de texto del modelo. Puede ser simple texto o datos JSON estructurados. Aprende más: - Entradas y salidas de texto - Salidas estructuradas	No
└─ selección_de_herramienta	OpenAI.ToolChoiceParam	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
└─ herramientas	OpenAI.ToolsArray	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Se admiten las siguientes categorías de herramientas: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda web o búsqueda de archivos. Más información sobre herramientas integradas. - Herramientas de MCP: integraciones con sistemas de terceros a través de servidores MCP personalizados o conectores predefinidos, como Google Drive y SharePoint. Más información sobre Herramientas de MCP. - Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, permitir que el modelo llame a su propio código con argumentos fuertemente tipados y salidas. Más información sobre llamada a función. También puede usar herramientas personalizadas para llamar a su propio código.	No
└" top_logprobs	entero o null		No
└─ top_p	number o null		No	1
└─ truncamiento	string o null		No	disabled
└─ uso	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
└─ Usuario	string (en desuso)	Este campo se va a reemplazar por `safety_identifier` y `prompt_cache_key`. Use `prompt_cache_key` en su lugar para mantener las optimizaciones de almacenamiento en caché. Identificador estable para los usuarios finales. Se usa para aumentar las tasas de aciertos de caché mediante una mejor creación de depósitos de solicitudes similares y para ayudar a OpenAI a detectar y evitar abusos. Obtenga más información.	No
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre 'response.queued'. Valores posibles: `response.queued`	Sí

OpenAI.ResponseReasoningSummaryPartAddedEvent

Se genera cuando se agrega una nueva parte de resumen de razonamiento.

Nombre	Tipo	Description	Obligatorio
item_id	string	El identificador del elemento al que está asociado este elemento de resumen.	Sí
output_index	integer	Índice del elemento de salida al que está asociado esta parte de resumen.	Sí
part	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Sí
└─ texto	string		Sí
└─ Tipo	enum	Valores posibles: `summary_text`	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
summary_index	integer	Índice de la parte de resumen dentro del resumen de razonamiento.	Sí
type	enum	El tipo de evento. Siempre `response.reasoning_summary_part.added`. Valores posibles: `response.reasoning_summary_part.added`	Sí

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Nombre	Tipo	Description	Obligatorio	Predeterminado
text	string		Sí
type	enum	Valores posibles: `summary_text`	Sí

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Se genera cuando se agrega un delta a un texto de resumen de razonamiento.

Nombre	Tipo	Description	Obligatorio
delta	string	Delta de texto que se agregó al resumen.	Sí
item_id	string	El identificador del elemento al que está asociado este delta de texto de resumen.	Sí
output_index	integer	Índice del elemento de salida al que está asociado este delta de texto de resumen.	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
summary_index	integer	Índice de la parte de resumen dentro del resumen de razonamiento.	Sí
type	enum	El tipo de evento. Siempre `response.reasoning_summary_text.delta`. Valores posibles: `response.reasoning_summary_text.delta`	Sí

OpenAI.ResponseReasoningTextDeltaEvent

Se genera cuando se agrega un delta a un texto de razonamiento.

Nombre	Tipo	Description	Obligatorio
content_index	integer	Índice de la parte de contenido de razonamiento a la que está asociada esta diferencia.	Sí
delta	string	Delta de texto que se agregó al contenido de razonamiento.	Sí
item_id	string	El identificador del elemento al que está asociado este delta de texto de razonamiento.	Sí
output_index	integer	Índice del elemento de salida al que está asociado este delta de texto de razonamiento.	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre `response.reasoning_text.delta`. Valores posibles: `response.reasoning_text.delta`	Sí

OpenAI.ResponseRefusalDeltaEvent

Se emite cuando hay un texto de denegación parcial.

Nombre	Tipo	Description	Obligatorio
content_index	integer	Índice de la parte de contenido a la que se agrega el texto de denegación.	Sí
delta	string	Texto de denegación que se agrega.	Sí
item_id	string	Identificador del elemento de salida al que se agrega el texto de denegación.	Sí
output_index	integer	Índice del elemento de salida al que se agrega el texto de denegación.	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre `response.refusal.delta`. Valores posibles: `response.refusal.delta`	Sí

OpenAI.ResponseStreamOptions

Opciones para las respuestas de streaming. Establézcalo solo cuando establezca stream: true.

Nombre	Tipo	Description	Obligatorio	Predeterminado
include_obfuscation	boolean	Cuando sea true, se habilitará la ofuscación de la secuencia. Agrega ofuscación de secuencias caracteres aleatorios a un `obfuscation` campo en el streaming de eventos delta a normalice los tamaños de carga como una mitigación de determinados ataques de canal lateral. Estos campos de ofuscación se incluyen de forma predeterminada, pero agregan una pequeña cantidad. de sobrecarga en el flujo de datos. Puede establecer en `include_obfuscation` . false para optimizar el ancho de banda si confía en los vínculos de red entre la aplicación y la API de OpenAI.	No

OpenAI.ResponseTextDeltaEvent

Se genera cuando hay un delta de texto adicional.

Nombre	Tipo	Description	Obligatorio
content_index	integer	Índice de la parte de contenido a la que se agregó el delta de texto.	Sí
delta	string	Delta de texto que se agregó.	Sí
item_id	string	Identificador del elemento de salida al que se agregó el delta de texto.	Sí
logprobs	matriz de OpenAI.ResponseLogProb	Probabilidades de registro de los tokens en la diferencia.	Sí
output_index	integer	Índice del elemento de salida al que se agregó el delta de texto.	Sí
sequence_number	integer	Número de secuencia de este evento.	Sí
type	enum	El tipo de evento. Siempre `response.output_text.delta`. Valores posibles: `response.output_text.delta`	Sí

OpenAI.ResponseTextParam

Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados. Aprende más:

Nombre	Tipo	Description	Obligatorio	Predeterminado
format	OpenAI.TextResponseFormatConfiguration	Objeto que especifica el formato que debe generar el modelo. `{ "type": "json_schema" }` La configuración habilita salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON proporcionado. Más información en El formato predeterminado es `{ "type": "text" }` sin opciones adicionales. No se recomienda para los modelos gpt-4o y más recientes: Al establecer en `{ "type": "json_object" }` se habilita el modo JSON anterior, que garantiza que el mensaje que genera el modelo es JSON válido. Usar `json_schema` es preferible para los modelos que lo admiten.	No
detalle	OpenAI.Verbosity	Restringe el nivel de detalle de la respuesta del modelo. Los valores inferiores darán como resultado respuestas más concisas, mientras que los valores más altos darán lugar a respuestas más detalladas. Actualmente, los valores admitidos son `low`, `medium`y `high`.	No

OpenAI.ResponseUsage

Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.

Nombre	Tipo	Description	Obligatorio
input_tokens	integer	Número de tokens de entrada.	Sí
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Sí
└─ tokens en caché	integer		Sí
output_tokens	integer	Número de tokens de salida.	Sí
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Sí
─ reasoning_tokens	integer		Sí
total_tokens	integer	Número total de tokens usados.	Sí

OpenAI.ResponseUsageInputTokensDetails

Nombre	Tipo	Description	Obligatorio	Predeterminado
cached_tokens	integer		Sí

OpenAI.ResponseUsageOutputTokensDetails

Nombre	Tipo	Description	Obligatorio	Predeterminado
reasoning_tokens	integer		Sí

OpenAI.ResponseWebSearchCallInProgressEvent

Nota: web_search aún no está disponible a través de Azure OpenAI.

Nombre	Tipo	Description	Obligatorio
item_id	string	Identificador único del elemento de salida asociado a la llamada de búsqueda web.	Sí
output_index	integer	Índice del elemento de salida al que está asociada la llamada de búsqueda web.	Sí
sequence_number	integer	Número de secuencia de la llamada de búsqueda web que se está procesando.	Sí
type	enum	El tipo de evento. Siempre `response.web_search_call.in_progress`. Valores posibles: `response.web_search_call.in_progress`	Sí

OpenAI.ResponseWebSearchCallSearchingEvent

Nota: web_search aún no está disponible a través de Azure OpenAI.

Nombre	Tipo	Description	Obligatorio
item_id	string	Identificador único del elemento de salida asociado a la llamada de búsqueda web.	Sí
output_index	integer	Índice del elemento de salida al que está asociada la llamada de búsqueda web.	Sí
sequence_number	integer	Número de secuencia de la llamada de búsqueda web que se está procesando.	Sí
type	enum	El tipo de evento. Siempre `response.web_search_call.searching`. Valores posibles: `response.web_search_call.searching`	Sí

OpenAI.Screenshot

Screenshot

Acción de captura de pantalla.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Especifica el tipo de evento. Para una acción de captura de pantalla, esta propiedad es establezca siempre en `screenshot`. Valores posibles: `screenshot`	Sí	captura de pantalla

OpenAI.Scroll

Scroll

Una acción de desplazamiento.

Nombre	Tipo	Description	Obligatorio	Predeterminado
scroll_x	integer	Distancia de desplazamiento horizontal.	Sí
scroll_y	integer	Distancia de desplazamiento vertical.	Sí
type	enum	Especifica el tipo de evento. Para una acción de desplazamiento, esta propiedad es establezca siempre en `scroll`. Valores posibles: `scroll`	Sí	Pergamino
x	integer	Coordenada x donde se produjo el desplazamiento.	Sí
y	integer	Coordenada y donde se produjo el desplazamiento.	Sí

OpenAI.SearchContextSize

Propiedad	Value
Type	string
Valores	`low` `medium` `high`

OpenAI.SpecificApplyPatchParam

Elección específica de herramienta de parche

Obliga al modelo a llamar a la herramienta apply_patch al ejecutar una llamada a herramienta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Herramienta a la que se va a llamar. Siempre `apply_patch`. Valores posibles: `apply_patch`	Sí	apply_patch

OpenAI.SpecificFunctionShellParam

Elección específica de herramienta de carcasa

Obliga al modelo a llamar a la herramienta de shell cuando se requiere una llamada a herramienta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Herramienta a la que se va a llamar. Siempre `shell`. Valores posibles: `shell`	Sí	shell

OpenAI.Summary

Texto resumen

Texto de resumen del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
text	string	Un resumen de la salida de razonamiento del modelo hasta ahora.	Sí
type	enum	Tipo del objeto. Siempre `summary_text`. Valores posibles: `summary_text`	Sí	summary_text

OpenAI.TextResponseFormatConfiguration

Objeto que especifica el formato que debe generar el modelo. { "type": "json_schema" } La configuración habilita las salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON proporcionado. Más información en

El formato predeterminado es { "type": "text" } sin opciones adicionales. No recomendado para gpt-4o y modelos más recientes: Configurar para { "type": "json_object" } activa el modo JSON más antiguo, que asegura que el mensaje generado por el modelo sea JSON válido. Se prefiere usar json_schema para los modelos que lo admiten.

Discriminador para OpenAI.TextResponseFormatConfiguration

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de valor	Schema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.TextResponseFormatConfigurationType		Sí

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Objeto JSON

Formato de respuesta de objeto JSON. Un método anterior para generar respuestas JSON. Se recomienda usar json_schema para los modelos que lo admiten. Tenga en cuenta que el modelo no generará JSON sin un mensaje del usuario o del sistema que lo indique.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de formato de respuesta que se va a definir. Siempre `json_object`. Valores posibles: `json_object`	Sí

OpenAI.TextResponseFormatConfigurationResponseFormatText

Text

Formato de respuesta predeterminado. Se usa para generar respuestas de texto.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de formato de respuesta que se va a definir. Siempre `text`. Valores posibles: `text`	Sí

OpenAI.TextResponseFormatConfigurationType

Propiedad	Value
Type	string
Valores	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

Esquema JSON

Formato de respuesta del esquema JSON. Se usa para generar respuestas JSON estructuradas. Aprende más sobre Structured Outputs.

Nombre	Tipo	Description	Obligatorio
description	string	Descripción del propósito del formato de respuesta que usa el modelo determine cómo responder en el formato.	No
nombre	string	Nombre del formato de respuesta. Debe ser a-z, A-Z, 0-9 o contener caracteres de subrayado y guiones, con una longitud máxima de 64.	Sí
schema	OpenAI.ResponseFormatJsonSchemaSchema	Esquema para el formato de respuesta, descrito como un objeto de esquema JSON. Obtenga información sobre cómo compilar esquemas JSON aquí.	Sí
strict	booleano o null		No
type	enum	Tipo de formato de respuesta que se va a definir. Siempre `json_schema`. Valores posibles: `json_schema`	Sí

OpenAI.Tool

Herramienta que se puede usar para generar una respuesta.

Discriminador para OpenAI.Tool

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de 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

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ToolType		Sí

OpenAI.ToolChoiceAllowed

Herramientas permitidas

Restringe las herramientas disponibles para el modelo a un conjunto predefinido.

Nombre	Tipo	Description	Obligatorio
mode	enum	Restringe las herramientas disponibles para el modelo a un conjunto predefinido. `auto` permite que el modelo elija entre las herramientas permitidas y genere un mensaje. `required` requiere que el modelo llame a una o varias de las herramientas permitidas. Valores posibles: `auto`, `required`	Sí
tools	matriz de objeto	Lista de definiciones de herramientas a las que se debe permitir que el modelo llame. En el caso de la API de respuestas, la lista de definiciones de herramientas podría ser similar a la siguiente: `json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br>`	Sí
type	enum	Tipo de configuración de herramienta permitido. Siempre `allowed_tools`. Valores posibles: `allowed_tools`	Sí

OpenAI.ToolChoiceCodeInterpreter

Indica que el modelo debe usar una herramienta integrada para generar una respuesta. Obtenga más información sobre las herramientas integradas.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Valores posibles: `code_interpreter`	Sí

OpenAI.ToolChoiceComputerUsePreview

Indica que el modelo debe usar una herramienta integrada para generar una respuesta. Obtenga más información sobre las herramientas integradas.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Valores posibles: `computer_use_preview`	Sí

OpenAI.ToolChoiceCustom

Herramienta personalizada

Use esta opción para forzar al modelo a llamar a una herramienta personalizada específica.

Nombre	Tipo	Description	Obligatorio	Predeterminado
nombre	string	Nombre de la herramienta personalizada a la que se va a llamar.	Sí
type	enum	En el caso de las llamadas a herramientas personalizadas, el tipo siempre `custom`es . Valores posibles: `custom`	Sí

OpenAI.ToolChoiceFileSearch

Indica que el modelo debe usar una herramienta integrada para generar una respuesta. Obtenga más información sobre las herramientas integradas.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Valores posibles: `file_search`	Sí

OpenAI.ToolChoiceImageGeneration

Indica que el modelo debe usar una herramienta integrada para generar una respuesta. Obtenga más información sobre las herramientas integradas.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Valores posibles: `image_generation`	Sí

OpenAI.ToolChoiceMCP

Herramienta MCP

Use esta opción para forzar al modelo a llamar a una herramienta específica en un servidor MCP remoto.

Nombre	Tipo	Description	Obligatorio
nombre	string o null		No
etiqueta del servidor	string	Etiqueta del servidor MCP que se va a usar.	Sí
type	enum	En el caso de las herramientas de MCP, el tipo siempre `mcp`es . Valores posibles: `mcp`	Sí

OpenAI.ToolChoiceParam

Cómo debe seleccionar el modelo qué herramienta (o herramientas) se van a usar al generar una respuesta. Consulte el tools parámetro para ver cómo especificar las herramientas a las que puede llamar el modelo.

Discriminador para OpenAI.ToolChoiceParam

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de 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

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ToolChoiceParamType		Sí

OpenAI.ToolChoiceParamType

Propiedad	Value
Type	string
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`

OpenAI.ToolChoiceWebSearchPreview

Nota: web_search aún no está disponible a través de Azure OpenAI.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Valores posibles: `web_search_preview`	Sí

OpenAI.ToolChoiceWebSearchPreview20250311

Indica que el modelo debe usar una herramienta integrada para generar una respuesta. Obtenga más información sobre las herramientas integradas.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Valores posibles: `web_search_preview_2025_03_11`	Sí

OpenAI.ToolType

Propiedad	Value
Type	string
Valores	`function` `file_search` `computer_use_preview` `web_search` `mcp` `code_interpreter` `image_generation` `local_shell` `shell` `custom` `web_search_preview` `apply_patch`

OpenAI.ToolsArray

Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Puede especificar qué herramienta usar estableciendo el tool_choice parámetro . Se admiten las siguientes categorías de herramientas:

Herramientas integradas: herramientas proporcionadas por OpenAI que amplían las funcionalidades del modelo, como la búsqueda web o la búsqueda de archivos. Obtenga más información sobre las herramientas integradas.
Herramientas de MCP: integraciones con sistemas de terceros a través de servidores MCP personalizados o conectores predefinidos, como Google Drive y SharePoint. Obtenga más información sobre las herramientas de MCP.
Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, lo que permite que el modelo llame a su propio código con argumentos y salidas fuertemente tipados. Aprende más sobre la llamada de funciones. También puede usar herramientas personalizadas para llamar a su propio código.

Matriz de: OpenAI.Tool

OpenAI.TopLogProb

Probabilidad logaritmética superior

La probabilidad de registro superior de un token.

Nombre	Tipo	Obligatorio
bytes	matriz de enteros	Sí
logprob	número	Sí
token	string	Sí

OpenAI.Type

Type

Acción para escribir texto.

Nombre	Tipo	Description	Obligatorio	Predeterminado
text	string	Texto que se va a escribir.	Sí
type	enum	Especifica el tipo de evento. Para una acción de tipo, esta propiedad es establezca siempre en `type`. Valores posibles: `type`	Sí	type

OpenAI.UrlCitationBody

Cita de URL

Cita de un recurso web usado para generar una respuesta de modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
end_index	integer	Índice del último carácter de la URL citada en el mensaje.	Sí
start_index	integer	Índice del primer carácter de la cita URL en un mensaje.	Sí
title	string	Título del recurso web.	Sí
type	enum	Tipo de la cita url. Siempre `url_citation`. Valores posibles: `url_citation`	Sí	url_citation
url	string (URI)	Dirección URL del recurso web.	Sí

OpenAI.VectorStoreFileAttributes

Tipo: objeto

OpenAI.Verbosity

Restringe el nivel de detalle de la respuesta del modelo. Los valores inferiores darán lugar a respuestas más concisas, mientras que los valores más altos darán lugar a respuestas más detalladas. Actualmente, los valores admitidos son low, mediumy high.

Propiedad	Value
Descripción	Restringe el nivel de detalle de la respuesta del modelo. Los valores inferiores darán lugar a respuestas más concisas, mientras que los valores más altos darán lugar a respuestas más detalladas. Actualmente, los valores admitidos son `low`, `medium`y `high`.
Type	string
Valores	`low` `medium` `high`

OpenAI.Wait

Wait

Una acción de espera.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Especifica el tipo de evento. Para una acción de espera, esta propiedad es establezca siempre en `wait`. Valores posibles: `wait`	Sí	wait

OpenAI.WebSearchActionFind

Encontrar acción

Tipo de acción "buscar": busca un patrón dentro de una página cargada.

Nombre	Tipo	Description	Obligatorio
pattern	string	Patrón o texto que se va a buscar en la página.	Sí
type	enum	Tipo de acción. Valores posibles: `find_in_page`	Sí
url	string (URI)	Dirección URL de la página en la que se busca el patrón.	Sí

OpenAI.WebSearchActionOpenPage

Acción de página abierta

Tipo de acción "open_page": abre una dirección URL específica de los resultados de la búsqueda.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de acción. Valores posibles: `open_page`	Sí
url	string (URI)	Dirección URL abierta por el modelo.	Sí

OpenAI.WebSearchActionSearch

Acción de búsqueda

Tipo de acción "search": realiza una consulta de búsqueda web.

Nombre	Tipo	Description	Obligatorio
consultas	matriz de cadenas	Consultas de búsqueda.	No
query	string (en desuso)	[EN DESUSO] Consulta de búsqueda.	Sí
orígenes	matriz de OpenAI.WebSearchActionSearchSources	Orígenes usados en la búsqueda.	No
type	enum	Tipo de acción. Valores posibles: `search`	Sí

OpenAI.WebSearchActionSearchSources

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Valores posibles: `url`	Sí
url	string		Sí

OpenAI.WebSearchApproximateLocation

Ubicación aproximada en la búsqueda web

Ubicación aproximada del usuario.

Nombre	Tipo	Description	Obligatorio	Predeterminado
ciudad	string o null		No
country	string o null		No
region	string o null		No
zona horaria	string o null		No
type	enum	Tipo de aproximación de ubicación. Siempre `approximate`. Valores posibles: `approximate`	No	Aproximado

OpenAI.WebSearchPreviewTool

Vista previa de búsqueda web

Nota: web_search aún no está disponible a través de Azure OpenAI.

Nombre	Tipo	Description	Obligatorio	Predeterminado
tamaño_del_contexto_de_búsqueda	OpenAI.SearchContextSize		No
type	enum	Tipo de la herramienta de búsqueda web. Uno de `web_search_preview` o `web_search_preview_2025_03_11`. Valores posibles: `web_search_preview`	Sí	web_search_preview
ubicación_del_usuario	OpenAI.ApproximateLocation o null		No

OpenAI.WebSearchTool

Búsqueda web

Nota: web_search aún no está disponible a través de Azure OpenAI.

Nombre	Tipo	Description	Obligatorio	Predeterminado
filtros	OpenAI.WebSearchToolFilters o null		No
tamaño_del_contexto_de_búsqueda	enum	Orientación general sobre la cantidad de espacio de ventana de contexto que se va a usar para la búsqueda. Uno de`low`, `medium` o `high`. `medium` es el valor predeterminado. Valores posibles: `low`, `medium`, `high`	No	medio
type	enum	Tipo de la herramienta de búsqueda web. Uno de `web_search` o `web_search_2025_08_26`. Valores posibles: `web_search`	Sí	búsqueda web
ubicación_del_usuario	OpenAI.WebSearchApproximateLocation o null		No

OpenAI.WebSearchToolFilters

Nombre	Tipo	Description	Obligatorio	Predeterminado
allowed_domains	matriz de cadena o null		No

Last updated on 2026-06-12