Hilos de OpenAI de Azure

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).

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 hilo

POST {endpoint}/openai/v1/threads

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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
messages	matriz de OpenAI.CreateMessageRequest	Una lista de mensajes para empezar el hilo.	No
metadatos	OpenAI.Metadata o null		No
tool_resources	OpenAI.CreateThreadRequestToolResources o null		No

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

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	No
type	string	No

Encabezados de respuesta:

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

Crear hilo y ejecutar

POST {endpoint}/openai/v1/threads/runs

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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	Predeterminado
assistant_id	string	Identificador del asistente que se va a usar para ejecutar esta ejecución.	Sí
instructions	string o null	Invalide el mensaje predeterminado del sistema del asistente. Esto resulta útil para modificar el comportamiento por ejecución.	No
max_completion_tokens	entero o null	Número máximo de tokens de finalización que se pueden usar durante el transcurso de la ejecución. La ejecución hará un mejor esfuerzo para usar solo el número de tokens de finalización especificados, en varios turnos de la ejecución. Si la ejecución supera el número de tokens de finalización especificados, la ejecución finalizará con el estado `incomplete`. Consulta `incomplete_details` para obtener más información. Restricciones: mínimo: 256	No
max_prompt_tokens	entero o null	Número máximo de tokens de solicitud que se pueden usar durante el transcurso de la ejecución. La ejecución hará un mejor esfuerzo para usar solo el número de tokens de solicitud especificados, en varios turnos de la ejecución. Si la ejecución supera el número de tokens de solicitud especificados, la ejecución finalizará con el estado `incomplete`. Consulta `incomplete_details` para obtener más información. Restricciones: mínimo: 256	No
metadatos	OpenAI.Metadata o null		No
model	string	El ID del Modelo que se va a usar para ejecutar esta ejecución. Si se proporciona un valor aquí, invalidará el modelo asociado al asistente. Si no es así, se usará el modelo asociado al asistente.	No
parallel_tool_calls	boolean	Si activar la llamada de funciones paralelas durante el uso de la herramienta.	No	True
formato_de_respuesta	OpenAI.AssistantsApiResponseFormatOption	Especifica el formato que debe generar el modelo. Compatible con GPT-4o, GPT-4 Turbo y todos los modelos GPT-3.5 Turbo desde `gpt-3.5-turbo-1106`entonces. Establecer en `{ "type": "json_schema", "json_schema": {...} }` habilita las salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON proporcionado. Más información en Establecer en `{ "type": "json_object" }` habilita el modo JSON, lo que garantiza que el mensaje que genera el modelo es JSON válido. Importante: al usar el modo JSON, también debes indicar al modelo que produzca JSON tú mismo mediante un mensaje del sistema o del usuario. Sin esto, el modelo puede generar una secuencia de espacios en blanco no deseada hasta que la generación alcance el límite de tokens, lo que da lugar a una solicitud de larga duración y aparentemente "bloqueada". Tenga en cuenta también que el contenido del mensaje puede cortarse parcialmente si `finish_reason="length"`, lo que indica que la generación superó `max_tokens` o que la conversación superó la longitud máxima del contexto.	No
stream	booleano o null	Si `true`es , devuelve una secuencia de eventos que se producen durante los eventos enviados por el servidor, finalizando cuando la ejecución entra en un estado de terminal con un `data: [DONE]` mensaje.	No
temperatura	number o null	Temperatura de muestreo que se va a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Restricciones: mínimo: 0, máximo: 2	No
hilo	OpenAI.CreateThreadRequest	Opciones para crear un nuevo subproceso. Si no se proporciona ningún subproceso al ejecutar un request, se creará un subproceso vacío.	No
tool_choice	OpenAI.AssistantsApiToolChoiceOption	Controla la herramienta a la que llama el modelo (si existe). `none` significa que el modelo no llamará a ninguna herramienta y, en su lugar, generará un mensaje. `auto` es el valor predeterminado y significa que el modelo puede elegir entre generar un mensaje o llamar a una o varias herramientas. `required` significa que el modelo debe llamar a una o varias herramientas antes de responder al usuario. Especificar una herramienta determinada como `{"type": "file_search"}` o `{"type": "function", "function": {"name": "my_function"}}` obliga al modelo a llamar a esa herramienta.	No
tool_resources	OpenAI.CreateThreadAndRunRequestToolResources o null	Conjunto de recursos que usan las herramientas del asistente. Los recursos son específicos del tipo de herramienta. Por ejemplo, la `code_interpreter` herramienta requiere una lista de identificadores de archivo, mientras que la `file_search` herramienta requiere una lista de identificadores de almacén de vectores.	No
tools	array de OpenAI.AssistantTool o null	Invalide las herramientas que el asistente puede usar para esta ejecución. Esto resulta útil para modificar el comportamiento por ejecución. Restricciones: máximo Objetos: 20	No
top_p	number o null	Alternativa al muestreo con temperatura, denominado muestreo de núcleo, donde el modelo considera los resultados de los tokens con top_p masa de probabilidad. Por lo tanto, 0,1 significa que solo se tienen en cuenta los 10 tokens que componen la masa de probabilidad superior 10%. Por lo general, se recomienda modificar esta o temperatura, pero no ambas. Restricciones: min: 0, max: 1	No
truncation_strategy	OpenAI.TruncationObject	Controla cómo se truncará un subproceso antes de la ejecución. Úselo para controlar la ventana de contexto inicial de la ejecución.	No

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

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	No
type	string	No

Encabezados de respuesta:

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

Eliminar subproceso

DELETE {endpoint}/openai/v1/threads/{thread_id}

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
thread_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	OpenAI.DeleteThreadResponse

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	No
type	string	No

Encabezados de respuesta:

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

Recuperar subproceso

GET {endpoint}/openai/v1/threads/{thread_id}

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
thread_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	OpenAI.ThreadObject

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	No
type	string	No

Encabezados de respuesta:

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

Modificar subproceso

POST {endpoint}/openai/v1/threads/{thread_id}

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
thread_id	path	Sí	string

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadatos	OpenAI.Metadata o null		No
tool_resources	OpenAI.ModifyThreadRequestToolResources o null		No

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

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	No
type	string	No

Encabezados de respuesta:

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

Enumerar mensajes

GET {endpoint}/openai/v1/threads/{thread_id}/messages

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
thread_id	path	Sí	string
limit	query	No	integer	Serialización: explotar: falso
order	query	No	string Valores posibles: `asc`, `desc`	Serialización: explotar: falso
después	query	No	string	Serialización: explotar: falso
before	query	No	string	Serialización: explotar: falso
identificador_de_ejecución	query	No	string	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.ListMessagesResponse

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	No
type	string	No

Encabezados de respuesta:

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

Crear mensaje

POST {endpoint}/openai/v1/threads/{thread_id}/messages

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
thread_id	path	Sí	string

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
datos adjuntos	matriz de OpenAI.CreateMessageRequestAttachments o null		No
contenido	cadena o matriz de OpenAI.MessageContentImageFileObject o OpenAI.MessageContentImageUrlObject o OpenAI.MessageRequestContentTextObject		Sí
metadatos	OpenAI.Metadata o null		No
role	enum	Rol de la entidad que está creando el mensaje. Los valores permitidos son: - `user`: indica que un usuario real envía el mensaje y se debe usar en la mayoría de los casos para representar mensajes generados por el usuario. - `assistant`: indica que el asistente genera el mensaje. Use este valor para insertar mensajes del asistente en la conversación. Valores posibles: `user`, `assistant`	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

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	No
type	string	No

Encabezados de respuesta:

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

Eliminar mensaje

DELETE {endpoint}/openai/v1/threads/{thread_id}/messages/{message_id}

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
thread_id	path	Sí	string
message_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	OpenAI.DeleteMessageResponse

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	No
type	string	No

Encabezados de respuesta:

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

Recuperar mensaje

GET {endpoint}/openai/v1/threads/{thread_id}/messages/{message_id}

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
thread_id	path	Sí	string
message_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	OpenAI.MessageObject

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	No
type	string	No

Encabezados de respuesta:

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

Modificar mensaje

POST {endpoint}/openai/v1/threads/{thread_id}/messages/{message_id}

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
thread_id	path	Sí	string
message_id	path	Sí	string

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadatos	OpenAI.Metadata o null		No

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

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	No
type	string	No

Encabezados de respuesta:

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

Creación de una ejecución

POST {endpoint}/openai/v1/threads/{thread_id}/runs

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
thread_id	path	Sí	string

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
additional_instructions	string o null	Anexa instrucciones adicionales al final de las instrucciones para la ejecución. Esto resulta útil para modificar el comportamiento por ejecución sin invalidar otras instrucciones.	No
additional_messages	matriz de OpenAI.CreateMessageRequest o null	Agrega mensajes adicionales al subproceso antes de crear la ejecución.	No
assistant_id	string	Identificador del asistente que se va a usar para ejecutar esta ejecución.	Sí
instructions	string o null	Invalida las instrucciones del asistente. Esto resulta útil para modificar el comportamiento por ejecución.	No
max_completion_tokens	entero o null	Número máximo de tokens de finalización que se pueden usar durante el transcurso de la ejecución. La ejecución hará un mejor esfuerzo para usar solo el número de tokens de finalización especificados, en varios turnos de la ejecución. Si la ejecución supera el número de tokens de finalización especificados, la ejecución finalizará con el estado `incomplete`. Consulta `incomplete_details` para obtener más información. Restricciones: mínimo: 256	No
max_prompt_tokens	entero o null	Número máximo de tokens de solicitud que se pueden usar durante el transcurso de la ejecución. La ejecución hará un mejor esfuerzo para usar solo el número de tokens de solicitud especificados, en varios turnos de la ejecución. Si la ejecución supera el número de tokens de solicitud especificados, la ejecución finalizará con el estado `incomplete`. Consulta `incomplete_details` para obtener más información. Restricciones: mínimo: 256	No
metadatos	OpenAI.Metadata o null		No
model	string	El ID del Modelo que se va a usar para ejecutar esta ejecución. Si se proporciona un valor aquí, invalidará el modelo asociado al asistente. Si no es así, se usará el modelo asociado al asistente.	No
parallel_tool_calls	boolean	Si activar la llamada de funciones paralelas durante el uso de la herramienta.	No	True
esfuerzo de razonamiento	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
formato_de_respuesta	OpenAI.AssistantsApiResponseFormatOption	Especifica el formato que debe generar el modelo. Compatible con GPT-4o, GPT-4 Turbo y todos los modelos GPT-3.5 Turbo desde `gpt-3.5-turbo-1106`entonces. Establecer en `{ "type": "json_schema", "json_schema": {...} }` habilita las salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON proporcionado. Más información en Establecer en `{ "type": "json_object" }` habilita el modo JSON, lo que garantiza que el mensaje que genera el modelo es JSON válido. Importante: al usar el modo JSON, también debes indicar al modelo que produzca JSON tú mismo mediante un mensaje del sistema o del usuario. Sin esto, el modelo puede generar una secuencia de espacios en blanco no deseada hasta que la generación alcance el límite de tokens, lo que da lugar a una solicitud de larga duración y aparentemente "bloqueada". Tenga en cuenta también que el contenido del mensaje puede cortarse parcialmente si `finish_reason="length"`, lo que indica que la generación superó `max_tokens` o que la conversación superó la longitud máxima del contexto.	No
stream	booleano o null	Si `true`es , devuelve una secuencia de eventos que se producen durante los eventos enviados por el servidor, finalizando cuando la ejecución entra en un estado de terminal con un `data: [DONE]` mensaje.	No
temperatura	number o null	Temperatura de muestreo que se va a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Restricciones: mínimo: 0, máximo: 2	No
tool_choice	OpenAI.AssistantsApiToolChoiceOption	Controla la herramienta a la que llama el modelo (si existe). `none` significa que el modelo no llamará a ninguna herramienta y, en su lugar, generará un mensaje. `auto` es el valor predeterminado y significa que el modelo puede elegir entre generar un mensaje o llamar a una o varias herramientas. `required` significa que el modelo debe llamar a una o varias herramientas antes de responder al usuario. Especificar una herramienta determinada como `{"type": "file_search"}` o `{"type": "function", "function": {"name": "my_function"}}` obliga al modelo a llamar a esa herramienta.	No
tools	array de OpenAI.AssistantTool o null	Invalide las herramientas que el asistente puede usar para esta ejecución. Esto resulta útil para modificar el comportamiento por ejecución. Restricciones: máximo Objetos: 20	No
top_p	number o null	Alternativa al muestreo con temperatura, denominado muestreo de núcleo, donde el modelo considera los resultados de los tokens con top_p masa de probabilidad. Por lo tanto, 0,1 significa que solo se tienen en cuenta los 10 tokens que componen la masa de probabilidad superior 10%. Por lo general, se recomienda modificar esta o temperatura, pero no ambas. Restricciones: min: 0, max: 1	No
truncation_strategy	OpenAI.TruncationObject	Controla cómo se truncará un subproceso antes de la ejecución. Úselo para controlar la ventana de contexto inicial de la ejecución.	No

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

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	No
type	string	No

Encabezados de respuesta:

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

Enumerar ejecuciones

GET {endpoint}/openai/v1/threads/{thread_id}/runs

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
thread_id	path	Sí	string
limit	query	No	integer	Serialización: explotar: falso
order	query	No	string Valores posibles: `asc`, `desc`	Serialización: explotar: falso
después	query	No	string	Serialización: explotar: falso
before	query	No	string	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.ListRunsResponse

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	No
type	string	No

Encabezados de respuesta:

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

Recuperación de la ejecución

GET {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
thread_id	path	Sí	string
identificador_de_ejecución	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	OpenAI.RunObject

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	No
type	string	No

Encabezados de respuesta:

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

Modificar ejecución

POST {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
thread_id	path	Sí	string
identificador_de_ejecución	path	Sí	string

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadatos	OpenAI.Metadata o null		No

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

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	No
type	string	No

Encabezados de respuesta:

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

Cancelar ejecución

POST {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/cancel

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
thread_id	path	Sí	string
identificador_de_ejecución	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	OpenAI.RunObject

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	No
type	string	No

Encabezados de respuesta:

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

Enumerar los pasos de ejecución

GET {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/steps

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
thread_id	path	Sí	string
identificador_de_ejecución	path	Sí	string
limit	query	No	integer	Serialización: explotar: falso
order	query	No	string Valores posibles: `asc`, `desc`	Serialización: explotar: falso
después	query	No	string	Serialización: explotar: falso
before	query	No	string	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.ListRunStepsResponse

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	No
type	string	No

Encabezados de respuesta:

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

Obtener paso de ejecución

GET {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
thread_id	path	Sí	string
identificador_de_ejecución	path	Sí	string
step_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	OpenAI.RunStepObject

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	No
type	string	No

Encabezados de respuesta:

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

Envío de salidas de herramientas para ejecutar

POST {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/submit_tool_outputs

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
thread_id	path	Sí	string
identificador_de_ejecución	path	Sí	string

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
stream	booleano o null		No
tool_outputs	matriz de OpenAI.SubmitToolOutputsRunRequestToolOutputs	Lista de herramientas para las que se envían las salidas.	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

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	No
type	string	No

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`

OpenAI.AssistantTool

Discriminador para OpenAI.AssistantTool

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

Tipo de valor	Schema
`code_interpreter`	OpenAI.AssistantToolsCode
`file_search`	OpenAI.AssistantToolsFileSearch
`function`	OpenAI.AssistantToolsFunction

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.AssistantToolType		Sí

OpenAI.AssistantToolType

Propiedad	Value
Type	string
Valores	`code_interpreter` `file_search` `function`

OpenAI.AssistantToolsCode

Herramienta de intérprete de código

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de herramienta que se va a definir: `code_interpreter` Valores posibles: `code_interpreter`	Sí

OpenAI.AssistantToolsFileSearch

Herramienta FileSearch

Nombre	Tipo	Description	Obligatorio
file_search	OpenAI.AssistantToolsFileSearchFileSearch		No
└─ max_num_results	integer	Restricciones: min: 1, max: 50	No
└" ranking_options	OpenAI.FileSearchRankingOptions	Las opciones de clasificación de la búsqueda de archivos. Si no se especifica, la herramienta de búsqueda de archivos usará el `auto` clasificador y un score_threshold de 0.	No
type	enum	Tipo de herramienta que se va a definir: `file_search` Valores posibles: `file_search`	Sí

OpenAI.AssistantToolsFileSearchFileSearch

Nombre	Tipo	Description	Obligatorio	Predeterminado
número_máximo_de_resultados	integer	Restricciones: min: 1, max: 50	No
opciones_de_clasificación	OpenAI.FileSearchRankingOptions	Las opciones de clasificación de la búsqueda de archivos. Si no se especifica, la herramienta de búsqueda de archivos usará el `auto` clasificador y un score_threshold de 0.	No

OpenAI.AssistantToolsFileSearchTypeOnly

Herramienta FileSearch

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de herramienta que se va a definir: `file_search` Valores posibles: `file_search`	Sí

OpenAI.AssistantToolsFunction

Herramienta de función

Nombre	Tipo	Description	Obligatorio	Predeterminado
function	OpenAI.FunctionObject		Sí
type	enum	Tipo de herramienta que se va a definir: `function` Valores posibles: `function`	Sí

OpenAI.AssistantsApiResponseFormatOption

Especifica el formato que debe generar el modelo. Compatible con GPT-4o, GPT-4 Turbo y todos los modelos GPT-3.5 Turbo desde gpt-3.5-turbo-1106entonces. Establecer en { "type": "json_schema", "json_schema": {...} } habilita las salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON proporcionado. Obtenga más información en Configuración para { "type": "json_object" } habilitar el modo JSON, lo que garantiza que el mensaje que genera el modelo sea JSON válido. Importante: al usar el modo JSON, también debes indicar al modelo que produzca JSON tú mismo mediante un mensaje del sistema o del usuario. Sin esto, el modelo puede generar una secuencia de espacios en blanco no deseada hasta que la generación alcance el límite de tokens, lo que da lugar a una solicitud de larga duración y aparentemente "bloqueada". Tenga en cuenta también que el contenido del mensaje puede cortarse parcialmente si finish_reason="length", lo que indica que la generación superó max_tokens o que la conversación superó la longitud máxima del contexto.

Este componente puede ser uno de los siguientes:

cuerda: auto
OpenAI.ResponseFormatText
OpenAI.ResponseFormatJsonObject
OpenAI.ResponseFormatJsonSchema

OpenAI.AssistantsApiToolChoiceOption

Controla la herramienta a la que llama el modelo (si existe). none significa que el modelo no llamará a ninguna herramienta y, en su lugar, generará un mensaje. auto es el valor predeterminado y significa que el modelo puede elegir entre generar un mensaje o llamar a una o varias herramientas. required significa que el modelo debe llamar a una o varias herramientas antes de responder al usuario. Especificar una herramienta determinada como {"type": "file_search"} o {"type": "function", "function": {"name": "my_function"}} obliga al modelo a llamar a esa herramienta.

Este componente puede ser uno de los siguientes:

Cadena: none, auto, required
OpenAI.AsistentesElecciónDeHerramientaNombrada

OpenAI.AssistantsNamedToolChoice

Especifica una herramienta que debe usar el modelo. Use para forzar al modelo a llamar a una herramienta específica.

Nombre	Tipo	Description	Obligatorio	Predeterminado
function	OpenAI.AssistantsNamedToolChoiceFunction		No
type	enum	Tipo de la herramienta. Si el tipo es `function`, el nombre de la función debe establecerse. Valores posibles: `function`, `code_interpreter`, `file_search`	Sí

OpenAI.AssistantsNamedToolChoiceFunction

Nombre	Tipo	Description	Obligatorio	Predeterminado
nombre	string		Sí

OpenAI.CreateChatCompletionRequestResponseFormat

Objeto que especifica el formato que debe generar el modelo. Establecer en { "type": "json_schema", "json_schema": {...} } habilita las salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON proporcionado. Aprende más en la guía de Salidas Estructuradas. Establecer en { "type": "json_object" } habilita el modo JSON anterior, lo que garantiza que el mensaje que genera el modelo sea JSON válido. Se prefiere usar json_schema para los modelos que lo admiten.

Discriminador para OpenAI.CreateChatCompletionRequestResponseFormat

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

Tipo de valor	Schema
`json_schema`	OpenAI.ResponseFormatJsonSchema
`text`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
`json_object`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.CreateChatCompletionRequestResponseFormatType		Sí

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

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

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

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

OpenAI.CreateMessageRequest

Nombre	Tipo	Description	Obligatorio
datos adjuntos	matriz de OpenAI.CreateMessageRequestAttachments o null		No
contenido	cadena o matriz de OpenAI.MessageContentImageFileObject o OpenAI.MessageContentImageUrlObject o OpenAI.MessageRequestContentTextObject		Sí
metadatos	OpenAI.Metadata o null		No
role	enum	Rol de la entidad que está creando el mensaje. Los valores permitidos son: - `user`: indica que un usuario real envía el mensaje y se debe usar en la mayoría de los casos para representar mensajes generados por el usuario. - `assistant`: indica que el asistente genera el mensaje. Use este valor para insertar mensajes del asistente en la conversación. Valores posibles: `user`, `assistant`	Sí

OpenAI.CreateMessageRequestAttachments

Nombre	Tipo	Description	Obligatorio	Predeterminado
ID del archivo	string		No
tools	matriz de OpenAI.AssistantToolsCode o OpenAI.AssistantToolsFileSearchTypeOnly		No

OpenAI.CreateRunRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
additional_instructions	string o null	Anexa instrucciones adicionales al final de las instrucciones para la ejecución. Esto resulta útil para modificar el comportamiento por ejecución sin invalidar otras instrucciones.	No
additional_messages	matriz de OpenAI.CreateMessageRequest o null	Agrega mensajes adicionales al subproceso antes de crear la ejecución.	No
assistant_id	string	Identificador del asistente que se va a usar para ejecutar esta ejecución.	Sí
instructions	string o null	Invalida las instrucciones del asistente. Esto resulta útil para modificar el comportamiento por ejecución.	No
max_completion_tokens	entero o null	Número máximo de tokens de finalización que se pueden usar durante el transcurso de la ejecución. La ejecución hará un mejor esfuerzo para usar solo el número de tokens de finalización especificados, en varios turnos de la ejecución. Si la ejecución supera el número de tokens de finalización especificados, la ejecución finalizará con el estado `incomplete`. Consulta `incomplete_details` para obtener más información. Restricciones: mínimo: 256	No
max_prompt_tokens	entero o null	Número máximo de tokens de solicitud que se pueden usar durante el transcurso de la ejecución. La ejecución hará un mejor esfuerzo para usar solo el número de tokens de solicitud especificados, en varios turnos de la ejecución. Si la ejecución supera el número de tokens de solicitud especificados, la ejecución finalizará con el estado `incomplete`. Consulta `incomplete_details` para obtener más información. Restricciones: mínimo: 256	No
metadatos	OpenAI.Metadata o null		No
model	string	El ID del Modelo que se va a usar para ejecutar esta ejecución. Si se proporciona un valor aquí, invalidará el modelo asociado al asistente. Si no es así, se usará el modelo asociado al asistente.	No
parallel_tool_calls	boolean	Si activar la llamada de funciones paralelas durante el uso de la herramienta.	No	True
esfuerzo de razonamiento	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
formato_de_respuesta	OpenAI.AssistantsApiResponseFormatOption	Especifica el formato que debe generar el modelo. Compatible con GPT-4o, GPT-4 Turbo y todos los modelos GPT-3.5 Turbo desde `gpt-3.5-turbo-1106`entonces. Establecer en `{ "type": "json_schema", "json_schema": {...} }` habilita las salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON proporcionado. Más información en Establecer en `{ "type": "json_object" }` habilita el modo JSON, lo que garantiza que el mensaje que genera el modelo es JSON válido. Importante: al usar el modo JSON, también debes indicar al modelo que produzca JSON tú mismo mediante un mensaje del sistema o del usuario. Sin esto, el modelo puede generar una secuencia de espacios en blanco no deseada hasta que la generación alcance el límite de tokens, lo que da lugar a una solicitud de larga duración y aparentemente "bloqueada". Tenga en cuenta también que el contenido del mensaje puede cortarse parcialmente si `finish_reason="length"`, lo que indica que la generación superó `max_tokens` o que la conversación superó la longitud máxima del contexto.	No
stream	booleano o null	Si `true`es , devuelve una secuencia de eventos que se producen durante los eventos enviados por el servidor, finalizando cuando la ejecución entra en un estado de terminal con un `data: [DONE]` mensaje.	No
temperatura	number o null	Temperatura de muestreo que se va a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Restricciones: mínimo: 0, máximo: 2	No
tool_choice	OpenAI.AssistantsApiToolChoiceOption	Controla la herramienta a la que llama el modelo (si existe). `none` significa que el modelo no llamará a ninguna herramienta y, en su lugar, generará un mensaje. `auto` es el valor predeterminado y significa que el modelo puede elegir entre generar un mensaje o llamar a una o varias herramientas. `required` significa que el modelo debe llamar a una o varias herramientas antes de responder al usuario. Especificar una herramienta determinada como `{"type": "file_search"}` o `{"type": "function", "function": {"name": "my_function"}}` obliga al modelo a llamar a esa herramienta.	No
tools	array de OpenAI.AssistantTool o null	Invalide las herramientas que el asistente puede usar para esta ejecución. Esto resulta útil para modificar el comportamiento por ejecución. Restricciones: máximo Objetos: 20	No
top_p	number o null	Alternativa al muestreo con temperatura, denominado muestreo de núcleo, donde el modelo considera los resultados de los tokens con top_p masa de probabilidad. Por lo tanto, 0,1 significa que solo se tienen en cuenta los 10 tokens que componen la masa de probabilidad superior 10%. Por lo general, se recomienda modificar esta o temperatura, pero no ambas. Restricciones: min: 0, max: 1	No
truncation_strategy	OpenAI.TruncationObject	Controla cómo se truncará un subproceso antes de la ejecución. Úselo para controlar la ventana de contexto inicial de la ejecución.	No

OpenAI.CreateThreadAndRunRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
assistant_id	string	Identificador del asistente que se va a usar para ejecutar esta ejecución.	Sí
instructions	string o null	Invalide el mensaje predeterminado del sistema del asistente. Esto resulta útil para modificar el comportamiento por ejecución.	No
max_completion_tokens	entero o null	Número máximo de tokens de finalización que se pueden usar durante el transcurso de la ejecución. La ejecución hará un mejor esfuerzo para usar solo el número de tokens de finalización especificados, en varios turnos de la ejecución. Si la ejecución supera el número de tokens de finalización especificados, la ejecución finalizará con el estado `incomplete`. Consulta `incomplete_details` para obtener más información. Restricciones: mínimo: 256	No
max_prompt_tokens	entero o null	Número máximo de tokens de solicitud que se pueden usar durante el transcurso de la ejecución. La ejecución hará un mejor esfuerzo para usar solo el número de tokens de solicitud especificados, en varios turnos de la ejecución. Si la ejecución supera el número de tokens de solicitud especificados, la ejecución finalizará con el estado `incomplete`. Consulta `incomplete_details` para obtener más información. Restricciones: mínimo: 256	No
metadatos	OpenAI.Metadata o null		No
model	string	El ID del Modelo que se va a usar para ejecutar esta ejecución. Si se proporciona un valor aquí, invalidará el modelo asociado al asistente. Si no es así, se usará el modelo asociado al asistente.	No
parallel_tool_calls	boolean	Si activar la llamada de funciones paralelas durante el uso de la herramienta.	No	True
formato_de_respuesta	OpenAI.AssistantsApiResponseFormatOption	Especifica el formato que debe generar el modelo. Compatible con GPT-4o, GPT-4 Turbo y todos los modelos GPT-3.5 Turbo desde `gpt-3.5-turbo-1106`entonces. Establecer en `{ "type": "json_schema", "json_schema": {...} }` habilita las salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON proporcionado. Más información en Establecer en `{ "type": "json_object" }` habilita el modo JSON, lo que garantiza que el mensaje que genera el modelo es JSON válido. Importante: al usar el modo JSON, también debes indicar al modelo que produzca JSON tú mismo mediante un mensaje del sistema o del usuario. Sin esto, el modelo puede generar una secuencia de espacios en blanco no deseada hasta que la generación alcance el límite de tokens, lo que da lugar a una solicitud de larga duración y aparentemente "bloqueada". Tenga en cuenta también que el contenido del mensaje puede cortarse parcialmente si `finish_reason="length"`, lo que indica que la generación superó `max_tokens` o que la conversación superó la longitud máxima del contexto.	No
stream	booleano o null	Si `true`es , devuelve una secuencia de eventos que se producen durante los eventos enviados por el servidor, finalizando cuando la ejecución entra en un estado de terminal con un `data: [DONE]` mensaje.	No
temperatura	number o null	Temperatura de muestreo que se va a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Restricciones: mínimo: 0, máximo: 2	No
hilo	OpenAI.CreateThreadRequest	Opciones para crear un nuevo subproceso. Si no se proporciona ningún subproceso al ejecutar un request, se creará un subproceso vacío.	No
tool_choice	OpenAI.AssistantsApiToolChoiceOption	Controla la herramienta a la que llama el modelo (si existe). `none` significa que el modelo no llamará a ninguna herramienta y, en su lugar, generará un mensaje. `auto` es el valor predeterminado y significa que el modelo puede elegir entre generar un mensaje o llamar a una o varias herramientas. `required` significa que el modelo debe llamar a una o varias herramientas antes de responder al usuario. Especificar una herramienta determinada como `{"type": "file_search"}` o `{"type": "function", "function": {"name": "my_function"}}` obliga al modelo a llamar a esa herramienta.	No
tool_resources	OpenAI.CreateThreadAndRunRequestToolResources o null	Conjunto de recursos que usan las herramientas del asistente. Los recursos son específicos del tipo de herramienta. Por ejemplo, la `code_interpreter` herramienta requiere una lista de identificadores de archivo, mientras que la `file_search` herramienta requiere una lista de identificadores de almacén de vectores.	No
tools	array de OpenAI.AssistantTool o null	Invalide las herramientas que el asistente puede usar para esta ejecución. Esto resulta útil para modificar el comportamiento por ejecución. Restricciones: máximo Objetos: 20	No
top_p	number o null	Alternativa al muestreo con temperatura, denominado muestreo de núcleo, donde el modelo considera los resultados de los tokens con top_p masa de probabilidad. Por lo tanto, 0,1 significa que solo se tienen en cuenta los 10 tokens que componen la masa de probabilidad superior 10%. Por lo general, se recomienda modificar esta o temperatura, pero no ambas. Restricciones: min: 0, max: 1	No
truncation_strategy	OpenAI.TruncationObject	Controla cómo se truncará un subproceso antes de la ejecución. Úselo para controlar la ventana de contexto inicial de la ejecución.	No

OpenAI.CreateThreadAndRunRequestToolResources

Nombre	Tipo	Description	Obligatorio	Predeterminado
code_interpreter	OpenAI.CreateThreadAndRunRequestToolResourcesCodeInterpreter		No
file_search	OpenAI.CreateThreadAndRunRequestToolResourcesFileSearch		No

OpenAI.CreateThreadAndRunRequestToolResourcesCodeInterpreter

Nombre	Tipo	Description	Obligatorio	Predeterminado
identificadores de archivos	matriz de cadenas	Restricciones: máximo Objetos: 20	No	[]

OpenAI.CreateThreadAndRunRequestToolResourcesFileSearch

Nombre	Tipo	Description	Obligatorio	Predeterminado
vector_store_ids	matriz de cadenas	Restricciones: maxItems: 1	No

OpenAI.CreateThreadRequest

Opciones para crear un nuevo subproceso. Si no se proporciona ningún subproceso al ejecutar una solicitud, se creará un subproceso vacío.

Nombre	Tipo	Description	Obligatorio
messages	matriz de OpenAI.CreateMessageRequest	Una lista de mensajes para empezar el hilo.	No
metadatos	OpenAI.Metadata o null		No
tool_resources	OpenAI.CreateThreadRequestToolResources o null		No

OpenAI.CreateThreadRequestToolResources

Nombre	Tipo	Description	Obligatorio	Predeterminado
code_interpreter	OpenAI.CreateThreadRequestToolResourcesCodeInterpreter		No
file_search	OpenAI.CreaHilaSolicitudHerramientaRecursosBuscafileSearch		No

OpenAI.CreateThreadRequestToolResourcesCodeInterpreter

Nombre	Tipo	Description	Obligatorio	Predeterminado
identificadores de archivos	matriz de cadenas	Restricciones: máximo Objetos: 20	No

OpenAI.CreaHilaSolicitudHerramientaRecursosBuscafileSearch

Nombre	Tipo	Description	Obligatorio	Predeterminado
vector_store_ids	matriz de cadenas	Restricciones: maxItems: 1	No
vector_stores	array de OpenAI.CrearHilosSolicitudHerramientaRecursosArchivoBuscaVectorAlmacenajes	Restricciones: maxItems: 1	No

OpenAI.CrearHiloSolicitudHerramientaRecursosArchivoBuscaVectorAlmacenes

Nombre	Tipo	Description	Obligatorio
chunking_strategy	OpenAI.CrearhiloSolicitudHerramientaRecursosArchivoBúsquedaVectorAlmacenesChunkingEstrategiaAuto o OpenAI.CrearThreadRequestToolRecursosArchivoBuscaVectorAlmacenesChunkingEstrategiaEstático		No
identificadores de archivos	matriz de cadenas	Restricciones: maxObjetos: 100000000	No
metadatos	OpenAI.Metadata o null		No

OpenAI.CrearhiloSolicitudHerramientaRecursosArchivoBuscaVectorAlmacenesChunkingEstrategiaAuto

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

OpenAI.CrearhiloSolicitudHerramientaRecursosArchivoBuscaVectorAlmacenesChunkingEstrategiaEstático

Nombre	Tipo	Description	Obligatorio	Predeterminado
estático	OpenAI.CrearhiloSolicitudHerramientaRecursosArchivoBuscaVectorAlmacenamientoChunkingEstrategiaEstáticoEstático		Sí
type	enum	Valores posibles: `static`	Sí

OpenAI.CrearhiloSolicitudHerramientaRecursosArchivoBuscaVectorAlmacenamientoChunkingEstrategiaEstáticoEstático

Nombre	Tipo	Description	Obligatorio	Predeterminado
chunk_overlap_tokens	integer		Sí
max_chunk_size_tokens	integer	Restricciones: min: 100, max: 4096	Sí

OpenAI.DeleteMessageResponse

Nombre	Tipo	Description	Obligatorio
eliminado	boolean		Sí
id	string		Sí
object	enum	Valores posibles: `thread.message.deleted`	Sí

OpenAI.DeleteThreadResponse

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

OpenAI.FileSearchRanker

Clasificador que se va a usar para la búsqueda de archivos. Si no se especifica, usará el auto clasificador.

Propiedad	Value
Type	string
Valores	`auto` `default_2024_08_21`

OpenAI.FileSearchRankingOptions

Opciones de clasificación de llamadas a la herramienta de búsqueda de archivos

Las opciones de clasificación de la búsqueda de archivos. Si no se especifica, la herramienta de búsqueda de archivos usará el auto clasificador y un score_threshold de 0.

Nombre	Tipo	Description	Obligatorio	Predeterminado
clasificador	OpenAI.FileSearchRanker	Clasificador que se va a usar para la búsqueda de archivos. Si no se especifica, usará el `auto` clasificador.	No
umbral de puntuación	número	Umbral de puntuación para la búsqueda de archivos. Todos los valores deben ser un número de punto flotante entre 0 y 1. Restricciones: min: 0, max: 1	Sí

OpenAI.FunctionObject

Nombre	Tipo	Description	Obligatorio
description	string	Descripción de lo que hace la función, que usa el modelo para elegir cuándo y cómo llamar a la función.	No
nombre	string	El nombre de la función que se llamará. Debe ser a-z, A-Z, 0-9, o contener caracteres de subrayado y guiones, con una longitud máxima de 64.	Sí
parameters	OpenAI.FunctionParameters	Los parámetros que aceptan las funciones, que se describen como un objeto de esquema JSON. Consulta la referencia del esquema JSON para documentación sobre el formato. La omisión `parameters` define una función con una lista de parámetros vacía.	No
strict	booleano o null		No

OpenAI.FunctionParameters

Los parámetros que aceptan las funciones, que se describen como un objeto de esquema JSON. Consulta la referencia del esquema JSON para documentación sobre el formato. La omisión parameters define una función con una lista de parámetros vacía.

Tipo: objeto

OpenAI.ListMessagesResponse

Nombre	Tipo	Obligatorio
data	matriz de OpenAI.MessageObject	Sí
first_id	string	Sí
has_more	boolean	Sí
last_id	string	Sí
object	string	Sí

OpenAI.ListRunStepsResponse

Nombre	Tipo	Obligatorio
data	matriz de OpenAI.RunStepObject	Sí
first_id	string	Sí
has_more	boolean	Sí
last_id	string	Sí
object	string	Sí

OpenAI.ListRunsResponse

Nombre	Tipo	Obligatorio
data	matriz de OpenAI.RunObject	Sí
first_id	string	Sí
has_more	boolean	Sí
last_id	string	Sí
object	string	Sí

OpenAI.MessageContentImageFileObject

Archivo de imagen

Referencia a un archivo de imagen en el contenido de un mensaje.

Nombre	Tipo	Description	Obligatorio	Predeterminado
image_file	OpenAI.MessageContentImageFileObjectImageFile		Sí
type	enum	Siempre `image_file`. Valores posibles: `image_file`	Sí

OpenAI.MessageContentImageFileObjectImageFile

Nombre	Tipo	Description	Obligatorio	Predeterminado
detail	enum	Valores posibles: `auto`, `low`, `high`	No	auto
ID del archivo	string		Sí

OpenAI.MessageContentImageUrlObject

Dirección URL de la imagen

Hace referencia a una dirección URL de imagen en el contenido de un mensaje.

Nombre	Tipo	Description	Obligatorio	Predeterminado
image_url	OpenAI.MessageContentImageUrlObjectImageUrl		Sí
type	enum	Tipo del elemento de contenido. Valores posibles: `image_url`	Sí

OpenAI.MessageContentImageUrlObjectImageUrl

Nombre	Tipo	Description	Obligatorio	Predeterminado
detail	enum	Valores posibles: `auto`, `low`, `high`	No	auto
url	string (URI)		Sí

OpenAI.MessageContentRefusalObject

Refusal

Contenido de denegación generado por el asistente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
refusal	string		Sí
type	enum	Siempre `refusal`. Valores posibles: `refusal`	Sí

OpenAI.MessageContentTextAnnotationsFileCitationObject

Cita del archivo

Cita dentro del mensaje que apunta a una cita específica de un archivo específico asociado al asistente o al mensaje. Se genera cuando el asistente usa la herramienta "file_search" para buscar archivos.

Nombre	Tipo	Description	Obligatorio
end_index	integer	Restricciones: min: 0	Sí
file_citation	OpenAI.MessageContentTextAnnotationsFileCitationObjectCitation		Sí
start_index	integer	Restricciones: min: 0	Sí
text	string	Texto del contenido del mensaje que debe reemplazarse.	Sí
type	enum	Siempre `file_citation`. Valores posibles: `file_citation`	Sí

OpenAI.MessageContentTextAnnotationsFileCitationObjectCitation

Nombre	Tipo	Description	Obligatorio	Predeterminado
ID del archivo	string		Sí

OpenAI.MessageContentTextAnnotationsFilePathObject

Ruta de acceso del archivo

Dirección URL del archivo que se genera cuando el asistente usó la code_interpreter herramienta para generar un archivo.

Nombre	Tipo	Description	Obligatorio
end_index	integer	Restricciones: min: 0	Sí
file_path	OpenAI.MessageContentTextAnnotationsFilePathObjectFilePath		Sí
start_index	integer	Restricciones: min: 0	Sí
text	string	Texto del contenido del mensaje que debe reemplazarse.	Sí
type	enum	Siempre `file_path`. Valores posibles: `file_path`	Sí

OpenAI.MessageContentTextAnnotationsFilePathObjectFilePath

Nombre	Tipo	Description	Obligatorio	Predeterminado
ID del archivo	string		Sí

OpenAI.MessageContentTextObject

Text

Contenido de texto que forma parte de un mensaje.

Nombre	Tipo	Description	Obligatorio	Predeterminado
text	OpenAI.MessageContentTextObjectText		Sí
type	enum	Siempre `text`. Valores posibles: `text`	Sí

OpenAI.MessageContentTextObjectText

Nombre	Tipo	Description	Obligatorio	Predeterminado
annotations	matriz de OpenAI.TextAnnotation		Sí
value	string		Sí

OpenAI.MessageObject

El objeto mensaje

Representa un mensaje dentro de un hilo.

Nombre	Tipo	Description	Obligatorio
assistant_id	string o null		Sí
datos adjuntos	matriz de OpenAI.MessageObjectAttachments o null		Sí
completado_en	string o null		Sí
contenido	array de OpenAI.MessageObjectContent	Contenido del mensaje en matriz de texto o imágenes.	Sí
fecha_de_creación	entero (unixtime)	Marca de tiempo de Unix (en segundos) para cuando se creó el mensaje.	Sí
id	string	Identificador al que se puede hacer referencia en puntos de conexión de API.	Sí
incomplete_at	string o null		Sí
incomplete_details	OpenAI.MessageObjectIncompleteDetails o null		Sí
metadatos	OpenAI.Metadata o null		Sí
object	enum	Tipo de objeto, que siempre `thread.message`es . Valores posibles: `thread.message`	Sí
role	enum	Entidad que generó el mensaje. Uno de `user` o `assistant`. Valores posibles: `user`, `assistant`	Sí
identificador_de_ejecución	string o null		Sí
status	enum	Estado del mensaje, que puede ser `in_progress`, `incomplete`o `completed`. Valores posibles: `in_progress`, `incomplete`, `completed`	Sí
thread_id	string	El ID del hilo al que pertenece este mensaje.	Sí

OpenAI.MessageObjectAttachments

Nombre	Tipo	Description	Obligatorio	Predeterminado
ID del archivo	string		No
tools	matriz de OpenAI.AssistantToolsCode o OpenAI.AssistantToolsFileSearchTypeOnly		No

OpenAI.MessageObjectContent

Discriminador para OpenAI.MessageObjectContent

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

Tipo de valor	Schema
`image_url`	OpenAI.MessageContentImageUrlObject
`text`	OpenAI.MessageContentTextObject
`refusal`	OpenAI.MessageContentRefusalObject
`image_file`	OpenAI.MessageContentImageFileObject

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.MessageObjectContentType		Sí

OpenAI.MessageObjectContentType

Propiedad	Value
Type	string
Valores	`image_file` `image_url` `text` `refusal`

OpenAI.MessageObjectIncompleteDetails

Nombre	Tipo	Description	Obligatorio	Predeterminado
razón	enum	Valores posibles: `content_filter`, `max_tokens`, `run_cancelled`, , `run_expired`, `run_failed`	Sí

OpenAI.MessageRequestContentTextObject

Text

Contenido de texto que forma parte de un mensaje.

Nombre	Tipo	Description	Obligatorio	Predeterminado
text	string	Contenido de texto que se va a enviar al modelo	Sí
type	enum	Siempre `text`. Valores posibles: `text`	Sí

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadatos	OpenAI.Metadata o null		No

OpenAI.ModifyRunRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadatos	OpenAI.Metadata o null		No

OpenAI.ModifyThreadRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadatos	OpenAI.Metadata o null		No
tool_resources	OpenAI.ModifyThreadRequestToolResources o null		No

OpenAI.ModifyThreadRequestToolResources

Nombre	Tipo	Description	Obligatorio	Predeterminado
code_interpreter	OpenAI.ModifyThreadRequestToolResourcesCodeInterpreter		No
file_search	OpenAI.ModifyThreadRequestToolResourcesFileSearch		No

OpenAI.ModifyThreadRequestToolResourcesCodeInterpreter

Nombre	Tipo	Description	Obligatorio	Predeterminado
identificadores de archivos	matriz de cadenas	Restricciones: máximo Objetos: 20	No

OpenAI.ModifyThreadRequestToolResourcesFileSearch

Nombre	Tipo	Description	Obligatorio	Predeterminado
vector_store_ids	matriz de cadenas	Restricciones: maxItems: 1	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 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 .
Type	string
Valores	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ResponseFormatJsonObject

Objeto JSON

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

Esquema JSON

Formato de respuesta del esquema JSON. Se usa para generar respuestas JSON estructuradas.

Nombre	Tipo	Description	Obligatorio
json_schema	OpenAI.ResponseFormatJsonSchemaJsonSchema		Sí
└─ Descripción	string		No
└─ Nombre	string		Sí
└─ Esquema	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í.	No
└─ estricto	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.ResponseFormatJsonSchemaJsonSchema

Nombre	Tipo	Description	Obligatorio
description	string		No
nombre	string		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í.	No
strict	booleano o null		No

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

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

Estadísticas de uso relacionadas con la ejecución. Este valor será null si la ejecución no está en un estado terminal (es decir in_progress, , queued, etc.).

Nombre	Tipo	Description	Obligatorio
completion_tokens	integer	Número de tokens de finalización usados durante la ejecución.	Sí
prompt_tokens	integer	Número de tokens de solicitud usados durante la ejecución.	Sí
total_tokens	integer	Número total de tokens usados (símbolo del sistema y finalización).	Sí

OpenAI.RunObject

Una carrera en un hilo

Representa una ejecución en un hilo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
assistant_id	string	Identificador del asistente usado para la ejecución de esta ejecución.	Sí
fecha_de_cancelación	string o null	Marca de tiempo de Unix (en segundos) para cuando se canceló la ejecución.	Sí
completado_en	string o null	Marca de tiempo de Unix (en segundos) para cuando se completó la ejecución.	Sí
fecha_de_creación	entero (unixtime)	Marca de tiempo de Unix (en segundos) para cuando se creó la ejecución.	Sí
expires_at	string o null	Marca de tiempo de Unix (en segundos) para cuando expire la ejecución.	Sí
failed_at	string o null	Marca de tiempo de Unix (en segundos) para cuando se produjo un error en la ejecución.	Sí
id	string	Identificador al que se puede hacer referencia en puntos de conexión de API.	Sí
incomplete_details	OpenAI.RunObjectIncompleteDetails o null	Detalles sobre por qué la ejecución está incompleta. `null` Será si la ejecución no está incompleta.	Sí
instructions	string	Las instrucciones que el asistente usó para esta ejecución.	Sí
last_error	OpenAI.RunObjectLastError o null	El último error asociado a esta ejecución. `null` Será si no hay errores.	Sí
max_completion_tokens	entero o null	Número máximo de tokens de finalización especificados que se usaron durante el transcurso de la ejecución. Restricciones: mínimo: 256	Sí
max_prompt_tokens	entero o null	Número máximo de tokens de solicitud especificados que se usaron durante el transcurso de la ejecución. Restricciones: mínimo: 256	Sí
metadatos	OpenAI.Metadata o null		Sí
model	string	El modelo que el asistente usó para esta ejecución.	Sí
object	enum	Tipo de objeto, que siempre `thread.run`es . Valores posibles: `thread.run`	Sí
parallel_tool_calls	boolean	Si activar la llamada de funciones paralelas durante el uso de la herramienta.	Sí	True
required_action	OpenAI.RunObjectRequiredAction o null	Detalles sobre la acción necesaria para continuar la ejecución. `null` Será si no se requiere ninguna acción.	Sí
formato_de_respuesta	OpenAI.AssistantsApiResponseFormatOption	Especifica el formato que debe generar el modelo. Compatible con GPT-4o, GPT-4 Turbo y todos los modelos GPT-3.5 Turbo desde `gpt-3.5-turbo-1106`entonces. Establecer en `{ "type": "json_schema", "json_schema": {...} }` habilita las salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON proporcionado. Más información en Establecer en `{ "type": "json_object" }` habilita el modo JSON, lo que garantiza que el mensaje que genera el modelo es JSON válido. Importante: al usar el modo JSON, también debes indicar al modelo que produzca JSON tú mismo mediante un mensaje del sistema o del usuario. Sin esto, el modelo puede generar una secuencia de espacios en blanco no deseada hasta que la generación alcance el límite de tokens, lo que da lugar a una solicitud de larga duración y aparentemente "bloqueada". Tenga en cuenta también que el contenido del mensaje puede cortarse parcialmente si `finish_reason="length"`, lo que indica que la generación superó `max_tokens` o que la conversación superó la longitud máxima del contexto.	Sí
started_at	string o null	Marca de tiempo de Unix (en segundos) para cuando se inició la ejecución.	Sí
status	OpenAI.RunStatus	Estado de la ejecución, que puede ser `queued`, , `in_progressrequires_actioncancellingcancelledfailed`, , `completed`, `incomplete`o .`expired`	Sí
temperatura	number o null	Temperatura de muestreo utilizada para esta ejecución. Si no se establece, el valor predeterminado es 1.	No
thread_id	string	Identificador del subproceso en el que se ejecutó como parte de esta ejecución.	Sí
tool_choice	OpenAI.AssistantsApiToolChoiceOption	Controla la herramienta a la que llama el modelo (si existe). `none` significa que el modelo no llamará a ninguna herramienta y, en su lugar, generará un mensaje. `auto` es el valor predeterminado y significa que el modelo puede elegir entre generar un mensaje o llamar a una o varias herramientas. `required` significa que el modelo debe llamar a una o varias herramientas antes de responder al usuario. Especificar una herramienta determinada como `{"type": "file_search"}` o `{"type": "function", "function": {"name": "my_function"}}` obliga al modelo a llamar a esa herramienta.	Sí
tools	matriz de OpenAI.AssistantTool	Lista de herramientas que el asistente usó para esta ejecución. Restricciones: máximo Objetos: 20	Sí	[]
top_p	number o null	Valor de muestreo de núcleo utilizado para esta ejecución. Si no se establece, el valor predeterminado es 1.	No
truncation_strategy	OpenAI.TruncationObject	Controla cómo se truncará un subproceso antes de la ejecución. Úselo para controlar la ventana de contexto inicial de la ejecución.	Sí
uso	OpenAI.RunCompletionUsage o null		Sí

OpenAI.RunObjectIncompleteDetails

Nombre	Tipo	Description	Obligatorio	Predeterminado
razón	enum	Valores posibles: `max_completion_tokens`, `max_prompt_tokens`	No

OpenAI.RunObjectLastError

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	enum	Valores posibles: `server_error`, `rate_limit_exceeded`, `invalid_prompt`	Sí
message	string		Sí

OpenAI.RunObjectRequiredAction

Nombre	Tipo	Description	Obligatorio	Predeterminado
submit_tool_outputs	OpenAI.RunObjectRequiredActionSubmitToolOutputs		Sí
type	enum	Valores posibles: `submit_tool_outputs`	Sí

OpenAI.RunObjectRequiredActionSubmitToolOutputs

Nombre	Tipo	Description	Obligatorio	Predeterminado
tool_calls	matriz de OpenAI.RunToolCallObject		Sí

OpenAI.RunStatus

Estado de la ejecución, que puede ser queued, , in_progressrequires_actioncancellingcancelledfailed, , completed, incompleteo .expired

Propiedad	Value
Type	string
Valores	`queued` `in_progress` `requires_action` `cancelling` `cancelled` `failed` `completed` `incomplete` `expired`

OpenAI.RunStepCompletionUsage

Estadísticas de uso relacionadas con el paso de ejecución. Este valor será null mientras el estado del paso de ejecución es in_progress.

Nombre	Tipo	Description	Obligatorio
completion_tokens	integer	Número de tokens de finalización usados durante el paso de ejecución.	Sí
prompt_tokens	integer	Número de tokens de solicitud usados durante el paso de ejecución.	Sí
total_tokens	integer	Número total de tokens usados (símbolo del sistema y finalización).	Sí

OpenAI.RunStepDetailsMessageCreationObject

Creación de mensajes

Detalles de la creación del mensaje mediante el paso de ejecución.

Nombre	Tipo	Description	Obligatorio	Predeterminado
message_creation	OpenAI.RunStepDetailsMessageCreationObjectMessageCreation		Sí
type	enum	Siempre `message_creation`. Valores posibles: `message_creation`	Sí

OpenAI.RunStepDetailsMessageCreationObjectMessageCreation

Nombre	Tipo	Description	Obligatorio	Predeterminado
message_id	string		Sí

OpenAI.RunStepDetailsToolCall

Discriminador para OpenAI.RunStepDetailsToolCall

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

Tipo de valor	Schema
`code_interpreter`	OpenAI.RunStepDetailsToolCallsCodeObject
`file_search`	OpenAI.RunStepDetailsToolCallsFileSearchObject
`function`	OpenAI.RunStepDetailsToolCallsFunctionObject

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.RunStepDetailsToolCallType		Sí

OpenAI.RunStepDetailsToolCallType

Propiedad	Value
Type	string
Valores	`code_interpreter` `file_search` `function`

OpenAI.RunStepDetailsToolCallsCodeObject

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

Detalles de la herramienta Intérprete de código en la que se ha implicado la llamada al paso de ejecución.

Nombre	Tipo	Description	Obligatorio
code_interpreter	OpenAI.RunStepDetailsToolCallsCodeObjectCodeInterpreter		Sí
└─ Entrada	string		Sí
└─ Salidas	matriz de OpenAI.RunStepDetailsToolCallsCodeOutputLogsObject o OpenAI.RunStepDetailsToolCallsCodeOutputImageObject		Sí
id	string	Identificador de la llamada a la herramienta.	Sí
type	enum	Tipo de llamada a herramienta. Esto siempre va a ser `code_interpreter` para este tipo de llamada a herramienta. Valores posibles: `code_interpreter`	Sí

OpenAI.RunStepDetailsToolCallsCodeObjectCodeInterpreter

Nombre	Tipo	Description	Obligatorio	Predeterminado
input	string		Sí
salidas	matriz de OpenAI.RunStepDetailsToolCallsCodeOutputLogsObject o OpenAI.RunStepDetailsToolCallsCodeOutputImageObject		Sí

OpenAI.RunStepDetailsToolCallsCodeOutputImageObject

Salida de imagen del Intérprete de Código

Nombre	Tipo	Description	Obligatorio	Predeterminado
imagen	OpenAI.RunStepDetailsToolCallsCodeOutputImageObjectImage		Sí
type	enum	Siempre `image`. Valores posibles: `image`	Sí

OpenAI.RunStepDetailsToolCallsCodeOutputImageObjectImage

Nombre	Tipo	Description	Obligatorio	Predeterminado
ID del archivo	string		Sí

OpenAI.RunStepDetailsToolCallsCodeOutputLogsObject

Salida de log del Intérprete de Código

Salida de texto de la llamada a la herramienta De intérprete de código como parte de un paso de ejecución.

Nombre	Tipo	Description	Obligatorio	Predeterminado
logs	string	Salida de texto de la llamada a la herramienta De intérprete de código.	Sí
type	enum	Siempre `logs`. Valores posibles: `logs`	Sí

OpenAI.RunStepDetailsToolCallsFileSearchObject

Llamada a la herramienta de búsqueda de archivos

Nombre	Tipo	Description	Obligatorio
file_search	OpenAI.RunStepDetailsToolCallsFileSearchObjectFileSearch		Sí
└" ranking_options	OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject	Las opciones de clasificación de la búsqueda de archivos.	No
└─ resultados	matriz de OpenAI.RunStepDetailsToolCallsFileSearchResultObject		No
id	string	Identificador del objeto de llamada de herramienta.	Sí
type	enum	Tipo de llamada a herramienta. Esto siempre va a ser `file_search` para este tipo de llamada a herramienta. Valores posibles: `file_search`	Sí

OpenAI.RunStepDetailsToolCallsFileSearchObjectFileSearch

Nombre	Tipo	Description	Obligatorio	Predeterminado
opciones_de_clasificación	OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject	Las opciones de clasificación de la búsqueda de archivos.	No
results	matriz de OpenAI.RunStepDetailsToolCallsFileSearchResultObject		No

OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject

Opciones de clasificación de llamadas a la herramienta de búsqueda de archivos

Las opciones de clasificación de la búsqueda de archivos.

Nombre	Tipo	Description	Obligatorio	Predeterminado
clasificador	OpenAI.FileSearchRanker	Clasificador que se va a usar para la búsqueda de archivos. Si no se especifica, usará el `auto` clasificador.	Sí
umbral de puntuación	número	Umbral de puntuación para la búsqueda de archivos. Todos los valores deben ser un número de punto flotante entre 0 y 1. Restricciones: min: 0, max: 1	Sí

OpenAI.RunStepDetailsToolCallsFileSearchResultObject

Resultado de la llamada a la herramienta de búsqueda de archivos

Instancia de resultado de la búsqueda de archivos.

Nombre	Tipo	Description	Obligatorio
contenido	matriz de OpenAI.RunStepDetailsToolCallsFileSearchResultObjectContent	Contenido del resultado que se encontró. El contenido solo se incluye si se solicita a través del parámetro include query.	No
ID del archivo	string	Identificador del archivo en el que se encontró el resultado.	Sí
nombre_de_archivo	string	Nombre del archivo en el que se encontró el resultado.	Sí
puntuación	número	Puntuación del resultado. Todos los valores deben ser un número de punto flotante entre 0 y 1. Restricciones: min: 0, max: 1	Sí

OpenAI.RunStepDetailsToolCallsFileSearchResultObjectContent

Nombre	Tipo	Description	Obligatorio	Predeterminado
text	string		No
type	enum	Valores posibles: `text`	No

OpenAI.RunStepDetailsToolCallsFunctionObject

Llamada a la herramienta de función

Nombre	Tipo	Description	Obligatorio
function	OpenAI.RunStepDetailsToolCallsFunctionObjectFunction		Sí
└ Argumentos	string		Sí
└─ Nombre	string		Sí
└─ salida	string o null		Sí
id	string	Identificador del objeto de llamada de herramienta.	Sí
type	enum	Tipo de llamada a herramienta. Esto siempre va a ser `function` para este tipo de llamada a herramienta. Valores posibles: `function`	Sí

OpenAI.RunStepDetailsToolCallsFunctionObjectFunction

Nombre	Tipo	Obligatorio
argumentos	string	Sí
nombre	string	Sí
output	string o null	Sí

OpenAI.RunStepDetailsToolCallsObject

Llamadas de herramientas

Detalles de la llamada a la herramienta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
tool_calls	matriz de OpenAI.RunStepDetailsToolCall	En una matriz de herramientas se llama al paso de ejecución. Se pueden asociar a uno de los tres tipos de herramientas: `code_interpreter`, `file_search`o `function`.	Sí
type	enum	Siempre `tool_calls`. Valores posibles: `tool_calls`	Sí

OpenAI.RunStepObject

Corre escaleras

Representa un paso en la ejecución de una ejecución.

Nombre	Tipo	Description	Obligatorio
assistant_id	string	El ID del asistente asociado al paso de corrida.	Sí
fecha_de_cancelación	string o null		Sí
completado_en	string o null		Sí
fecha_de_creación	entero (unixtime)	Marca de tiempo de Unix (en segundos) para cuando se creó el paso de ejecución.	Sí
fecha_de_expiración	string o null		Sí
failed_at	string o null		Sí
id	string	Identificador del paso de ejecución, al que se puede hacer referencia en puntos de conexión de API.	Sí
last_error	OpenAI.RunStepObjectLastError o null		Sí
metadatos	OpenAI.Metadata o null		Sí
object	enum	Tipo de objeto, que siempre `thread.run.step`es . Valores posibles: `thread.run.step`	Sí
identificador_de_ejecución	string	El ID de la ejecución a la que pertenece este paso de ejecución.	Sí
status	enum	Estado del paso de ejecución, que puede ser `in_progress`, `cancelled`, `failed`, `completed`o `expired`. Valores posibles: `in_progress`, `cancelled`, `failed`, , `completed`, `expired`	Sí
step_details	OpenAI.RunStepDetailsMessageCreationObject o OpenAI.RunStepDetailsToolCallsObject	Detalles del paso de ejecución.	Sí
thread_id	string	Identificador del subproceso que se ejecutó.	Sí
type	enum	Tipo de paso de ejecución, que puede ser `message_creation` o `tool_calls`. Valores posibles: `message_creation`, `tool_calls`	Sí
uso	OpenAI.RunStepCompletionUsage	Estadísticas de uso relacionadas con el paso de ejecución. Este valor será `null` mientras el estado del paso de ejecución es `in_progress`.	Sí

OpenAI.RunStepObjectLastError

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	enum	Valores posibles: `server_error`, `rate_limit_exceeded`	Sí
message	string		Sí

OpenAI.RunToolCallObject

Objetos de llamada de herramienta

Nombre	Tipo	Description	Obligatorio
function	OpenAI.RunToolCallObjectFunction		Sí
└ Argumentos	string		Sí
└─ Nombre	string		Sí
id	string	Identificador de la llamada a la herramienta. Este ID debe ser referenciado cuando envíes las salidas de la herramienta usando las salidas de la herramienta Enviar para ejecutar el endpoint.	Sí
type	enum	El tipo de herramienta que llama a la salida es necesario. Por ahora, siempre `function`es . Valores posibles: `function`	Sí

OpenAI.RunToolCallObjectFunction

Nombre	Tipo	Description	Obligatorio	Predeterminado
argumentos	string		Sí
nombre	string		Sí

OpenAI.SubmitToolOutputsRunRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
stream	booleano o null		No
tool_outputs	matriz de OpenAI.SubmitToolOutputsRunRequestToolOutputs	Lista de herramientas para las que se envían las salidas.	Sí

OpenAI.SubmitToolOutputsRunRequestToolOutputs

Nombre	Tipo	Description	Obligatorio	Predeterminado
output	string		No
tool_call_id	string		No

OpenAI.TextAnnotation

Discriminador para OpenAI.TextAnnotation

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

Tipo de valor	Schema
`file_citation`	OpenAI.MessageContentTextAnnotationsFileCitationObject
`file_path`	OpenAI.MessageContentTextAnnotationsFilePathObject

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.TextAnnotationType		Sí

OpenAI.TextAnnotationType

Propiedad	Value
Type	string
Valores	`file_citation` `file_path`

OpenAI.ThreadObject

Subproceso

Representa un hilo que contiene mensajes.

Nombre	Tipo	Description	Obligatorio
fecha_de_creación	entero (unixtime)	Marca de tiempo de Unix (en segundos) para cuando se creó el subproceso.	Sí
id	string	Identificador al que se puede hacer referencia en puntos de conexión de API.	Sí
metadatos	OpenAI.Metadata o null		Sí
object	enum	Tipo de objeto, que siempre `thread`es . Valores posibles: `thread`	Sí
tool_resources	OpenAI.ThreadObjectToolResources o null		Sí

OpenAI.ThreadObjectToolResources

Nombre	Tipo	Description	Obligatorio	Predeterminado
code_interpreter	OpenAI.ThreadObjectToolResourcesCodeInterpreter		No
file_search	OpenAI.ThreadObjectToolResourcesFileSearch		No

OpenAI.ThreadObjectToolResourcesCodeInterpreter

Nombre	Tipo	Description	Obligatorio	Predeterminado
identificadores de archivos	matriz de cadenas	Restricciones: máximo Objetos: 20	No

OpenAI.ThreadObjectToolResourcesFileSearch

Nombre	Tipo	Description	Obligatorio	Predeterminado
vector_store_ids	matriz de cadenas	Restricciones: maxItems: 1	No

OpenAI.TruncationObject

Controles de truncamiento de hilos

Controla cómo se truncará un subproceso antes de la ejecución. Úselo para controlar la ventana de contexto inicial de la ejecución.

Nombre	Tipo	Description	Obligatorio	Predeterminado
last_messages	entero o null		No
type	enum	Estrategia de truncamiento que se va a usar para el subproceso. El valor predeterminado es `auto`. Si se establece en `last_messages`, el subproceso se truncará en los n mensajes más recientes del subproceso. Cuando se establece `auto`en , los mensajes en el centro del subproceso se quitarán para ajustarse a la longitud de contexto del modelo, `max_prompt_tokens`. Valores posibles: `auto`, `last_messages`	Sí

Last updated on 2026-07-10