Microsoft Foundry

Versión de API: v1

Autenticación

Flow: implícito

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

Ámbitos:

• https://ai.azure.com/.default

Agents

Agentes: creación de agente

POST {endpoint}/agents?api-version=v1

Crea el agente.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	Falso	string Valores posibles: ContainerAgents=V1Preview, HostedAgents=V1Preview, WorkflowAgents=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
definición	AgentDefinition		Sí
└└ kind	AgentKind		Sí
└" rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
description	string	Descripción legible del agente. Restricciones: maxLength: 512	No
metadatos	object	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 una estructura formatear 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.	No
nombre	string	Nombre único que identifica al agente. Name se puede usar para recuperar/actualizar/eliminar el agente. - Debe comenzar y terminar con caracteres alfanuméricos, - Puede contener guiones en el centro - No debe superar los 63 caracteres. Restricciones: maxLength: 63	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	AgentObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Agentes: enumerar agentes

GET {endpoint}/agents?api-version=v1

Devuelve la lista de todos los agentes.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
amable	query	No	string Valores posibles: prompt, hosted, container_app, workflow	Filtre los agentes por tipo. Si no se proporciona, se devuelven todos los agentes.
limit	query	No	integer	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.
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 ydesc para orden descendente.
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.
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.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	object	Los datos de respuesta de una lista solicitada de elementos.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Agentes: obtener agente

GET {endpoint}/agents/{agent_name}?api-version=v1

Recupera el agente.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre del agente que se va a recuperar.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	AgentObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Agentes: agente de actualización

POST {endpoint}/agents/{agent_name}?api-version=v1

Actualiza el agente agregando una nueva versión si hay algún cambio en la definición del agente. Si no hay cambios, devuelve la versión existente del agente.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre del agente que se va a recuperar.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	Falso	string Valores posibles: ContainerAgents=V1Preview, HostedAgents=V1Preview, WorkflowAgents=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
definición	AgentDefinition		Sí
└└ kind	AgentKind		Sí
└" rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
description	string	Descripción legible del agente. Restricciones: maxLength: 512	No
metadatos	object	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 una estructura formatear 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.	No

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	AgentObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Agentes: eliminación del agente

DELETE {endpoint}/agents/{agent_name}?api-version=v1

Elimina un agente.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre del agente que se va a eliminar.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	DeleteAgentResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Agentes: actualización del agente desde el manifiesto

POST {endpoint}/agents/{agent_name}/import?api-version=v1

Actualiza el agente desde un manifiesto agregando una nueva versión si hay algún cambio en la definición del agente. Si no hay cambios, devuelve la versión existente del agente.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre del agente que se va a actualizar.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Descripción legible del agente. Restricciones: maxLength: 512	No
manifest_id	string	Identificador de manifiesto desde el que se va a importar la versión del agente.	Sí
metadatos	object	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 una estructura formatear 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.	No
parameter_values	object	Las entradas del manifiesto que darán lugar a un agente totalmente materializado.	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	AgentObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Agentes: creación de la versión del agente

POST {endpoint}/agents/{agent_name}/versions?api-version=v1

Cree una nueva versión del agente.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre único que identifica al agente. Name se puede usar para recuperar/actualizar/eliminar el agente. - Debe comenzar y terminar con caracteres alfanuméricos, - Puede contener guiones en el centro - No debe superar los 63 caracteres.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	Falso	string Valores posibles: ContainerAgents=V1Preview, HostedAgents=V1Preview, WorkflowAgents=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
definición	AgentDefinition		Sí
└└ kind	AgentKind		Sí
└" rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
description	string	Descripción legible del agente. Restricciones: maxLength: 512	No
metadatos	object	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 una estructura formatear 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.	No

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	AgentVersionObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Agentes: enumerar las versiones del agente

GET {endpoint}/agents/{agent_name}/versions?api-version=v1

Devuelve la lista de versiones de un agente.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre del agente para el que se van a recuperar versiones.
limit	query	No	integer	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.
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 ydesc para orden descendente.
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.
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.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	object	Los datos de respuesta de una lista solicitada de elementos.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Agentes: obtención de la versión del agente

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

Recupera una versión específica de un agente.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre del agente que se va a recuperar.
agent_version	path	Sí	string	Versión del agente que se va a recuperar.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	AgentVersionObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Agentes: eliminación de la versión del agente

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

Elimina una versión específica de un agente.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre del agente que se va a eliminar.
agent_version	path	Sí	string	Versión del agente que se va a eliminar
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	DeleteAgentVersionResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Agentes: creación de una versión del agente a partir del manifiesto

POST {endpoint}/agents/{agent_name}/versions:import?api-version=v1

Cree una nueva versión del agente a partir de un manifiesto.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre único que identifica al agente. Name se puede usar para recuperar/actualizar/eliminar el agente. - Debe comenzar y terminar con caracteres alfanuméricos, - Puede contener guiones en el centro - No debe superar los 63 caracteres.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Descripción legible del agente. Restricciones: maxLength: 512	No
manifest_id	string	Identificador de manifiesto desde el que se va a importar la versión del agente.	Sí
metadatos	object	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 una estructura formatear 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.	No
parameter_values	object	Las entradas del manifiesto que darán lugar a un agente totalmente materializado.	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	AgentVersionObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Agentes: creación de agente a partir del manifiesto

POST {endpoint}/agents:import?api-version=v1

Crea un agente a partir de un manifiesto.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Descripción legible del agente. Restricciones: maxLength: 512	No
manifest_id	string	Identificador de manifiesto desde el que se va a importar la versión del agente.	Sí
metadatos	object	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 una estructura formatear 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.	No
nombre	string	Nombre único que identifica al agente. Name se puede usar para recuperar/actualizar/eliminar el agente. - Debe comenzar y terminar con caracteres alfanuméricos, - Puede contener guiones en el centro - No debe superar los 63 caracteres. Restricciones: maxLength: 63	Sí
parameter_values	object	Las entradas del manifiesto que darán lugar a un agente totalmente materializado.	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	AgentObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Contenedores del agente

Contenedores del agente: enumerar las operaciones de contenedor del agente

GET {endpoint}/agents/{agent_name}/operations?api-version=v1

Enumerar las operaciones de contenedor para un agente.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre del agente.
limit	query	No	integer	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.
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 ydesc para orden descendente.
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.
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.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	Falso	string Valores posibles: ContainerAgents=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	object	Los datos de respuesta de una lista solicitada de elementos.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Contenedores del agente: obtención de la operación de contenedor del agente

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=v1

Obtenga el estado de una operación de contenedor para un agente.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre del agente.
operation_id	path	Sí	string	Identificador de la operación.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	Falso	string Valores posibles: ContainerAgents=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	AgentContainerOperationObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Contenedores del agente: obtención del contenedor del agente

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=v1

Obtenga un contenedor para una versión específica de un agente.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre del agente.
agent_version	path	Sí	string	Versión del agente.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	Falso	string Valores posibles: ContainerAgents=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	AgentContainerObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Contenedores del agente: enumerar las operaciones de contenedor de versión del agente

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=v1

Enumera las operaciones de contenedor para una versión específica de un agente.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre del agente.
agent_version	path	Sí	string	Versión del agente.
limit	query	No	integer	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.
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 ydesc para orden descendente.
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.
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.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	Falso	string Valores posibles: ContainerAgents=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	object	Los datos de respuesta de una lista solicitada de elementos.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Contenedores del agente: eliminación del contenedor del agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=v1

Elimine un contenedor para una versión específica de un agente. Si el contenedor no existe, la operación será no-op. La operación es una operación de larga duración. Siguiendo las instrucciones de diseño para las operaciones de ejecución prolongada en Azure API REST. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre del agente.
agent_version	path	Sí	string	Versión del agente.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	Falso	string Valores posibles: ContainerAgents=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 202

Descripción: la solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado.

Tipo de contenido	Type	Descripción
application/json	AgentContainerOperationObject

Encabezados de respuesta:

Encabezado	Tipo	Description
Ubicación de la Operación	string

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Contenedores del agente: transmisión de registros de contenedor del agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:logstream?api-version=v1

Entrada de registro de contenedor transmitida desde el contenedor como fragmentos de texto. Cada fragmento es una cadena UTF-8 que puede ser una línea de registro de texto sin formato o una entrada de registro con formato JSON, en función del tipo de registro de contenedor que se transmite. Los clientes deben tratar cada fragmento como texto opaco y, si es necesario, intentar analizarlo como JSON en función de sus requisitos de registro.

Para los registros del sistema, el formato es JSON con la estructura siguiente: {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Connecting to the events collector...","Reason":"StartingGettingEvent":"StartingGettingEvent" ","EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Correcto conectado a eventos server","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1}

En el caso de los registros de consola, el formato es texto sin formato emitido por stdout/stderr del contenedor. 2025-12-15T08:43:48.72656 Conexión al contenedor 'agent-container'... 2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre del agente.
agent_version	path	Sí	string	Versión del agente.
amable	query	No	string Valores posibles: console, system	console devuelve el contenedor stdout/stderr, el sistema devuelve el flujo de eventos de la aplicación de contenedor. el valor predeterminado de la consola
replica_name	query	No	string	Cuando se omite, el servidor elige la primera réplica para los registros de consola. Es necesario apuntar a una réplica específica.
cola	query	No	integer	Número de líneas de cola retornadas. Se aplica al 1 al 300. El valor predeterminado es 20
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	Falso	string Valores posibles: ContainerAgents=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Contenedores del agente: iniciar el contenedor del agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=v1

Inicie un contenedor para una versión específica de un agente. Si el contenedor ya está en funcionamiento, la operación será no-op. La operación es una operación de larga duración. Siguiendo las instrucciones de diseño para las operaciones de ejecución prolongada en Azure API REST. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre del agente.
agent_version	path	Sí	string	Versión del agente.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	Falso	string Valores posibles: ContainerAgents=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
max_replicas	integer	Número máximo de réplicas. De manera predeterminada, su valor es 1.	No	1
min_replicas	integer	Número mínimo de réplicas. De manera predeterminada, su valor es 1.	No	1

Responses

Código de estado: 202

Descripción: la solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado.

Tipo de contenido	Type	Descripción
application/json	AgentContainerOperationObject

Encabezados de respuesta:

Encabezado	Tipo	Description
Ubicación de la Operación	string

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Contenedores del agente: detener el contenedor del agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=v1

Detenga un contenedor para una versión específica de un agente. Si el contenedor no está en funcionamiento o ya ha sido detenido, la operación será no-op. La operación es una operación de larga duración. Siguiendo las instrucciones de diseño para las operaciones de ejecución prolongada en Azure API REST. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre del agente.
agent_version	path	Sí	string	Versión del agente.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	Falso	string Valores posibles: ContainerAgents=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 202

Descripción: la solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado.

Tipo de contenido	Type	Descripción
application/json	AgentContainerOperationObject

Encabezados de respuesta:

Encabezado	Tipo	Description
Ubicación de la Operación	string

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Contenedores del agente: actualización del contenedor del agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=v1

Actualice un contenedor para una versión específica de un agente. Si el contenedor no está en funcionamiento, la operación será no-op. La operación es una operación de larga duración. Siguiendo las instrucciones de diseño para las operaciones de ejecución prolongada en Azure API REST. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sí	string	Nombre del agente.
agent_version	path	Sí	string	Versión del agente.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	Falso	string Valores posibles: ContainerAgents=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
max_replicas	integer	Número máximo de réplicas.	No
min_replicas	integer	Número mínimo de réplicas.	No

Responses

Código de estado: 202

Descripción: la solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado.

Tipo de contenido	Type	Descripción
application/json	AgentContainerOperationObject

Encabezados de respuesta:

Encabezado	Tipo	Description
Ubicación de la Operación	string

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Connections

Conexiones: lista

GET {endpoint}/connections?api-version=v1

Enumerar todas las conexiones del proyecto, sin rellenar las credenciales de conexión

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
tipo de conexión	query	No	string Valores posibles: AzureOpenAI, AzureBlob, , AzureStorageAccount, CognitiveSearchCosmosDBApiKeyAppConfigAppInsightsCustomKeysRemoteTool_Preview	Enumerar las conexiones de este tipo específico
defaultConnection	query	No	boolean	Enumeración de conexiones que son conexiones predeterminadas

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
x-ms-client-request-id	Falso	string	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	PagedConnection

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-client-request-id		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Conexiones: obtener

GET {endpoint}/connections/{name}?api-version=v1

Obtención de una conexión por nombre, sin rellenar las credenciales de conexión

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre descriptivo de la conexión, proporcionado por el usuario.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
x-ms-client-request-id	Falso	string	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	Connection

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-client-request-id		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Conexiones: obtención con credenciales

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=v1

Obtención de una conexión por nombre, con sus credenciales de conexión

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre descriptivo de la conexión, proporcionado por el usuario.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
x-ms-client-request-id	Falso	string	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	Connection

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-client-request-id		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Datasets

Conjuntos de datos: enumeración más reciente

GET {endpoint}/datasets?api-version=v1

Enumerar la versión más reciente de cada DatasetVersion

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	PagedDatasetVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Conjuntos de datos: enumerar versiones

GET {endpoint}/datasets/{name}/versions?api-version=v1

Enumeración de todas las versiones de datasetVersion dadas

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	PagedDatasetVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Conjuntos de datos: obtener versión

GET {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Obtenga la versión específica de DatasetVersion. El servicio devuelve el error 404 No encontrado si datasetVersion no existe.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.
version	path	Sí	string	Identificador de versión específico de DatasetVersion que se va a recuperar.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	DatasetVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Conjuntos de datos: eliminación de la versión

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Elimine la versión específica de DatasetVersion. El servicio devuelve 204 Sin contenido si datasetVersion se eliminó correctamente o si datasetVersion no existe.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.
version	path	Sí	string	Versión de DatasetVersion que se va a eliminar.

Responses

Código de estado: 204

Descripción: no hay contenido que enviar para esta solicitud, pero los encabezados pueden ser útiles.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Conjuntos de datos: creación o actualización de la versión

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Cree una versión nueva o actualice una versión existente de DatasetVersion con el identificador de versión especificado.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.
version	path	Sí	string	Identificador de versión específico de DatasetVersion para crear o actualizar.

Cuerpo de la solicitud

Tipo-Contenido: application/merge-patch+json

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Texto de descripción del recurso.	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
type	DatasetType	Enumeración para determinar el tipo de datos.	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	DatasetVersion

Código de estado: 201

Descripción: la solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Tipo de contenido	Type	Descripción
application/json	DatasetVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Conjuntos de datos: obtención de credenciales

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=v1

Obtenga la credencial de SAS para acceder a la cuenta de almacenamiento asociada a una versión del conjunto de datos.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.
version	path	Sí	string	Identificador de versión específico de DatasetVersion en el que se va a operar.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	AssetCredentialResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Conjuntos de datos: iniciar la versión de carga pendiente

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=v1

Inicie una nueva o obtenga una carga pendiente existente de un conjunto de datos para una versión específica.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.
version	path	Sí	string	Identificador de versión específico de DatasetVersion en el que se va a operar.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
connectionName	string	Nombre de conexión de la cuenta de almacenamiento de Azure que se va a usar para generar un token de SAS temporal	No
pendingUploadId	string	Si no se proporciona PendingUploadId, se usará un GUID aleatorio.	No
pendingUploadType	enum	BlobReference es el único tipo admitido. Valores posibles: BlobReference	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	PendingUploadResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Implementaciones

Implementaciones: lista

GET {endpoint}/deployments?api-version=v1

Enumeración de todos los modelos implementados en el proyecto

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
modelPublisher	query	No	string	Publicador de modelos para filtrar modelos por
modelName	query	No	string	Nombre del modelo (el nombre específico del publicador) para filtrar los modelos por
deploymentType	query	No	string Valores posibles: ModelDeployment	Tipo de implementación para filtrar la lista por

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
x-ms-client-request-id	Falso	string	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	PagedDeployment

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-client-request-id		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Implementaciones: obtener

GET {endpoint}/deployments/{name}?api-version=v1

Obtener un modelo implementado.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre de la implementación

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
x-ms-client-request-id	Falso	string	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	Implementación

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-client-request-id		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Taxonomías de evaluación

Taxonomías de evaluación: lista

GET {endpoint}/evaluationtaxonomies?api-version=v1

Enumerar taxonomías de evaluación

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
inputName	query	No	string	Filtre por el nombre de entrada de evaluación.
inputType	query	No	string	Filtre por tipo de entrada de taxonomía.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Evaluations=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	PagedEvaluationTaxonomy

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Taxonomías de evaluación: obtener

GET {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Obtenga una ejecución de evaluación por nombre.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Evaluations=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	EvaluationTaxonomy

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Taxonomías de evaluación: eliminar

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Elimine una taxonomía de evaluación por nombre.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Evaluations=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 204

Descripción: no hay contenido que enviar para esta solicitud, pero los encabezados pueden ser útiles.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Taxonomías de evaluación: crear

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Cree una taxonomía de evaluación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre de la taxonomía de evaluación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Evaluations=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Texto de descripción del recurso.	No
properties	object	Propiedades adicionales para la taxonomía de evaluación.	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
taxonomyCategories	matriz de TaxonomyCategory	Lista de categorías de taxonomía.	No
taxonomyInput	EvaluationTaxonomyInput	Configuración de entrada para la taxonomía de evaluación.	Sí
└─ Tipo	EvaluationTaxonomyInputType	Tipo de entrada de la taxonomía de evaluación.	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	EvaluationTaxonomy

Código de estado: 201

Descripción: la solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Tipo de contenido	Type	Descripción
application/json	EvaluationTaxonomy

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Taxonomías de evaluación: actualización

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Actualizar una taxonomía de evaluación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre de la taxonomía de evaluación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Evaluations=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Texto de descripción del recurso.	No
properties	object	Propiedades adicionales para la taxonomía de evaluación.	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
taxonomyCategories	matriz de TaxonomyCategory	Lista de categorías de taxonomía.	No
taxonomyInput	EvaluationTaxonomyInputUpdate	Configuración de entrada para la taxonomía de evaluación.	No
└─ Tipo	EvaluationTaxonomyInputType	Tipo de entrada de la taxonomía de evaluación.	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	EvaluationTaxonomy

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Reglas de evaluación

Reglas de evaluación: lista

GET {endpoint}/evaluationrules?api-version=v1

Enumera todas las reglas de evaluación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
actionType	query	No	string Valores posibles: continuousEvaluation, humanEvaluationPreview	Filtre por el tipo de regla de evaluación.
agentName	query	No	string	Filtre por el nombre del agente.
enabled	query	No	boolean	Filtre por el estado habilitado.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	PagedEvaluationRule

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Reglas de evaluación: obtener

GET {endpoint}/evaluationrules/{id}?api-version=v1

Obtener una regla de evaluación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
id	path	Sí	string	Identificador único de la regla de evaluación.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	EvaluationRule

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Reglas de evaluación: eliminar

DELETE {endpoint}/evaluationrules/{id}?api-version=v1

Elimine una regla de evaluación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
id	path	Sí	string	Identificador único de la regla de evaluación.

Responses

Código de estado: 204

Descripción: no hay contenido que enviar para esta solicitud, pero los encabezados pueden ser útiles.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Reglas de evaluación: crear o actualizar

PUT {endpoint}/evaluationrules/{id}?api-version=v1

Cree o actualice una regla de evaluación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
id	path	Sí	string	Identificador único de la regla de evaluación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	Falso	string Valores posibles: Evaluations=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
acción	EvaluationRuleAction	Modelo de acción de evaluación.	Sí
└─ Tipo	EvaluationRuleActionType	Tipo de acción de evaluación.	Sí
description	string	Descripción de la regla de evaluación.	No
displayName	string	Nombre para mostrar de la regla de evaluación.	No
enabled	boolean	Indica si la regla de evaluación está habilitada. El valor predeterminado es verdadero.	Sí
eventType	EvaluationRuleEventType	Tipo de evento de regla de evaluación.	Sí
filter	EvaluationRuleFilter	Modelo de filtro de evaluación.	No
└] agentName	string	Filtre por nombre del agente.	Sí
id	string (solo lectura)	Identificador único de la regla de evaluación.	Sí
datos del sistema	objeto (solo lectura)	Metadatos del sistema para la regla de evaluación.	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	EvaluationRule

Código de estado: 201

Descripción: la solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Tipo de contenido	Type	Descripción
application/json	EvaluationRule

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Evaluadores

Evaluadores: enumerar las versiones más recientes

GET {endpoint}/evaluators?api-version=v1

Enumerar la última versión de cada evaluador

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
type	query	No	string Valores posibles: builtin, custom, all	Filtra los evaluadores por tipo. Valores posibles: "all", "custom", "builtin".
limit	query	No	integer	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.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Evaluations=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	PagedEvaluatorVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Evaluadores: enumerar versiones

GET {endpoint}/evaluators/{name}/versions?api-version=v1

Enumerar todas las versiones del evaluador dado

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.
type	query	No	string Valores posibles: builtin, custom, all	Filtra los evaluadores por tipo. Valores posibles: "all", "custom", "builtin".
limit	query	No	integer	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.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Evaluations=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	PagedEvaluatorVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Evaluadores: creación de una versión

POST {endpoint}/evaluators/{name}/versions?api-version=v1

Creación de un nuevo EvaluatorVersion con identificador de versión incrementado automáticamente

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Evaluations=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
categories	matriz de EvaluadorCategory	Las categorías del evaluador	Sí
definición	EvaluadorDefinition	Configuración del evaluador base con discriminador	Sí
└" data_schema	object	El esquema JSON (Borrador 2020-12) para los datos de entrada del evaluador. Esto incluye parámetros como tipo, propiedades, obligatorio.	No
└" init_parameters	object	El esquema JSON (Borrador 2020-12) para los parámetros de entrada del evaluador. Esto incluye parámetros como tipo, propiedades, obligatorio.	No
Métricas de └	object	Lista de métricas de salida producidas por este evaluador	No
└─ Tipo	EvaluadorDefinitionType	El tipo de definición del evaluador	Sí
description	string	Texto de descripción del recurso.	No
display_name	string	Nombre para mostrar del evaluador. Ayuda a encontrar fácilmente al evaluador en AI Foundry. No es necesario que sea único.	No
evaluator_type	EvaluadorType	El tipo de evaluador	Sí
metadatos	object	Metadatos sobre el evaluador	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No

Responses

Código de estado: 201

Descripción: la solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Tipo de contenido	Type	Descripción
application/json	EvaluadorVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Evaluadores: obtener versión

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Obtenga la versión específica de EvaluatorVersion. El servicio devuelve el error 404 Not Found si EvaluatorVersion no existe.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.
version	path	Sí	string	Identificador de versión específico de EvaluadorVersion que se va a recuperar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Evaluations=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	EvaluadorVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Evaluadores: eliminar versión

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Elimine la versión específica de EvaluatorVersion. El servicio devuelve 204 No Content si EvaluatorVersion se eliminó correctamente o si EvaluatorVersion no existe.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.
version	path	Sí	string	Versión de EvaluadorVersion que se va a eliminar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Evaluations=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 204

Descripción: no hay contenido que enviar para esta solicitud, pero los encabezados pueden ser útiles.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Evaluadores: versión de actualización

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Actualización de un EvaluatorVersion existente con el identificador de versión especificado

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.
version	path	Sí	string	Versión de EvaluadorVersion que se va a actualizar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Evaluations=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
categories	matriz de EvaluadorCategory	Las categorías del evaluador	No
description	string	Texto de descripción del recurso.	No
display_name	string	Nombre para mostrar del evaluador. Ayuda a encontrar fácilmente al evaluador en AI Foundry. No es necesario que sea único.	No
metadatos	object	Metadatos sobre el evaluador	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	EvaluadorVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Indexes

Índices: enumeración más reciente

GET {endpoint}/indexes?api-version=v1

Enumerar la versión más reciente de cada índice

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	PagedIndex

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Índices: enumerar versiones

GET {endpoint}/indexes/{name}/versions?api-version=v1

Enumeración de todas las versiones del índice especificado

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	PagedIndex

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Índices: obtener versión

GET {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Obtenga la versión específica del índice. El servicio devuelve el error 404 No encontrado si el índice no existe.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.
version	path	Sí	string	Identificador de versión específico del índice que se va a recuperar.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	Índice

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Índices: eliminar versión

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Elimine la versión específica del índice. El servicio devuelve 204 Sin contenido si el índice se eliminó correctamente o si el índice no existe.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.
version	path	Sí	string	Versión del índice que se va a eliminar.

Responses

Código de estado: 204

Descripción: no hay contenido que enviar para esta solicitud, pero los encabezados pueden ser útiles.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Índices: creación o actualización de la versión

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Creación de un índice nuevo o actualización de un índice existente con el identificador de versión especificado

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Nombre del recurso.
version	path	Sí	string	Identificador de versión específico del índice que se va a crear o actualizar.

Cuerpo de la solicitud

Tipo-Contenido: application/merge-patch+json

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Texto de descripción del recurso.	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
type	IndexType		Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	Índice

Código de estado: 201

Descripción: la solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Tipo de contenido	Type	Descripción
application/json	Índice

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Insights

Conclusiones: generación

POST {endpoint}/insights?api-version=v1

Generación de conclusiones

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Insights=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.
Repetibilidad:Request-ID	Falso	string	Identificador único generado por el cliente para garantizar la idempotencia de la solicitud. Use el mismo identificador para los reintentos para evitar evaluaciones duplicadas.
Repetibilidad:First-Sent	Falso	string	Marca de tiempo que indica cuándo se inició esta solicitud por primera vez. Se utiliza junto con repeatability-request-id para el control de la idempotencia.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
displayName	string	Nombre para mostrar descriptivo para la información.	Sí
id	string (solo lectura)	Identificador único del informe de conclusiones.	Sí
metadatos	InsightsMetadata (solo lectura)	Metadatos sobre la información.	Sí
└— completedAt	string	Marca de tiempo cuando se completó la información.	No
└— createdAt	string	Marca de tiempo cuando se creó la información.	Sí
request	InsightRequest	La solicitud del informe de información.	Sí
└─ Tipo	InsightType	Tipo de solicitud.	Sí
result	InsightResult (solo lectura)	El resultado de las ideas.	No
└─ Tipo	InsightType	Tipo de resultado de información.	Sí
state	Azure. Core.Foundations.OperationState (solo lectura)	Enumeración que describe los estados de operación permitidos.	Sí

Responses

Código de estado: 201

Descripción: la solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Tipo de contenido	Type	Descripción
application/json	Conclusiones

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Conclusiones: lista

GET {endpoint}/insights?api-version=v1

Enumere todas las conclusiones en orden cronológico inverso (más reciente primero).

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
type	query	No	string Valores posibles: EvaluationRunClusterInsight, AgentClusterInsight, EvaluationComparison	Filtrar por tipo de análisis.
evalId	query	No	string	Filtre por el ID de evaluación.
runId	query	No	string	Filtre por el identificador de ejecución de evaluación.
agentName	query	No	string	Filtre por el nombre del agente.
includeCoordinates	query	No	boolean	Si se deben incluir coordenadas para la visualización en la respuesta. El valor predeterminado es False.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Insights=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	PagedInsight

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Conclusiones: obtener

GET {endpoint}/insights/{id}?api-version=v1

Obtenga una información específica por id.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
id	path	Sí	string	Identificador único del informe de conclusiones.
includeCoordinates	query	No	boolean	Si se deben incluir coordenadas para la visualización en la respuesta. El valor predeterminado es False.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Insights=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	Conclusiones

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Almacenes de memoria

Creación de un almacén de memoria

POST {endpoint}/memory_stores?api-version=v1

Cree un almacén de memoria.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: MemoryStores=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
definición	MemoryStoreDefinition	Definición base para configuraciones de almacén de memoria.	Sí
└└ kind	MemoryStoreKind	Tipo del almacén de memoria.	Sí
description	string	Descripción legible del almacén de memoria. Restricciones: maxLength: 512	No
metadatos	object	Metadatos de clave-valor arbitrarios que se van a asociar al almacén de memoria.	No
nombre	string	Nombre del almacén de memoria. Restricciones: maxLength: 256	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	MemoryStoreObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Enumerar almacenes de memoria

GET {endpoint}/memory_stores?api-version=v1

Enumerar todos los almacenes de memoria.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	query	No	integer	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.
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 ydesc para orden descendente.
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.
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.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: MemoryStores=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	object	Los datos de respuesta de una lista solicitada de elementos.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Actualizar el almacén de memoria

POST {endpoint}/memory_stores/{name}?api-version=v1

Actualizar un almacén de memoria.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nombre	path	Sí	string	Nombre del almacén de memoria que se va a actualizar.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: MemoryStores=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Descripción legible del almacén de memoria. Restricciones: maxLength: 512	No
metadatos	object	Metadatos de clave-valor arbitrarios que se van a asociar al almacén de memoria.	No

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	MemoryStoreObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Obtención del almacén de memoria

GET {endpoint}/memory_stores/{name}?api-version=v1

Recuperar un almacén de memoria.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nombre	path	Sí	string	Nombre del almacén de memoria que se va a recuperar.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: MemoryStores=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	MemoryStoreObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Eliminación del almacén de memoria

DELETE {endpoint}/memory_stores/{name}?api-version=v1

Eliminar un almacén de memoria.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nombre	path	Sí	string	Nombre del almacén de memoria que se va a eliminar.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: MemoryStores=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	DeleteMemoryStoreResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Obtención del resultado de la actualización

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=v1

Obtener el resultado de la actualización del almacén de memoria.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nombre	path	Sí	string	Nombre del almacén de memoria.
update_id	path	Sí	string	Identificador de la operación de actualización de memoria.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: MemoryStores=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	MemoryStoreUpdateResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Eliminar memorias de ámbito

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=v1

Elimine todas las memorias asociadas a un ámbito específico de un almacén de memoria.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nombre	path	Sí	string	Nombre del almacén de memoria.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: MemoryStores=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
scope	string	Espacio de nombres que agrupa lógicamente y aísla memorias para eliminar, como un identificador de usuario.	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	MemoryStoreDeleteScopeResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Memorias de búsqueda

POST {endpoint}/memory_stores/{name}:search_memories?api-version=v1

Busque recuerdos relevantes de un almacén de memoria basado en el contexto de conversación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nombre	path	Sí	string	Nombre del almacén de memoria que se va a buscar.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: MemoryStores=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
items	matriz de OpenAI.InputItem	Elementos para los que se van a buscar recuerdos relevantes.	No
options	MemorySearchOptions	Opciones de búsqueda de memoria.	No
└" max_memories	integer	Número máximo de elementos de memoria que se van a devolver.	No
previous_search_id	string	Identificador único de la solicitud de búsqueda anterior, lo que permite la búsqueda incremental de memoria desde donde se dejó la última operación.	No
scope	string	El espacio de nombres que agrupa y aísla lógicamente las memorias, como un ID de usuario.	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	MemoryStoreSearchResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Actualizar memorias

POST {endpoint}/memory_stores/{name}:update_memories?api-version=v1

Actualice el almacén de memoria con recuerdos de conversación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nombre	path	Sí	string	Nombre del almacén de memoria que se va a actualizar.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: MemoryStores=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
items	matriz de OpenAI.InputItem	Elementos de conversación desde los que extraer recuerdos.	No
previous_update_id	string	Identificador único de la solicitud de actualización anterior, lo que habilita las actualizaciones de memoria incrementales desde donde se dejó la última operación.	No
scope	string	El espacio de nombres que agrupa y aísla lógicamente las memorias, como un ID de usuario.	Sí
update_delay	integer	Tiempo de espera antes de procesar la actualización de memoria en segundos. Si se recibe una nueva solicitud de actualización durante este período, cancelará la solicitud actual y restablecerá el tiempo de espera. Establézcalo en 0 para desencadenar inmediatamente la actualización sin retraso. El valor predeterminado es 300 (5 minutos).	No	300

Responses

Código de estado: 202

Descripción: la solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado.

Tipo de contenido	Type	Descripción
application/json	MemoryStoreUpdateResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
Ubicación de la Operación	string	Ubicación para supervisar el estado de la operación.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Conversaciones

Creación de una conversación

POST {endpoint}/openai/v1/conversations

Cree una conversación.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
items	matriz de OpenAI.InputItem		No
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Enumerar conversaciones

GET {endpoint}/openai/v1/conversations

Devuelve la lista de todas las conversaciones.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	query	No	integer	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.
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 ydesc para orden descendente.
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.
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.
agent_name	query	No	string	Filtre por nombre del agente. Si se proporciona, solo se devolverán los elementos asociados al agente especificado.
agent_id	query	No	string	Filtre por identificador de agente con el formato name:version. Si se proporciona, solo se devolverán los elementos asociados al identificador de agente especificado.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	object	Los datos de respuesta de una lista solicitada de elementos.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Actualizar conversación

POST {endpoint}/openai/v1/conversations/{conversation_id}

Actualizar una conversación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Sí	string	Identificador de la conversación que se va a actualizar.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Obtener conversación

GET {endpoint}/openai/v1/conversations/{conversation_id}

Recupera una conversación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Sí	string	Identificador de la conversación que se va a recuperar.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Eliminar conversación

DELETE {endpoint}/openai/v1/conversations/{conversation_id}

Elimina una conversación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Sí	string	Identificador de la conversación que se va a eliminar.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Crear elementos de conversación

POST {endpoint}/openai/v1/conversations/{conversation_id}/items

Cree elementos en una conversación con el identificador especificado.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Sí	string	Identificador de la conversación en la que se debe crear el elemento.
incluír	query	No	array	Campos adicionales que se van a incluir en la respuesta. Consulte el include parámetro para enumerar elementos de conversación para obtener más información.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
items	matriz de OpenAI.Item	Elementos que se van a agregar a la conversación. Puede agregar hasta 20 elementos a la vez.	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Enumerar elementos de conversación

GET {endpoint}/openai/v1/conversations/{conversation_id}/items

Enumere todos los elementos de una conversación con el identificador especificado.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Sí	string	Identificador de la conversación en la que deben aparecer los elementos.
limit	query	No	integer	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.
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 ydesc para orden descendente.
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.
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.
item_type	query	No	string Valores posibles: message, output_message, file_search_call, computer_callcomputer_call_outputweb_search_callfunction_callfunction_call_outputreasoningcompactionimage_generation_callcode_interpreter_calllocal_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_callcustom_tool_call_outputcustom_tool_callstructured_outputsoauth_consent_requestmemory_search_callworkflow_action	Filtre por tipo de elemento. Si se proporciona, solo se devolverán los elementos del tipo especificado.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	object	Los datos de respuesta de una lista solicitada de elementos.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Obtener elemento de conversación

GET {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Obtenga un solo elemento de una conversación con los identificadores especificados.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Sí	string	Identificador de la conversación que contiene el elemento.
item_id	path	Sí	string	Identificador del elemento de conversación que se va a recuperar.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Eliminar elemento de conversación

DELETE {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Elimine un elemento de una conversación con los identificadores especificados.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Sí	string	Identificador de la conversación en la que se debe eliminar el elemento.
item_id	path	Sí	string	Identificador del elemento de conversación que se va a eliminar.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Evals

Evals: enumeración de valores

GET {endpoint}/openai/v1/evals

Enumera todas las evaluaciones Enumerar las evaluaciones de un proyecto.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
después	query	No	string	Identificador de la última ejecución de la solicitud de paginación anterior.
limit	query	No	integer	Número de ejecuciones que se van a recuperar.
order	query	No	string Valores posibles: asc, desc	Criterio de ordenación de ejecuciones por marca de tiempo. Se usa asc para el orden ascendente o desc para el orden descendente. Tiene como valor predeterminado asc.
ordenar_por	query	No	string Valores posibles: created_at, updated_at	Las valoraciones se pueden ordenar por hora de creación o hora de última actualización. Use created_at para la hora de creación o updated_at para la hora de la última actualización.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	object	Los datos de respuesta de una lista solicitada de elementos.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Evals: creación de eval

POST {endpoint}/openai/v1/evals

Crear evaluación Cree la estructura de una evaluación que se puede usar para probar el rendimiento de un modelo. Una evaluación es un conjunto de criterios de prueba y la configuración de un origen de datos, que dicta el esquema de los datos usados en la evaluación. Después de crear una evaluación, puede ejecutarla en diferentes modelos y parámetros de modelo. Se admiten varios tipos de calificadores y orígenes de datos. Para obtener más información, consulte el

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
configuración_de_fuente_de_datos	OpenAI.CreateEvalCustomDataSourceConfig o OpenAI.CreateEvalLogsDataSourceConfig o OpenAI.CreateEvalStoredCompletionsDataSourceConfig o AzureAIDataSourceConfig	Configuración del origen de datos usado para las ejecuciones de evaluación. Dicta el esquema de los datos usados en la evaluación.	Sí
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
nombre	string	Nombre de la evaluación.	No
properties	object	Conjunto de pares clave-valor inmutables de 16 que se pueden adjuntar a un objeto para almacenar información adicional. Las claves son cadenas con una longitud máxima de 64 caracteres. Los valores son cadenas con una longitud máxima de 512 caracteres.	No
criterios_de_prueba	matriz de OpenAI.EvalGraderLabelModel o OpenAI.EvalGraderStringCheck o OpenAI.EvalGraderTextSimilarity o OpenAI.EvalGraderPython o OpenAI.EvalGraderScoreModel o EvalGraderAzureAIEvaluator	Una lista de evaluadores para todas las ejecuciones de evaluación en este grupo. Los calificadores pueden hacer referencia a variables en el origen de datos mediante la notación de llaves dobles, como {{item.variable_name}}. Para hacer referencia a la salida del modelo, use el sample espacio de nombres (es decir, {{sample.output_text}}).	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	Eval

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Evals: eliminar eval

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

Eliminar una evaluación Eliminar una evaluación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sí	string	Identificador de la evaluación que se va a eliminar.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	DeleteEvalResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Evals: obtener eval

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

Obtener una evaluación Obtener una evaluación por identificador.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sí	string	Identificador de la evaluación que se va a recuperar.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	Eval

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Evals: actualización de eval

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

Actualizar una evaluación Actualizar determinadas propiedades de una evaluación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sí	string	Identificador de la evaluación que se va a actualizar.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
nombre	string		No
properties	object	Conjunto de pares clave-valor inmutables de 16 que se pueden adjuntar a un objeto para almacenar información adicional. Las claves son cadenas con una longitud máxima de 64 caracteres. Los valores son cadenas con una longitud máxima de 512 caracteres.	No

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	Eval

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Evals: enumeración de ejecuciones

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

Obtener una lista de ejecuciones para una evaluación Obtener una lista de ejecuciones para una evaluación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sí	string	Identificador de la evaluación para la que se van a recuperar las ejecuciones.
después	query	No	string	Identificador de la última ejecución de la solicitud de paginación anterior.
limit	query	No	integer	Número de ejecuciones que se van a recuperar.
order	query	No	string Valores posibles: asc, desc	Criterio de ordenación de ejecuciones por marca de tiempo. Se usa asc para el orden ascendente o desc para el orden descendente. Tiene como valor predeterminado asc.
status	query	No	string Valores posibles: queued, in_progress, completed, canceled, failed . Filtrar ejecuciones por estado. Uno de queued, in_progress, failed, completed, canceled.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	object	Los datos de respuesta de una lista solicitada de elementos.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Evals: creación de una ejecución de eval

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

Creación de una ejecución de evaluación

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sí	string	Identificador de la evaluación para la que se va a crear una ejecución.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
fuente_de_datos	OpenAI.CreateEvalJsonlRunDataSource o OpenAI.CreateEvalCompletionsRunDataSource o OpenAI.CreateEvalResponsesRunDataSource o EvalRunDataSource	Detalles sobre el origen de datos de la ejecución.	Sí
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
nombre	string	Nombre de la ejecución.	No
properties	object	Conjunto de pares clave-valor inmutables de 16 que se pueden adjuntar a un objeto para almacenar información adicional. Las claves son cadenas con una longitud máxima de 64 caracteres. Los valores son cadenas con una longitud máxima de 512 caracteres.	No

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	EvalRun

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Evals: eliminación de la ejecución de eval

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

Eliminar ejecución de evaluación Elimina una ejecución de evaluación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sí	string	Identificador de la evaluación de la que se va a eliminar la ejecución.
identificador_de_ejecución	path	Sí	string	Identificador de la ejecución que se va a eliminar.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	DeleteEvalRunResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Evals: obtención de la ejecución de eval

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

Obtener una ejecución de evaluación Obtener una ejecución de evaluación por identificador.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sí	string	Identificador de la evaluación para la que se van a recuperar las ejecuciones.
identificador_de_ejecución	path	Sí	string	Identificador de la ejecución que se va a recuperar.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	EvalRun

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Evals: cancelación de la ejecución de eval

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

Cancelar ejecución de evaluación Cancelar una ejecución de evaluación en curso.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sí	string	Identificador de la evaluación cuya ejecución desea cancelar.
identificador_de_ejecución	path	Sí	string	Identificador de la ejecución que se va a cancelar.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	EvalRun

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Evals: obtener elementos de salida de ejecución de eval

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

Obtener los elementos de salida de la ejecución de evaluación Obtiene una lista de elementos de salida para una ejecución de evaluación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sí	string
identificador_de_ejecución	path	Sí	string	Identificador de la ejecución para la que se van a recuperar los elementos de salida.
después	query	No	string	Identificador de la última ejecución de la solicitud de paginación anterior.
limit	query	No	integer	Número de ejecuciones que se van a recuperar.
order	query	No	string Valores posibles: asc, desc	Criterio de ordenación de ejecuciones por marca de tiempo. Se usa asc para el orden ascendente o desc para el orden descendente. Tiene como valor predeterminado asc.
status	query	No	string Valores posibles: fail, pass	Filtre los elementos de salida por estado. Uso failed para filtrar por salida con error elementos o pass para filtrar por elementos de salida pasados.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	object	Los datos de respuesta de una lista solicitada de elementos.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Evals: obtener el elemento de salida de ejecución de eval

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

Obtener un elemento de salida de una ejecución de evaluación Obtener un elemento de salida de ejecución de evaluación por identificador.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sí	string	Identificador de la evaluación para la que se van a recuperar las ejecuciones.
identificador_de_ejecución	path	Sí	string	Identificador de la ejecución que se va a recuperar.
output_item_id	path	Sí	string	Identificador del elemento de salida que se va a recuperar.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	EvalRunOutputItem

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Fine-Tuning

Creación de un trabajo de ajuste preciso

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

Crea un trabajo de ajuste preciso que comienza el proceso de creación de un nuevo modelo a partir de un conjunto de datos determinado.

La respuesta incluye detalles del trabajo en cola, incluido el estado del trabajo y el nombre de los modelos ajustados una vez completados.

Aprende más sobre el ajuste fino

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
hiperparámetros	OpenAI.CreateFineTuningJobRequestHyperparameters		No
└─ tamaño del lote (batch_size)	string o OpenAI.integer		No	auto
"└─ learning_rate_multiplier"	string o OpenAI.numeric		No
├─ n_epochs	string o OpenAI.integer		No	auto
Integraciones	matriz de OpenAI.CreateFineTuningJobRequestIntegrations	Lista de integraciones que se habilitarán para el trabajo de ajuste preciso.	No
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
method	OpenAI.FineTuneMethod	Método que se usa para ajustar.	No
model	string (consulte los modelos válidos a continuación)	Nombre del modelo que se va a ajustar. Puede seleccionar una de las modelos soportados.	Sí
inicialización	OpenAI.integer (que acepta valores NULL)		No
sufijo	string (que acepta valores NULL)	Cadena de hasta 64 caracteres que se agregarán al nombre del modelo ajustado. Por ejemplo, un suffix de "custom-model-name" produciría un nombre de modelo como ft:gpt-4o-mini:openai:custom-model-name:7p4lURel. Restricciones: minLength: 1, maxLength: 64	No
archivo_de_entrenamiento	string	Identificador de un archivo cargado que contiene datos de entrenamiento. Consulte Upload file (Cargar archivo ) para obtener información sobre cómo cargar un archivo. El conjunto de datos debe tener el formato JSONL. Además, debe cargar el archivo con el propósito fine-tune. El contenido del archivo debe diferir en función de si el modelo usa el formato de chat, finalizaciones o si el método de ajuste utiliza el formato de preferencia . Consulta la guía ajuste fino para más detalles.	Sí
archivo_de_validación	string (que acepta valores NULL)	Identificador de un archivo cargado que contiene datos de validación. Si proporciona este archivo, los datos se usan para generar la validación. métricas periódicamente durante el ajuste preciso. Estas métricas se pueden ver en el archivo de resultados de ajuste preciso. Los mismos datos no deben estar presentes en los archivos de entrenamiento y validación. El conjunto de datos debe tener el formato JSONL. Debe cargar el archivo con el propósito fine-tune. Consulta la guía ajuste fino para más detalles.	No

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Enumeración de trabajos de ajuste paginado

GET {endpoint}/openai/v1/fine_tuning/jobs?api-version=v1

Enumeración de los trabajos de ajuste preciso de la organización

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
después	query	No	string	Identificador del último trabajo de la solicitud de paginación anterior.
limit	query	No	integer	Número de trabajos de ajuste preciso que se van a recuperar.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Recuperación del trabajo de ajuste preciso

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=v1

Obtenga información sobre un trabajo de ajuste preciso.

Aprende más sobre el ajuste fino

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Sí	string	Identificador del trabajo de ajuste.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Cancelación del trabajo de ajuste correcto

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=v1

Cancelar inmediatamente un trabajo de ajuste.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Sí	string	Identificador del trabajo de ajuste que se va a cancelar.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Enumeración de puntos de comprobación de trabajos de ajuste correcto

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=v1

Enumera los puntos de control de un trabajo de ajuste preciso.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Sí	string	Identificador del trabajo de ajuste preciso para obtener puntos de control.
después	query	No	string	Identificador del último identificador de punto de control de la solicitud de paginación anterior.
limit	query	No	integer	Número de puntos de control que se van a recuperar.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Enumeración de eventos de trabajo de ajuste correcto

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=v1

Obtenga actualizaciones de estado específicas para un trabajo de ajuste preciso.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Sí	string	Identificador del trabajo de ajuste preciso para el que se van a obtener eventos.
después	query	No	string	Identificador del último evento de la solicitud de paginación anterior.
limit	query	No	integer	Número de eventos que se van a recuperar.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Pausar el trabajo de ajuste correcto

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=v1

Pausar un trabajo de ajuste correcto en ejecución.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Sí	string	Identificador del trabajo de ajuste preciso que se va a pausar.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Reanudación del trabajo de ajuste correcto

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=v1

Reanude un trabajo de ajuste de pausa.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Sí	string	Identificador del trabajo de ajuste preciso que se va a reanudar.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Responses

Creación de una respuesta: creación de un flujo de respuesta

POST {endpoint}/openai/v1/responses

Crea una respuesta modelo. Crea una respuesta de modelo (respuesta de streaming).

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
fondo	booleano (que acepta valores NULL)		No
conversación	OpenAI.ConversationParam (que acepta valores NULL)	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.	No
incluír	matriz de OpenAI.IncludeEnum		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 (que acepta valores NULL)		No
max_output_tokens	OpenAI.integer (que acepta valores NULL)		No
max_tool_calls	OpenAI.integer (que acepta valores NULL)		No
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
model	string	Implementación del modelo que se va a usar para la creación de esta respuesta.	No
parallel_tool_calls	booleano (que acepta valores NULL)		No	True
previous_response_id	string (que acepta valores 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	enum	Valores posibles: in-memory, 24h	No
reasoning	OpenAI.Reasoning (que acepta valores NULL)	Modelos de serie gpt-5 y o solo Opciones de configuración para modelos de razonamiento.	No
└─ esfuerzo	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de 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 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, mediumy 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-maxde .	No
└─ generar_resumen	enum	Valores posibles: auto, concise, detailed	No
└─ resumen	enum	Valores posibles: auto, concise, detailed	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
nivel de servicio	OpenAI.ServiceTier	Especifica el tipo de procesamiento utilizado para atender la solicitud. - Si se establece en "auto", la solicitud se procesará con el nivel de servicio configurado en la configuración de Project. A menos que se configure lo contrario, el Project usará "default". - Si se establece en "valor predeterminado", la solicitud se procesará con los precios estándar y el rendimiento del modelo seleccionado. - Si se establece en "flex" o "priority", la solicitud se procesará con el nivel de servicio correspondiente. - Cuando no se establece, el comportamiento predeterminado es "auto". Cuando se establece el service_tier parámetro , el cuerpo de la respuesta incluirá el service_tier valor en función del modo de procesamiento usado realmente para atender la solicitud. Este valor de respuesta puede ser diferente del valor establecido en el parámetro .	No
store	booleano (que acepta valores NULL)		No	True
stream	booleano (que acepta valores NULL)		No
stream_options	OpenAI.ResponseStreamOptions (que acepta valores NULL)	Opciones para las respuestas de streaming. Establézcalo solo cuando establezca stream: true.	No
└" 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
structured_inputs	object	Entradas estructuradas para la respuesta que pueden participar en enlaces de argumentos de herramienta o sustitución de plantillas de solicitud.	No
temperatura	OpenAI.numeric (que acepta valores NULL)		No	1
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.ToolChoiceOptions o OpenAI.ToolChoiceParam		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	OpenAI.integer (que acepta valores NULL)		No
top_p	OpenAI.numeric (que acepta valores NULL)		No	1
truncation	enum	Valores posibles: auto, disabled	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	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Enumerar respuestas

GET {endpoint}/openai/v1/responses

Devuelve la lista de todas las respuestas.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	query	No	integer	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.
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 ydesc para orden descendente.
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.
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.
agent_name	query	No	string	Filtre por nombre del agente. Si se proporciona, solo se devolverán los elementos asociados al agente especificado.
agent_id	query	No	string	Filtre por identificador de agente con el formato name:version. Si se proporciona, solo se devolverán los elementos asociados al identificador de agente especificado.
conversation_id	query	No	string	Filtre por identificador de conversación. Si se proporciona, solo se devolverán las respuestas asociadas a la conversación especificada.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	object	Los datos de respuesta de una lista solicitada de elementos.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Conversación de respuesta compacta

POST {endpoint}/openai/v1/responses/compact

Genera una compactación de una conversación de respuestas.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
input	cadena o matriz de OpenAI.InputItem		No
instructions	string (que acepta valores NULL)		No
model	OpenAI.ModelIdsCompaction	Id. de modelo usado para generar la respuesta, como gpt-5 o o3. OpenAI ofrece una amplia gama de modelos con diferentes funcionalidades, características de rendimiento y puntos de precio. Consulte la guía del modelo para examinar y comparar los modelos disponibles.	Sí
previous_response_id	string (que acepta valores 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.CompactResource

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Obtener respuesta: obtener flujo de respuesta

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

Recupera una respuesta de modelo con el identificador especificado. Recupera una respuesta de modelo con el identificador especificado (respuesta de streaming).

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Sí	string
include[]	query	No	array
stream	query	No	boolean
starting_after	query	No	integer

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
aceptar	Falso	string Valores posibles: text/event-stream

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Eliminar respuesta

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

Elimina una respuesta de modelo.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Sí	string	Identificador de la respuesta que se va a eliminar.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	DeleteResponseResult

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Cancelar respuesta

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

Cancela una respuesta de modelo.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Sí	string	Identificador de la respuesta que se va a cancelar.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

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	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Sí	string
limit	query	No	integer	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.
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 ydesc para orden descendente.
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.
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.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	object	Los datos de respuesta de una lista solicitada de elementos.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Redteams

Redteams: lista

GET {endpoint}/redTeams/runs?api-version=v1

Enumere un redteam por nombre.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: RedTeams=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	PagedRedTeam

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Redteams - get

GET {endpoint}/redTeams/runs/{name}?api-version=v1

Obtenga un redteam por nombre.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
nombre	path	Sí	string	Identificador de la ejecución del equipo rojo.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: RedTeams=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	RedTeam

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Redteams: creación

POST {endpoint}/redTeams/runs:run?api-version=v1

Crea una ejecución de redteam.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: RedTeams=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
applicationScenario	string	Escenario de aplicación para la operación de equipo rojo, para generar ataques específicos del escenario.	No
attackStrategies	matriz de AttackStrategy	Lista de estrategias de ataque o listas anidadas de estrategias de ataque.	No
displayName	string	Nombre de la ejecución del equipo rojo.	No
id	string (solo lectura)	Identificador de la ejecución del equipo rojo.	Sí
numTurns	integer	Número de rondas de simulación.	No
properties	object	Propiedades del equipo rojo. A diferencia de las etiquetas, las propiedades son de solo complemento. Una vez agregado, no se puede quitar una propiedad.	No
riskCategories	matriz de RiskCategory	Lista de categorías de riesgo para las que se van a generar objetivos de ataque.	No
simulationOnly	boolean	Solo simulación o Simulación + Evaluación. El valor predeterminado es false, si es true, la conversación genera el resultado de la conversación no de evaluación.	No	Falso
status	string (solo lectura)	Estado del equipo rojo. Se establece por servicio y es de solo lectura.	No
tags	object	Etiquetas del equipo rojo. A diferencia de las propiedades, las etiquetas son completamente mutables.	No
target	TargetConfig	Clase abstracta para la configuración de destino.	Sí
└─ Tipo	string	Tipo de la configuración del modelo.	Sí

Responses

Código de estado: 201

Descripción: la solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Tipo de contenido	Type	Descripción
application/json	RedTeam

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Horarios

Programaciones: lista

GET {endpoint}/schedules?api-version=v1

Enumera todas las programaciones.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
type	query	No	string Valores posibles: Evaluation, Insight	Filtre por el tipo de programación.
enabled	query	No	boolean	Filtre por el estado habilitado.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Schedules=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	PagedSchedule

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Programaciones: eliminar

DELETE {endpoint}/schedules/{id}?api-version=v1

Eliminar una programación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
id	path	Sí	string	Identificador de la programación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Schedules=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 204

Descripción: no hay contenido que enviar para esta solicitud, pero los encabezados pueden ser útiles.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Programaciones: obtener

GET {endpoint}/schedules/{id}?api-version=v1

Obtener una programación por identificador.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
id	path	Sí	string	Identificador de la programación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Schedules=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	Schedule

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Programaciones: creación o actualización

PUT {endpoint}/schedules/{id}?api-version=v1

Cree o actualice la plantilla de operación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
id	path	Sí	string	Identificador de la programación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Schedules=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Descripción de la programación.	No
displayName	string	Nombre de la programación.	No
enabled	boolean	Estado habilitado de la programación.	Sí
id	string (solo lectura)	Identificador de la programación.	Sí
properties	object	Propiedades de la programación. A diferencia de las etiquetas, las propiedades son de solo complemento. Una vez agregado, no se puede quitar una propiedad.	No
provisioningStatus	ScheduleProvisioningStatus (solo lectura)	Programar el estado de aprovisionamiento.	No
datos del sistema	objeto (solo lectura)	Metadatos del sistema para el recurso.	Sí
tags	object	Etiquetas de programación. A diferencia de las propiedades, las etiquetas son completamente mutables.	No
task	ScheduleTask	Modelo de tareas de programación.	Sí
Configuración de └	object	Configuración de la tarea.	No
└─ Tipo	ScheduleTaskType	Tipo de la tarea.	Sí
trigger	Trigger	Modelo base para el Disparador del horario.	Sí
└─ Tipo	Tipo de desencadenante	Tipo de desencadenante.	Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	Schedule

Código de estado: 201

Descripción: la solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Tipo de contenido	Type	Descripción
application/json	Schedule

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Programaciones: enumeración de ejecuciones

GET {endpoint}/schedules/{id}/runs?api-version=v1

Enumerar todas las ejecuciones de programación.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.
id	path	Sí	string	Identificador de la programación.
type	query	No	string Valores posibles: Evaluation, Insight	Filtre por el tipo de programación.
enabled	query	No	boolean	Filtre por el estado habilitado.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Schedules=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	PagedScheduleRun

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	Azure. Core.Foundations.ErrorResponse

Encabezados de respuesta:

Encabezado	Tipo	Description
x-ms-error-code	string	Código de error de cadena que indica lo que salió mal.

Programaciones: obtener ejecución

GET {endpoint}/schedules/{schedule_id}/runs/{run_id}?api-version=v1

Obtener una programación ejecutada por identificador.

Parámetros de URI

Nombre	In	Obligatorio	Tipo	Description
endpoint	path	Sí	string	Punto de conexión de Project foundry en el formulario "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Si solo tiene una Project en foundry Hub, o para tener como destino el Project predeterminado en el centro, use el formulario . "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
schedule_id	path	Sí	string	Identificador único de la programación.
identificador_de_ejecución	path	Sí	string	Identificador único de la ejecución de programación.
versión de la API	query	Sí	string	Versión de la API que se va a usar para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Foundry-Features	True	string Valores posibles: Schedules=V1Preview	Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Type	Descripción
application/json	ScheduleRun

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Type	Descripción
application/json	ApiErrorResponse

Components

A2APreviewTool

Un agente que implementa el protocolo A2A.

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_card_path	string	La ruta a la tarjeta de agente en relación con el base_urlarchivo . Si no se proporciona, el valor predeterminado es /.well-known/agent-card.json	No
base_url	string	URL base del agente.	No
project_connection_id	string	Identificador de conexión del project del servidor A2A. La conexión almacena la autenticación y otros detalles de conexión necesarios para conectarse al servidor A2A.	No
type	enum	Tipo de la herramienta. Siempre "a2a_preview. Valores posibles: a2a_preview	Sí

AISearchIndexResource

Un recurso de AI Search Index.

Nombre	Tipo	Description	Obligatorio	Predeterminado
filter	string	cadena de filtro para el recurso de búsqueda. Obtenga más información aquí.	No
index_asset_id	string	Id. de recurso de índice para el recurso de búsqueda.	No
nombre_del_indice	string	Nombre de un índice en un IndexResource asociado a este agente.	No
project_connection_id	string	Identificador de conexión de índice en un IndexResource asociado a este agente.	No
tipo_de_consulta	AzureAISearchQueryType	Tipos de consulta disponibles para la herramienta Búsqueda de Azure AI.	No
top_k	integer	Número de documentos que se van a recuperar de la búsqueda y presentarlos al modelo.	No

AgentClusterInsightRequest

Información sobre el conjunto de resultados de evaluación de agentes

Nombre	Tipo	Description	Obligatorio	Predeterminado
agentName	string	Identificador del agente.	Sí
modelConfiguration	InsightModelConfiguration	Configuración del modelo utilizado en la generación de información.	No
└] modelDeploymentName	string	Implementación del modelo que se va a evaluar. Acepta solo el nombre de implementación o con el nombre de conexión como {connectionName}/<modelDeploymentName>.	Sí
type	enum	Tipo de solicitud. Valores posibles: AgentClusterInsight	Sí

AgentClusterInsightResult

Información del análisis del clúster de agentes.

Nombre	Tipo	Description	Obligatorio	Predeterminado
clusterInsight	ClusterInsightResult	Información del análisis de clústeres.	Sí
type	enum	Tipo de resultado de información. Valores posibles: AgentClusterInsight	Sí

AgentContainerObject

Detalles del contenedor de una versión específica de un agente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
container	ContainerDetails (solo lectura)	Información detallada sobre el contenedor.	No
└" health_state	string	Estado de mantenimiento del contenedor.	Sí
└" provisioning_error	string	Error de aprovisionamiento del contenedor, si existe.	No
└" provisioning_state	string	Estado de aprovisionamiento del contenedor.	Sí
Réplicas └],	matriz de ContainerReplica	Lista de réplicas en el contenedor.	Sí
Estado └	string	Estado del contenedor.	Sí
└" updated_on	string	Hora de la última actualización del contenedor.	Sí
fecha_de_creación	string	Hora de creación del contenedor.	Sí
error_message	string (solo lectura)	Mensaje de error si el contenedor no pudo funcionar, si existe.	No
id	string (solo lectura)	Identificador del contenedor.	No
max_replicas	integer	Número máximo de réplicas para el contenedor. El valor predeterminado es 1.	No
min_replicas	integer	Número mínimo de réplicas para el contenedor. El valor predeterminado es 1.	No
object	enum	Tipo de objeto, que siempre es "agent.container". Valores posibles: agent.container	Sí
status	AgentContainerStatus (solo lectura)	Estado del contenedor de una versión específica de un agente.	Sí
updated_at	string	Hora de la última actualización del contenedor.	Sí

AgentContainerOperationError

Detalles del error de la operación de contenedor, si existe.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	string	Código de error de la operación de contenedor, si existe.	Sí
message	string	Mensaje de error de la operación de contenedor, si existe.	Sí
type	string	Tipo de error de la operación de contenedor, si existe.	Sí

AgentContainerOperationObject

Operación de contenedor para una versión específica de un agente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_id	string	Id. del agente.	Sí
agent_version_id	string	Identificador de la versión del agente.	Sí
container	AgentContainerObject	Detalles del contenedor de una versión específica de un agente.	No
Contenedor └	ContainerDetails (solo lectura)	Información detallada del contenedor.	No
└─ created_at	string (solo lectura)	Hora de creación del contenedor.	Sí
└" error_message	string (solo lectura)	Mensaje de error si el contenedor no pudo funcionar, si existe.	No
└─ id.	string (solo lectura)	Identificador del contenedor.	No
└" max_replicas	integer	Número máximo de réplicas para el contenedor. El valor predeterminado es 1.	No
└" min_replicas	integer	Número mínimo de réplicas para el contenedor. El valor predeterminado es 1.	No
└─ Objeto	enum	Tipo de objeto, que siempre es "agent.container". Valores posibles: agent.container	Sí
└─ estado	AgentContainerStatus (solo lectura)	Estado del contenedor de una versión específica de un agente.	Sí
└" updated_at	string (solo lectura)	Hora de la última actualización del contenedor.	Sí
error	AgentContainerOperationError	Detalles del error de la operación de contenedor, si existe.	No
└─ código	string	Código de error de la operación de contenedor, si existe.	Sí
└─ Mensaje	string	Mensaje de error de la operación de contenedor, si existe.	Sí
└─ Tipo	string	Tipo de error de la operación de contenedor, si existe.	Sí
id	string	Identificador de la operación de contenedor. Este identificador es un identificador único en todo el sistema.	Sí
status	AgentContainerOperationStatus	Estado de la operación de contenedor para una versión específica de un agente.	Sí

AgentContainerOperationStatus

Estado de la operación de contenedor para una versión específica de un agente.

Propiedad	Value
Type	string
Valores	NotStarted InProgress Succeeded Failed

AgentContainerStatus

Estado del contenedor de una versión específica de un agente.

Propiedad	Value
Type	string
Valores	Starting Running Stopping Stopped Failed Deleting Deleted Updating

AgentDefinition

Discriminador para AgentDefinition

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

Tipo de valor	Schema
prompt	PromptAgentDefinition
workflow	WorkflowAgentDefinition
hosted	HostedAgentDefinition
container_app	ContainerAppAgentDefinition

Nombre	Tipo	Description	Obligatorio	Predeterminado
amable	AgentKind		Sí
rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
└" rai_policy_name	string	Nombre de la directiva RAI que se va a aplicar.	Sí

AgentKind

Propiedad	Value
Type	string
Valores	prompt hosted container_app workflow

AgentObject

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	string	Identificador único del agente.	Sí
nombre	string	Nombre del agente. Restricciones: maxLength: 63	Sí
object	enum	Tipo de objeto, que siempre es "agente". Valores posibles: agent	Sí
versions	object	La versión más reciente del agente.	Sí
└— más reciente	AgentVersionObject		Sí

AgentProtocol

Propiedad	Value
Type	string
Valores	activity_protocol responses

AgentReference

Nombre	Tipo	Description	Obligatorio	Predeterminado
nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
type	enum	Valores posibles: agent_reference	Sí
version	string	Identificador de versión del agente.	No

AgentTaxonomyInput

Configuración de entrada para la taxonomía de evaluación cuando el tipo de entrada es agente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
riskCategories	matriz de RiskCategory	Lista de categorías de riesgo con las que se va a evaluar.	Sí
target	Target	Clase base para destinos con compatibilidad con discriminadores.	Sí
└─ Tipo	string	Tipo de destino.	Sí
type	enum	Tipo de entrada de la taxonomía de evaluación. Valores posibles: agent	Sí

AgentTaxonomyInputUpdate

Configuración de entrada para la taxonomía de evaluación cuando el tipo de entrada es agente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
riskCategories	matriz de RiskCategory	Lista de categorías de riesgo con las que se va a evaluar.	No
target	TargetUpdate	Clase base para destinos con compatibilidad con discriminadores.	No
└─ Tipo	string	Tipo de destino.	Sí
type	enum	Tipo de entrada de la taxonomía de evaluación. Valores posibles: agent	Sí

AgentVersionObject

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	integer	La marca de tiempo de Unix (segundos) cuando se creó el agente.	Sí
definición	AgentDefinition		Sí
description	string	Descripción legible del agente. Restricciones: maxLength: 512	No
id	string	Identificador único de la versión del agente.	Sí
metadatos	objeto (que acepta valores NULL)	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 una estructura formatear 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.	Sí
nombre	string	Nombre del agente. Name se puede usar para recuperar/actualizar/eliminar el agente. Restricciones: maxLength: 256	Sí
object	enum	El tipo de objeto, que siempre es 'agent.version'. Valores posibles: agent.version	Sí
version	string	Identificador de versión del agente. Los agentes son inmutables y cada actualización crea una nueva versión manteniendo el mismo nombre.	Sí

AgenticIdentityPreviewCredentials

Definición de credenciales de identidad agencial

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de credencial Valores posibles: AgenticIdentityToken_Preview	Sí

ApiErrorResponse

Respuesta de error para errores de API.

Nombre	Tipo	Description	Obligatorio	Predeterminado
error	OpenAI.Error		Sí

ApiKeyCredentials

Definición de credenciales de clave de API

Nombre	Tipo	Description	Obligatorio	Predeterminado
key	string (solo lectura)	Clave de API	No
type	enum	Tipo de credencial Valores posibles: ApiKey	Sí

AssetCredentialResponse

Representa una referencia a un blob para el consumo

Nombre	Tipo	Description	Obligatorio	Predeterminado
blobReference	BlobReference	Detalles de referencia de blobs.	Sí
└— blobUri	string	Ruta de acceso del URI del blob para que el cliente cargue datos. Ejemplo: https://blob.windows.core.net/Container/Path	Sí
Credencial de └	SasCredential	Información de credenciales para acceder a la cuenta de almacenamiento.	Sí
└] storageAccountArmId	string	Identificador de ARM de la cuenta de almacenamiento que se va a usar.	Sí

Identificador de activo

Identificador de un recurso guardado.

Tipo: cadena

AttackStrategy

Estrategias para los ataques.

Propiedad	Value
Descripción	Estrategias para los ataques.
Type	string
Valores	easy moderate difficult ascii_art ascii_smuggler atbash base64 binary caesar character_space jailbreak ansi_attack character_swap suffix_append string_join unicode_confusable unicode_substitution diacritic flip leetspeak rot13 morse url baseline indirect_jailbreak tense multi_turn crescendo

Azure. Core.Foundations.Error

Objeto de error.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	string	Uno de un conjunto definido por el servidor de códigos de error.	Sí
details	matriz de Azure. Core.Foundations.Error	Matriz de detalles sobre errores específicos que llevaron a este error notificado.	No
innererror	Azure. Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.	No
└─ código	string	Uno de un conjunto definido por el servidor de códigos de error.	No
└] innererror	Azure. Core.Foundations.InnerError	Error interno.	No
message	string	Representación legible del error.	Sí
target	string	Destino del error.	No

Azure. Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description	Obligatorio	Predeterminado
error	Azure. Core.Foundations.Error	Objeto de error.	Sí
└─ código	string	Uno de un conjunto definido por el servidor de códigos de error.	Sí
└─ detalles	matriz de Azure. Core.Foundations.Error	Matriz de detalles sobre errores específicos que llevaron a este error notificado.	No
└] innererror	Azure. Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.	No
└─ Mensaje	string	Representación legible del error.	Sí
Destino └	string	Destino del error.	No

Azure. Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las directrices de Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	string	Uno de un conjunto definido por el servidor de códigos de error.	No
innererror	Azure. Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.	No
└─ código	string	Uno de un conjunto definido por el servidor de códigos de error.	No
└] innererror	Azure. Core.Foundations.InnerError	Error interno.	No

Azure. Core.Foundations.OperationState

Enumeración que describe los estados de operación permitidos.

Propiedad	Value
Descripción	Enumeración que describe los estados de operación permitidos.
Type	string
Valores	NotStarted Running Succeeded Failed Canceled

Azure. Core.uuid

Identificador único universal

Tipo: cadena

Formato: uuid

AzureAIAgentTarget

Representa un objetivo que especifica un agente de IA de Azure.

Nombre	Tipo	Description	Obligatorio	Predeterminado
nombre	string	Identificador único del agente de inteligencia artificial de Azure.	Sí
tool_descriptions	matriz de ToolDescription	Los parámetros utilizados para controlar el comportamiento de muestreo del agente durante la generación de texto.	No
type	enum	El tipo de objetivo, siempre azure_ai_agent. Valores posibles: azure_ai_agent	Sí
version	string	La versión del agente de inteligencia artificial de Azure.	No

AzureAIAgentTargetUpdate

Representa un objetivo que especifica un agente de IA de Azure.

Nombre	Tipo	Description	Obligatorio	Predeterminado
nombre	string	Identificador único del agente de inteligencia artificial de Azure.	No
tool_descriptions	matriz de ToolDescription	Los parámetros utilizados para controlar el comportamiento de muestreo del agente durante la generación de texto.	No
type	enum	El tipo de objetivo, siempre azure_ai_agent. Valores posibles: azure_ai_agent	Sí
version	string	La versión del agente de inteligencia artificial de Azure.	No

AzureAIDataSourceConfig

Nombre	Tipo	Description	Obligatorio	Predeterminado
escenario	enum	Escenario de esquema de datos. Valores posibles: red_team, responses, traces_preview, synthetic_data_gen_preview	Sí
schema	object	Esquema JSON de objeto general para los elementos de origen de datos de ejecución.	Sí
type	enum	Tipo de objeto, que siempre azure_ai_sourcees . Valores posibles: azure_ai_source	Sí

AzureAIModelTarget

Representa un objetivo que especifica un modelo de IA de Azure para operaciones que requieren selección de modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
model	string	Identificador único del modelo de ia de Azure.	No
parámetros_de_muestreo	ModelSamplingParams	Representa un conjunto de parámetros usados para controlar el comportamiento de muestreo de un modelo de lenguaje durante la generación de texto.	No
└" max_completion_tokens	integer	Número máximo de tokens permitidos en la finalización.	Sí
└— semilla	integer	Inicialización aleatoria para la reproducibilidad.	Sí
└─ Temperatura	número	Parámetro de temperatura para el muestreo.	Sí
└─ top_p	número	Parámetro top-p para el muestreo de núcleos.	Sí
type	enum	El tipo de objetivo, siempre azure_ai_model. Valores posibles: azure_ai_model	Sí

AzureAIModelTargetUpdate

Representa un objetivo que especifica un modelo de IA de Azure para operaciones que requieren selección de modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
model	string	Identificador único del modelo de ia de Azure.	No
parámetros_de_muestreo	ModelSamplingParamsUpdate	Representa un conjunto de parámetros usados para controlar el comportamiento de muestreo de un modelo de lenguaje durante la generación de texto.	No
└" max_completion_tokens	integer	Número máximo de tokens permitidos en la finalización.	No
└— semilla	integer	Inicialización aleatoria para la reproducibilidad.	No
└─ Temperatura	número	Parámetro de temperatura para el muestreo.	No
└─ top_p	número	Parámetro top-p para el muestreo de núcleos.	No
type	enum	El tipo de objetivo, siempre azure_ai_model. Valores posibles: azure_ai_model	Sí

AzureAIResponsesEvalRunDataSource

Representa un origen de datos para ejecuciones de evaluación específicas de escenarios de evaluación continua.

Nombre	Tipo	Description	Obligatorio	Predeterminado
event_configuration_id	string	Nombre de configuración del evento asociado a esta ejecución de evaluación.	Sí
item_generation_params	ResponseRetrievalItemGenerationParams	Representa los parámetros para la generación de elementos de recuperación de respuesta.	Sí
└" data_mapping	object	Asignación de campos de origen a response_id campo, necesario para recuperar el historial de chats.	Sí
└" max_num_turns	integer	Número máximo de turnos del historial de chat que se va a evaluar.	Sí
└─ Origen	OpenAI.EvalJsonlFileContentSource o OpenAI.EvalJsonlFileIdSource	Origen desde el que se lee el contenido JSONL.	Sí
└─ Tipo	enum	Tipo de parámetros de generación de elementos, siempre response_retrieval. Valores posibles: response_retrieval	Sí
max_runs_hourly	integer	Número máximo de ejecuciones de evaluación permitidas por hora.	Sí
type	enum	Tipo de origen de datos, siempre azure_ai_responses. Valores posibles: azure_ai_responses	Sí

AzureAISearchIndex

definición de índice de Búsqueda de Azure AI

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	string (solo lectura)	ID de activo, un identificador único para el activo	No
nombre	string (solo lectura)	Nombre del recurso.	Sí
type	enum	Tipo de índice Valores posibles: AzureSearch	Sí
version	string (solo lectura)	La versión del recurso	Sí

AzureAISearchIndexUpdate

definición de índice de Búsqueda de Azure AI

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Texto de descripción del recurso.	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
type	enum	Tipo de índice Valores posibles: AzureSearch	Sí

AzureAISearchQueryType

Tipos de consulta disponibles para la herramienta Búsqueda de Azure AI.

Propiedad	Value
Descripción	Tipos de consulta disponibles para la herramienta Búsqueda de Azure AI.
Type	string
Valores	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

AzureAISearchTool

La información de definición de entrada para una herramienta de búsqueda de IA de Azure utilizada para configurar un agente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
azure_ai_search	AzureAISearchToolResource	Conjunto de recursos de índice utilizados por la herramienta azure_ai_search.	Sí
Índices └	matriz de AISearchIndexResource	Índices adjuntos a este agente. Puede haber un máximo de 1 índice. recurso asociado al agente. Restricciones: maxItems: 1	Sí
type	enum	El tipo de objeto, que siempre es 'azure_ai_search'. Valores posibles: azure_ai_search	Sí

AzureAISearchToolResource

Conjunto de recursos de índice utilizados por la herramienta azure_ai_search.

Nombre	Tipo	Description	Obligatorio	Predeterminado
índices	matriz de AISearchIndexResource	Índices adjuntos a este agente. Puede haber un máximo de 1 índice. recurso asociado al agente.	Sí

AzureFunctionBinding

Estructura para mantener storage nombre y URI de la cola.

Nombre	Tipo	Description	Obligatorio	Predeterminado
storage_queue	AzureFunctionStorageQueue	Estructura para mantener storage nombre y URI de la cola.	Sí
└" queue_name	string	Nombre de una cola de almacenamiento de Azure función.	Sí
└" queue_service_endpoint	string	URI a la Azure Storage Queue Service, lo que le permite manipular una cola.	Sí
type	enum	Tipo de enlace, que siempre es "storage_queue". Valores posibles: storage_queue	Sí

AzureFunctionDefinition

La definición de función Azure.

Nombre	Tipo	Description	Obligatorio	Predeterminado
function	object	Definición de la función de Azure y sus parámetros.	Sí
└─ Descripción	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á.	Sí
Parámetros └	object	Los parámetros que aceptan las funciones, que se describen como un objeto de esquema JSON.	Sí
input_binding	AzureFunctionBinding	Estructura para mantener storage nombre y URI de la cola.	Sí
└" storage_queue	AzureFunctionStorageQueue	Cola de almacenamiento.	Sí
└─ Tipo	enum	Tipo de enlace, que siempre es "storage_queue". Valores posibles: storage_queue	Sí
output_binding	AzureFunctionBinding	Estructura para mantener storage nombre y URI de la cola.	Sí
└" storage_queue	AzureFunctionStorageQueue	Cola de almacenamiento.	Sí
└─ Tipo	enum	Tipo de enlace, que siempre es "storage_queue". Valores posibles: storage_queue	Sí

AzureFunctionStorageQueue

Estructura para mantener storage nombre y URI de la cola.

Nombre	Tipo	Description	Obligatorio	Predeterminado
queue_name	string	Nombre de una cola de almacenamiento de Azure función.	Sí
queue_service_endpoint	string	URI a la Azure Storage Queue Service, lo que le permite manipular una cola.	Sí

AzureFunctionTool

La información de definición de entrada para una Herramienta de Función de Azure, tal como se usa para configurar un Agente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
azure_function	AzureFunctionDefinition	La definición de función Azure.	Sí
Función └	object	Definición de la función de Azure y sus parámetros.	Sí
└─ Descripción	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á.	Sí
Parámetros └	object	Los parámetros que aceptan las funciones, que se describen como un objeto de esquema JSON.	Sí
└" input_binding	AzureFunctionBinding	Cola de almacenamiento de entrada. El desencadenador de Queue Storage ejecuta una función a medida que se agregan mensajes.	Sí
└" output_binding	AzureFunctionBinding	Cola de almacenamiento de salida. La función escribe la salida en esta cola cuando se procesan los elementos de entrada.	Sí
type	enum	El tipo de objeto, que siempre es 'browser_automation'. Valores posibles: azure_function	Sí

AzureOpenAIModelConfiguration

Azure configuración del modelo openAI. El servicio seleccionaría la versión de la API para consultar el modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
modelDeploymentName	string	Nombre de implementación para el modelo de AOAI. Ejemplo: gpt-4o si está en AIServices o en función connection_name/deployment_name de la conexión (por ejemplo, my-aoai-connection/gpt-4o).	Sí
type	enum	Valores posibles: AzureOpenAIModel	Sí

BaseCredentials

Una clase base para las credenciales de conexión

Discriminador para BaseCredentials

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

Tipo de valor	Schema
ApiKey	ApiKeyCredentials
AAD	EntraIDCredentials
CustomKeys	CustomCredential
SAS	SASCredentials
None	NoAuthenticationCredentials
AgenticIdentityToken_Preview	AgenticIdentityPreviewCredentials

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	CredentialType (solo lectura)	El tipo de credencial utilizado por la conexión	Sí

BingCustomSearchConfiguration

Una bing configuración de búsqueda personalizada.

Nombre	Tipo	Description	Obligatorio	Predeterminado
count	integer	Número de resultados de búsqueda que se van a devolver en la respuesta de bing api.	No
freshness	string	Filtre los resultados de búsqueda por un intervalo de tiempo específico. Consulte los valores aceptados aquí.	No
nombre_instancia	string	Nombre de la instancia de configuración personalizada dada a config.	Sí
mercado	string	El mercado del que proceden los resultados.	No
project_connection_id	string	Project identificador de conexión para conectar con Bing Search	Sí
set_lang	string	Idioma que se va a usar para las cadenas de interfaz de usuario al llamar a Bing API.	No

BingCustomSearchPreviewTool

La información de definición de entrada de un Bing herramienta de búsqueda personalizada como se usa para configurar un agente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
bing_custom_search_preview	BingCustomSearchToolParameters	El bing parámetros de la herramienta de búsqueda personalizada.	Sí
└" search_configurations	matriz de BingCustomSearchConfiguration	La project conexiones conectadas a esta herramienta. Puede haber un máximo de 1 conexión. recurso asociado a la herramienta. Restricciones: maxItems: 1	Sí
type	enum	El tipo de objeto, que siempre es 'bing_custom_search_preview'. Valores posibles: bing_custom_search_preview	Sí

BingCustomSearchToolParameters

El bing parámetros de la herramienta de búsqueda personalizada.

Nombre	Tipo	Description	Obligatorio	Predeterminado
search_configurations	matriz de BingCustomSearchConfiguration	La project conexiones conectadas a esta herramienta. Puede haber un máximo de 1 conexión. recurso asociado a la herramienta.	Sí

BingGroundingSearchConfiguration

Configuración de búsqueda para Bing grounding

Nombre	Tipo	Description	Obligatorio	Predeterminado
count	integer	Número de resultados de búsqueda que se van a devolver en la respuesta de bing api.	No
freshness	string	Filtre los resultados de búsqueda por un intervalo de tiempo específico. Consulte los valores aceptados aquí.	No
mercado	string	El mercado del que proceden los resultados.	No
project_connection_id	string	Project identificador de conexión para conectar con Bing Search	Sí
set_lang	string	Idioma que se va a usar para las cadenas de interfaz de usuario al llamar a Bing API.	No

BingGroundingSearchToolParameters

Parámetros de la herramienta de búsqueda bing base.

Nombre	Tipo	Description	Obligatorio	Predeterminado
search_configurations	matriz de BingGroundingSearchConfiguration	Las configuraciones de búsqueda asociadas a esta herramienta. Puede haber un máximo de 1 recurso de configuración de búsqueda asociado a la herramienta.	Sí

BingGroundingTool

La información de definición de entrada de una herramienta de búsqueda de bing base como se usa para configurar un agente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
bing_grounding	BingGroundingSearchToolParameters	Parámetros de la herramienta de búsqueda bing base.	Sí
└" search_configurations	matriz de BingGroundingSearchConfiguration	Las configuraciones de búsqueda asociadas a esta herramienta. Puede haber un máximo de 1 recurso de configuración de búsqueda asociado a la herramienta. Restricciones: maxItems: 1	Sí
type	enum	Tipo de objeto, que siempre es "bing_grounding". Valores posibles: bing_grounding	Sí

BlobReference

Detalles de referencia de blobs.

Nombre	Tipo	Description	Obligatorio	Predeterminado
blobUri	string	Ruta de acceso del URI del blob para que el cliente cargue datos. Ejemplo: https://blob.windows.core.net/Container/Path	Sí
credential	SasCredential	Definición de credenciales de SAS	Sí
└— sasUri	string (solo lectura)	URI de SAS	Sí
└─ Tipo	enum	Tipo de credencial Valores posibles: SAS	Sí
storageAccountArmId	string	Identificador de ARM de la cuenta de almacenamiento que se va a usar.	Sí

BrowserAutomationPreviewTool

La información de definición de entrada para una herramienta de automatización del navegador, tal como se usa para configurar un agente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
browser_automation_preview	BrowserAutomationToolParameters	Definición de parámetros de entrada para la herramienta de automatización del navegador.	Sí
Conexión └	BrowserAutomationToolConnectionParameters	Parámetros de conexión del proyecto asociados a la herramienta de automatización del explorador.	Sí
type	enum	El tipo de objeto, que siempre es 'browser_automation_preview'. Valores posibles: browser_automation_preview	Sí

BrowserAutomationToolConnectionParameters

Definición de parámetros de entrada para la conexión utilizada por la herramienta de automatización del navegador.

Nombre	Tipo	Description	Obligatorio	Predeterminado
project_connection_id	string	Identificador de la conexión del proyecto al recurso Azure Playwright.	Sí

BrowserAutomationToolParameters

Definición de parámetros de entrada para la herramienta de automatización del navegador.

Nombre	Tipo	Description	Obligatorio	Predeterminado
conexión	BrowserAutomationToolConnectionParameters	Definición de parámetros de entrada para la conexión utilizada por la herramienta de automatización del navegador.	Sí
└" project_connection_id	string	Identificador de la conexión del proyecto al recurso Azure Playwright.	Sí

CaptureStructuredOutputsTool

Una herramienta para capturar resultados estructurados

Nombre	Tipo	Description	Obligatorio	Predeterminado
salidas	StructuredOutputDefinition	Salida estructurada que el agente puede generar.	Sí
└─ Descripción	string	Descripción de la salida que se va a emitir. Usado por el modelo para determinar cuándo emitir la salida.	Sí
└─ Nombre	string	Nombre de la salida estructurada.	Sí
└─ Esquema	object	Esquema JSON para la salida estructurada.	Sí
└─ estricto	booleano (que acepta valores NULL)	Si se aplica una validación estricta. Por defecto true.	Sí
type	enum	Tipo de la herramienta. Siempre capture_structured_outputs. Valores posibles: capture_structured_outputs	Sí

ChartCoordinate

Coordenadas para el gráfico de análisis.

Nombre	Tipo	Description	Obligatorio	Predeterminado
size	integer	Tamaño del elemento de gráfico.	Sí
x	integer	Coordenada del eje X.	Sí
y	integer	Coordenada del eje Y.	Sí

ChatSummaryMemoryItem

Un elemento de memoria que contiene un resumen extraído de conversaciones.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	string	El contenido de la memoria.	Sí
amable	enum	El tipo del elemento de memoria. Valores posibles: chat_summary	Sí
memory_id	string	El identificador único del elemento de memoria.	Sí
scope	string	El espacio de nombres que agrupa y aísla lógicamente las memorias, como un ID de usuario.	Sí
updated_at	integer	La hora de la última actualización del elemento de memoria.	Sí

ClusterInsightResult

Información del análisis de clústeres.

Nombre	Tipo	Description	Obligatorio	Predeterminado
clusters	matriz de InsightCluster	Lista de clústeres identificados en la información.	Sí
Coordenadas	object	Asignación opcional de identificadores a coordenadas 2D usadas por la experiencia de usuario para la visualización. Las claves de asignación son identificadores de cadena (por ejemplo, un identificador de clúster o un identificador de ejemplo). y los valores son las coordenadas y el tamaño visual para la representación en un gráfico 2D. Esta propiedad se omite a menos que el cliente solicite coordenadas (por ejemplo, pasando includeCoordinates=true como parámetro de consulta). Ejemplo: <br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br> Las coordenadas solo están pensadas para la visualización del lado cliente y no modifique los resultados de la información canónica.	No
summary	InsightSummary	Resumen del análisis de conglomerados de errores.	Sí
Método └	string	Método usado para la agrupación en clústeres.	Sí
└— sampleCount	integer	Número total de muestras analizadas.	Sí
└— uniqueClusterCount	integer	Número total de clústeres únicos.	Sí
└— uniqueSubclusterCount	integer	Número total de etiquetas de subcluster únicas.	Sí
└─ uso	ClusterTokenUsage	Uso de tokens al realizar análisis de agrupación en clústeres	Sí

ClusterTokenUsage

Uso de tokens para el análisis de clústeres

Nombre	Tipo	Description	Obligatorio	Predeterminado
inputTokenUsage	integer	uso del token de entrada	Sí
outputTokenUsage	integer	uso del token de salida	Sí
totalTokenUsage	integer	uso total de tokens	Sí

CodeBasedEvaluatorDefinition

Definición de evaluador basada en código usando código python

Nombre	Tipo	Description	Obligatorio	Predeterminado
code_text	string	Texto de código insertado para el evaluador	Sí
data_schema	object	El esquema JSON (Borrador 2020-12) para los datos de entrada del evaluador. Esto incluye parámetros como tipo, propiedades, obligatorio.	No
init_parameters	object	El esquema JSON (Borrador 2020-12) para los parámetros de entrada del evaluador. Esto incluye parámetros como tipo, propiedades, obligatorio.	No
metrics	object	Lista de métricas de salida producidas por este evaluador	No
type	enum	Valores posibles: code	Sí

CompletionMessageToolCallChunk

Detalles de la llamada de herramienta dentro de un mensaje.

Nombre	Tipo	Description	Obligatorio	Predeterminado
function	FunctionToolCall	Detalles de una llamada a la herramienta de función.	No
└ Argumentos	string	Los argumentos para llamar a la función con, tal como se genera el modelo en formato JSON.	Sí
└─ Nombre	string	El nombre de la función para llamar.	Sí
id	string	Identificador de la llamada a la herramienta.	Sí
type	enum	Tipo de llamada a herramienta, que siempre es "function". Valores posibles: function	Sí

Conexión

Operaciones de respuesta de la lista y obtención de conexiones

Nombre	Tipo	Description	Obligatorio	Predeterminado
credentials	BaseCredentials (solo lectura)	Una clase base para las credenciales de conexión	Sí
└─ Tipo	CredentialType (solo lectura)	Tipo de credencial usada por la conexión	Sí
id	string (solo lectura)	Identificador único de la conexión, generada por el servicio	Sí
isDefault	booleano (solo lectura)	Si la conexión se etiqueta como la conexión predeterminada de su tipo	Sí
metadatos	objeto (solo lectura)	Metadatos de la conexión	Sí
nombre	string (solo lectura)	Nombre descriptivo de la conexión, proporcionado por el usuario.	Sí
target	string (solo lectura)	Dirección URL de conexión que se va a usar para este servicio	Sí
type	ConnectionType (solo lectura)	Tipo (o categoría) de la conexión	Sí

ConnectionType

Tipo (o categoría) de la conexión

Propiedad	Value
Descripción	Tipo (o categoría) de la conexión
Type	string
Valores	AzureOpenAI AzureBlob AzureStorageAccount CognitiveSearch CosmosDB ApiKey AppConfig AppInsights CustomKeys RemoteTool_Preview

ContainerAppAgentDefinition

Definición del agente de aplicación contenedor.

Nombre	Tipo	Description	Obligatorio	Predeterminado
container_app_resource_id	string	Identificador de recurso de la aplicación contenedora de Azure que hospeda este agente. No se puede mutable entre versiones.	Sí
container_protocol_versions	matriz de ProtocolVersionRecord	Los protocolos que admite el agente para la comunicación de entrada de los contenedores.	Sí
ingress_subdomain_suffix	string	Sufijo que se va a aplicar al subdominio de la aplicación al enviar la entrada al agente. Puede ser una etiqueta (por ejemplo, "---current", una revisión específica (por ejemplo, "--0000001" o vacía para usar el punto de conexión predeterminado para la aplicación contenedora.	Sí
amable	enum	Valores posibles: container_app	Sí
rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
└" rai_policy_name	string	Nombre de la directiva RAI que se va a aplicar.	Sí

ContainerDetails

Información detallada sobre el contenedor.

Nombre	Tipo	Description	Obligatorio	Predeterminado
health_state	string	Estado de mantenimiento del contenedor.	Sí
provisioning_error	string	Error de aprovisionamiento del contenedor, si existe.	No
provisioning_state	string	Estado de aprovisionamiento del contenedor.	Sí
replicas	matriz de ContainerReplica	Lista de réplicas en el contenedor.	Sí
state	string	Estado del contenedor.	Sí
updated_on	string	Hora de la última actualización del contenedor.	Sí

ContainerLogKind

Tipo de registros que se van a transmitir desde un contenedor.

Propiedad	Value
Type	string
Valores	console system

ContainerReplica

Información sobre una réplica de contenedor.

Nombre	Tipo	Description	Obligatorio	Predeterminado
container_state	string	Estado del contenedor de la réplica.	Sí
nombre	string	Nombre de la réplica.	Sí
state	string	Estado de la réplica.	Sí

ContinuousEvaluationRuleAction

Acción de regla de evaluación para la evaluación continua.

Nombre	Tipo	Description	Obligatorio	Predeterminado
evalId	string	Id. de Eval para agregar ejecuciones de evaluación continua.	Sí
maxHourlyRuns	integer	Número máximo de ejecuciones de evaluación permitidas por hora.	No
type	enum	Valores posibles: continuousEvaluation	Sí

CosmosDBÍndice

Definición de índice de almacén de vectores de CosmosDB

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	string (solo lectura)	ID de activo, un identificador único para el activo	No
nombre	string (solo lectura)	Nombre del recurso.	Sí
type	enum	Tipo de índice Valores posibles: CosmosDBNoSqlVectorStore	Sí
version	string (solo lectura)	La versión del recurso	Sí

CosmosDBIndexUpdate

Definición de índice de almacén de vectores de CosmosDB

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Texto de descripción del recurso.	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
type	enum	Tipo de índice Valores posibles: CosmosDBNoSqlVectorStore	Sí

CreateAgentFromManifestRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Descripción legible del agente. Restricciones: maxLength: 512	No
manifest_id	string	Identificador de manifiesto desde el que se va a importar la versión del agente.	Sí
metadatos	object	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 una estructura formatear 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.	No
nombre	string	Nombre único que identifica al agente. Name se puede usar para recuperar/actualizar/eliminar el agente. - Debe comenzar y terminar con caracteres alfanuméricos, - Puede contener guiones en el centro - No debe superar los 63 caracteres. Restricciones: maxLength: 63	Sí
parameter_values	object	Las entradas del manifiesto que darán lugar a un agente totalmente materializado.	Sí

CreateAgentRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
definición	AgentDefinition		Sí
└└ kind	AgentKind		Sí
└" rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
description	string	Descripción legible del agente. Restricciones: maxLength: 512	No
metadatos	object	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 una estructura formatear 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.	No
nombre	string	Nombre único que identifica al agente. Name se puede usar para recuperar/actualizar/eliminar el agente. - Debe comenzar y terminar con caracteres alfanuméricos, - Puede contener guiones en el centro - No debe superar los 63 caracteres. Restricciones: maxLength: 63	Sí

CreateAgentVersionFromManifestRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Descripción legible del agente. Restricciones: maxLength: 512	No
manifest_id	string	Identificador de manifiesto desde el que se va a importar la versión del agente.	Sí
metadatos	object	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 una estructura formatear 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.	No
parameter_values	object	Las entradas del manifiesto que darán lugar a un agente totalmente materializado.	Sí

CreateAgentVersionRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
definición	AgentDefinition		Sí
└└ kind	AgentKind		Sí
└" rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
description	string	Descripción legible del agente. Restricciones: maxLength: 512	No
metadatos	object	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 una estructura formatear 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.	No

CrearSolicitudDeEvaluación

Nombre	Tipo	Description	Obligatorio	Predeterminado
configuración_de_fuente_de_datos	OpenAI.CreateEvalCustomDataSourceConfig o OpenAI.CreateEvalLogsDataSourceConfig o OpenAI.CreateEvalStoredCompletionsDataSourceConfig o AzureAIDataSourceConfig	Configuración del origen de datos usado para las ejecuciones de evaluación. Dicta el esquema de los datos usados en la evaluación.	Sí
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
nombre	string	Nombre de la evaluación.	No
properties	object	Conjunto de pares clave-valor inmutables de 16 que se pueden adjuntar a un objeto para almacenar información adicional. Las claves son cadenas con una longitud máxima de 64 caracteres. Los valores son cadenas con una longitud máxima de 512 caracteres.	No
criterios_de_prueba	matriz de OpenAI.EvalGraderLabelModel o OpenAI.EvalGraderStringCheck o OpenAI.EvalGraderTextSimilarity o OpenAI.EvalGraderPython o OpenAI.EvalGraderScoreModel o EvalGraderAzureAIEvaluator	Una lista de evaluadores para todas las ejecuciones de evaluación en este grupo. Los calificadores pueden hacer referencia a variables en el origen de datos mediante la notación de llaves dobles, como {{item.variable_name}}. Para hacer referencia a la salida del modelo, use el sample espacio de nombres (es decir, {{sample.output_text}}).	Sí

CreateEvalRunRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
fuente_de_datos	OpenAI.CreateEvalJsonlRunDataSource o OpenAI.CreateEvalCompletionsRunDataSource o OpenAI.CreateEvalResponsesRunDataSource o EvalRunDataSource	Detalles sobre el origen de datos de la ejecución.	Sí
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
nombre	string	Nombre de la ejecución.	No
properties	object	Conjunto de pares clave-valor inmutables de 16 que se pueden adjuntar a un objeto para almacenar información adicional. Las claves son cadenas con una longitud máxima de 64 caracteres. Los valores son cadenas con una longitud máxima de 512 caracteres.	No

CredentialType

El tipo de credencial utilizado por la conexión

Propiedad	Value
Descripción	El tipo de credencial utilizado por la conexión
Type	string
Valores	ApiKey AAD SAS CustomKeys None AgenticIdentityToken_Preview

CronTrigger

Disparador basado en cron.

Nombre	Tipo	Description	Obligatorio	Predeterminado
endTime	string	Hora de finalización de la programación cron en formato ISO 8601.	No
expression	string	Expresión cron que define la frecuencia de programación.	Sí
startTime	string	Hora de inicio de la programación cron en formato ISO 8601.	No
timeZone	string	Zona horaria para el cron schedule.	No	UTC
type	enum	Valores posibles: Cron	Sí

CustomCredential

Definición de credenciales personalizadas

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de credencial Valores posibles: CustomKeys	Sí

Este objeto también acepta propiedades adicionales de tipo: cadena

DailyRecurrenceSchedule

Calendario diario de recurrencia.

Nombre	Tipo	Description	Obligatorio	Predeterminado
hours	matriz de enteros	Horas para la programación de periodicidad.	Sí
type	enum	Tipo de periodicidad diaria. Valores posibles: Daily	Sí

DataSourceConfig

Clase base para ejecutar orígenes de datos con compatibilidad con discriminadores.

Discriminador para DataSourceConfig

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

Tipo de valor	Schema

Nombre	Tipo	Description	Obligatorio	Predeterminado
schema	object	Esquema JSON de objeto general para los elementos de origen de datos de ejecución.	Sí
type	string	El discriminador del tipo de origen de datos.	Sí

DatasetType

Enumeración para determinar el tipo de datos.

Propiedad	Value
Descripción	Enumeración para determinar el tipo de datos.
Type	string
Valores	uri_file uri_folder

DatasetVersion

Definición de DatasetVersion

Discriminador para DatasetVersion

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

Tipo de valor	Schema
uri_file	FileDatasetVersion
uri_folder	FolderDatasetVersion

Nombre	Tipo	Description	Obligatorio	Predeterminado
connectionName	string	Nombre de la conexión de la cuenta de Azure Storage. Obligatorio si no se llamó a startPendingUploadVersion antes de crear el conjunto de datos	No
dataUri	string	URI de los datos (ejemplo) Restricciones: minLength: 1, patrón: [a-zA-Z0-9_]	Sí
id	string (solo lectura)	ID de activo, un identificador único para el activo	No
isReference	booleano (solo lectura)	Indica si el conjunto de datos contiene una referencia al almacenamiento o el conjunto de datos administra el propio almacenamiento. Si es true, los datos subyacentes no se eliminarán cuando se elimine la versión del conjunto de datos.	No
nombre	string (solo lectura)	Nombre del recurso.	Sí
type	DatasetType	Enumeración para determinar el tipo de datos.	Sí
version	string (solo lectura)	La versión del recurso	Sí

DatasetVersionUpdate

Definición de DatasetVersion

Discriminador para DatasetVersionUpdate

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

Tipo de valor	Schema
uri_file	FileDatasetVersionUpdate
uri_folder	FolderDatasetVersionUpdate

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Texto de descripción del recurso.	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
type	DatasetType	Enumeración para determinar el tipo de datos.	Sí

DayOfWeek

Días de la semana para el programa de recurrencia.

Propiedad	Value
Descripción	Días de la semana para el programa de recurrencia.
Type	string
Valores	Sunday Monday Tuesday Wednesday Thursday Friday Saturday

DeleteAgentResponse

Un objeto de agente eliminado

Nombre	Tipo	Description	Obligatorio	Predeterminado
eliminado	boolean	Si el agente se eliminó correctamente.	Sí
nombre	string	Nombre del agente.	Sí
object	enum	Tipo de objeto. Siempre 'agent.deleted'. Valores posibles: agent.deleted	Sí

DeleteAgentVersionResponse

Un objeto de versión de agente eliminado

Nombre	Tipo	Description	Obligatorio	Predeterminado
eliminado	boolean	Si el agente se eliminó correctamente.	Sí
nombre	string	Nombre del agente.	Sí
object	enum	Tipo de objeto. Siempre 'agent.version.deleted'. Valores posibles: agent.version.deleted	Sí
version	string	Identificador de versión del agente.	Sí

DeleteEvalResponse

Objeto de evaluación eliminado

Nombre	Tipo	Description	Obligatorio	Predeterminado
eliminado	boolean	Si la evaluación se eliminó correctamente.	Sí
eval_id	string	id de la eval.	Sí
object	enum	Tipo de objeto. Siempre 'eval.deleted'. Valores posibles: eval.deleted	Sí

DeleteEvalRunResponse

Un objeto de ejecución de evaluación eliminado.

Nombre	Tipo	Description	Obligatorio	Predeterminado
eliminado	boolean	Si la evaluación se eliminó correctamente.	No
object	enum	Tipo de objeto. Siempre 'eval.deleted'. Valores posibles: eval.deleted	No
identificador_de_ejecución	string	id de la eval.	No

DeleteMemoryStoreResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
eliminado	boolean	Si el almacén de memoria se eliminó correctamente.	Sí
nombre	string	Nombre del almacén de memoria.	Sí
object	enum	Tipo de objeto. Siempre "memory_store.deleted". Valores posibles: memory_store.deleted	Sí

DeleteResponseResult

Resultado de una operación de eliminación de respuesta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
eliminado	enum	Devolver siempre true Valores posibles: True	Sí
id	string	Identificador de la operación.	Sí
object	enum	Devuelve siempre "response". Valores posibles: response	Sí

Deployment

Definición de implementación de modelo

Discriminador para la implementación

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

Tipo de valor	Schema
ModelDeployment	ModelDeployment

Nombre	Tipo	Description	Obligatorio	Predeterminado
nombre	string (solo lectura)	Nombre de la implementación	Sí
type	DeploymentType		Sí

TipoDeDespliegue

Propiedad	Value
Type	string
Valores	ModelDeployment

EntraIDCredentials

Definición de credenciales Entra ID

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de credencial Valores posibles: AAD	Sí

Eval

Objeto Eval con una configuración de origen de datos y criterios de prueba. Una Evaluación representa una tarea que debe realizarse para la integración de LLM. Como:

• Mejora de la calidad de mi bot de chat
• Ver cómo mi bot de chat controla el soporte técnico al cliente
• Compruebe si o4-mini es mejor en mi caso que gpt-4o

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	integer	Marca de tiempo de Unix (en segundos) para cuando se creó la ejecución.	Sí
created_by	string	el nombre de la persona que creó la ejecución.	No
configuración_de_fuente_de_datos	OpenAI.CreateEvalCustomDataSourceConfig o OpenAI.CreateEvalLogsDataSourceConfig o OpenAI.CreateEvalStoredCompletionsDataSourceConfig o AzureAIDataSourceConfig	Configuración de orígenes de datos usados en ejecuciones de la evaluación.	Sí
id	string	Identificador único de la evaluación.	Sí
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	Sí
modified_at	entero		No
nombre	string	Nombre de la evaluación.	Sí
object	enum	Tipo de objeto. Valores posibles: eval	Sí
properties	object	Conjunto de pares clave-valor inmutables de 16 que se pueden adjuntar a un objeto para almacenar información adicional. Las claves son cadenas con una longitud máxima de 64 caracteres. Los valores son cadenas con una longitud máxima de 512 caracteres.	No
criterios_de_prueba	matriz de OpenAI.EvalGraderLabelModel o OpenAI.EvalGraderStringCheck o OpenAI.EvalGraderTextSimilarity o OpenAI.EvalGraderPython o OpenAI.EvalGraderScoreModel o EvalGraderAzureAIEvaluator	Lista de criterios de prueba.	Sí

EvalCsvFileIdSource

Representa una referencia a un archivo CSV cargado que se usa como origen para los datos de evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	string	Identificador del archivo CSV cargado.	Sí
type	enum	Tipo de origen, siempre file_id. Valores posibles: file_id	Sí

EvalCsvRunDataSource

Representa un origen de datos CSV para las ejecuciones de evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
source	EvalCsvFileIdSource	Representa una referencia a un archivo CSV cargado que se usa como origen para los datos de evaluación.	Sí
└─ id.	string	Identificador del archivo CSV cargado.	Sí
└─ Tipo	enum	Tipo de origen, siempre file_id. Valores posibles: file_id	Sí
type	enum	Tipo de origen de datos, siempre csv. Valores posibles: csv	Sí

EvalGraderAzureAIEvaluator

Nombre	Tipo	Description	Obligatorio	Predeterminado
mapeo de datos	object	Modelo que se va a usar para la evaluación. Debe admitir salidas estructuradas.	No
evaluator_name	string	Nombre del evaluador.	Sí
evaluator_version	string	Versión del evaluador. Versión más reciente si no se especifica.	No
initialization_parameters	object	Parámetros de inicialización para la evaluación. Debe admitir salidas estructuradas.	No
nombre	string	Nombre del calificador.	Sí
type	enum	Tipo de objeto, que siempre azure_ai_evaluatores . Valores posibles: azure_ai_evaluator	Sí

EvalResult

Resultado de la evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
nombre	string	nombre de la comprobación	Sí
pasado	boolean	indica si se ha superado la comprobación o se ha producido un error.	Sí
puntuación	número	puntuación	Sí
type	string	tipo de la comprobación	Sí

EvalRun

Esquema que representa una ejecución de evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	integer	Marca de tiempo de Unix (en segundos) cuando se creó el proceso de evaluación.	Sí
created_by	string	el nombre de la persona que creó la ejecución.	No
fuente_de_datos	OpenAI.CreateEvalJsonlRunDataSource o OpenAI.CreateEvalCompletionsRunDataSource o OpenAI.CreateEvalResponsesRunDataSource o EvalRunDataSource	Información sobre el origen de datos de la ejecución.	Sí
error	OpenAI.EvalApiError	Objeto que representa una respuesta de error de la API de Eval.	Sí
eval_id	string	Identificador de la evaluación asociada.	Sí
id	string	Identificador único de la ejecución de la evaluación.	Sí
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	Sí
model	string	Modelo que se evalúa, si procede.	Sí
modified_at	entero		No
nombre	string	Nombre de la ejecución de evaluación.	Sí
object	enum	Tipo del objeto. Siempre "eval.run". Valores posibles: eval.run	Sí
per_model_usage	matriz de OpenAI.EvalRunPerModelUsage	Estadísticas de uso de cada modelo durante la ejecución de evaluación.	Sí
resultados_por_criterios_de_pruebas	matriz de OpenAI.EvalRunPerTestingCriteriaResults	Resultados por criterios de prueba aplicados durante la ejecución de la evaluación.	Sí
properties	object	Conjunto de pares clave-valor inmutables de 16 que se pueden adjuntar a un objeto para almacenar información adicional. Las claves son cadenas con una longitud máxima de 64 caracteres. Los valores son cadenas con una longitud máxima de 512 caracteres.	No
report_url	string	Dirección URL del informe de ejecución de evaluación representado en el panel de la interfaz de usuario.	Sí
conteo_de_resultados	OpenAI.EvalRunResultCounts		Sí
Errores └	OpenAI.integer		Sí
└─ fallido	OpenAI.integer		Sí
└─ aprobado	OpenAI.integer		Sí
└─ total	OpenAI.integer		Sí
status	string	Estado de la ejecución de la evaluación.	Sí

EvalRunDataSource

Clase base para ejecutar orígenes de datos con compatibilidad con discriminadores.

Discriminador para EvalRunDataSource

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

Tipo de valor	Schema
azure_ai_traces_preview	TracesPreviewEvalRunDataSource
azure_ai_synthetic_data_gen_preview	SyntheticDataGenerationPreviewEvalRunDataSource
azure_ai_responses	AzureAIResponsesEvalRunDataSource
azure_ai_target_completions	TargetCompletionEvalRunDataSource
csv	EvalCsvRunDataSource
azure_ai_red_team	RedTeamEvalRunDataSource

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	string	El discriminador del tipo de origen de datos.	Sí

EvalRunOutputItem

Esquema que representa un elemento de salida de una ejecución de evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	integer	Marca de tiempo de Unix (en segundos) cuando se creó el proceso de evaluación.	Sí
elemento_fuente_de_datos	object	Detalles del elemento de origen de datos de entrada.	Sí
id_del_elemento_fuente_de_datos	OpenAI.integer		Sí
eval_id	string	Identificador del grupo de evaluación.	Sí
id	string	Identificador único del elemento de salida del proceso de evaluación.	Sí
object	enum	Tipo del objeto. Siempre "eval.run.output_item". Valores posibles: eval.run.output_item	Sí
results	matriz de EvalRunOutputItemResult	Lista de resultados del calificador para este elemento de salida.	Sí
identificador_de_ejecución	string	Identificador de la ejecución de evaluación asociada a este elemento de salida.	Sí
muestra	OpenAI.EvalRunOutputItemSample		Sí
└─ Error	OpenAI.EvalApiError	Objeto que representa una respuesta de error de la API de Eval.	Sí
└─ razón_de_finalización	string		Sí
└─ Entrada	matriz de EvalRunOutputItemSampleInput		Sí
└" max_completion_tokens	OpenAI.integer		Sí
└─ modelo	string		Sí
└─ salida	matriz de EvalRunOutputItemSampleOutput		Sí
└— semilla	OpenAI.integer		Sí
└─ Temperatura	OpenAI.numeric		Sí
└─ top_p	OpenAI.numeric		Sí
└─ uso	OpenAI.EvalRunOutputItemSampleUsage		Sí
status	string	Estado de la ejecución de la evaluación.	Sí

EvalRunOutputItemResult

Resultado de un solo calificador para un elemento de salida de ejecución de evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
label	string	Etiqueta asociada a la métrica de criterios de prueba (por ejemplo, "pass", "fail", "good", "bad").	No
metric	string	Nombre de la métrica (por ejemplo, "fluency", "f1_score").	No
nombre	string	Nombre del calificador.	Sí
pasado	boolean	Si el calificador consideró la salida de un pase.	Sí
properties	object	Detalles adicionales sobre la métrica de criterios de prueba.	No
razón	string	Motivo de la métrica de criterios de prueba.	No
muestra	objeto (que acepta valores NULL)	Muestra opcional o datos intermedios generados por el calificador.	No
puntuación	OpenAI.numeric		Sí
threshold	número	Umbral usado para determinar el paso o error de estos criterios de prueba, si es numérico.	No
type	string	Tipo de calificador (por ejemplo, "string-check-grader").	No

Este objeto también acepta propiedades adicionales.

EvalRunOutputItemSampleInput

Mensaje en la ejecución de evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	string		Sí
role	string		Sí
tool_calls	matriz de CompletionMessageToolCallChunk	Las llamadas a herramientas realizadas dentro del mensaje, si las hay.	Sí

EvalRunOutputItemSampleOutput

Mensaje en la ejecución de evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	string		No
role	string		No
tool_calls	matriz de CompletionMessageToolCallChunk	Las llamadas a herramientas realizadas dentro del mensaje, si las hay.	Sí

EvalRunResultCompareItem

Comparación métrica de un tratamiento con la línea de base.

Nombre	Tipo	Description	Obligatorio	Predeterminado
deltaEstimate	número	Diferencia estimada entre el tratamiento y la línea base.	Sí
pValue	número	Valor P para el efecto de tratamiento.	Sí
treatmentEffect	TreatmentEffectType	Tipo de efecto del tratamiento.	Sí
treatmentRunId	string	Identificador de ejecución del tratamiento.	Sí
treatmentRunSummary	EvalRunResultSummary	Estadísticas de resumen de una métrica en una ejecución de evaluación.	Sí
└~ promedio	número	Valor medio de la métrica en la ejecución de evaluación.	Sí
└] runId	string	Identificador de ejecución de evaluación.	Sí
└— sampleCount	integer	Número de ejemplos de la ejecución de evaluación.	Sí
└— standardDeviation	número	Desviación estándar de la métrica en la ejecución de evaluación.	Sí

EvalRunResultComparison

Los resultados de la comparación para el tratamiento se comparan con la línea de base.

Nombre	Tipo	Description	Obligatorio	Predeterminado
baselineRunSummary	EvalRunResultSummary	Estadísticas de resumen de una métrica en una ejecución de evaluación.	Sí
└~ promedio	número	Valor medio de la métrica en la ejecución de evaluación.	Sí
└] runId	string	Identificador de ejecución de evaluación.	Sí
└— sampleCount	integer	Número de ejemplos de la ejecución de evaluación.	Sí
└— standardDeviation	número	Desviación estándar de la métrica en la ejecución de evaluación.	Sí
compareItems	matriz de EvalRunResultCompareItem	Lista de resultados de comparación para cada ejecución de tratamiento.	Sí
evaluador	string	Nombre del evaluador para estos criterios de prueba.	Sí
metric	string	Métrica que se va a evaluar.	Sí
testingCriteria	string	Nombre de los criterios de prueba.	Sí

EvalRunResultSummary

Estadísticas de resumen de una métrica en una ejecución de evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
promedio	número	Valor medio de la métrica en la ejecución de evaluación.	Sí
runId	string	Identificador de ejecución de evaluación.	Sí
sampleCount	integer	Número de ejemplos de la ejecución de evaluación.	Sí
standardDeviation	número	Desviación estándar de la métrica en la ejecución de evaluación.	Sí

EvaluationComparisonInsightRequest

Solicitud de comparación de evaluación

Nombre	Tipo	Description	Obligatorio	Predeterminado
baselineRunId	string	Identificador de ejecución de línea base para la comparación.	Sí
evalId	string	Identificador de la evaluación.	Sí
treatmentRunIds	matriz de cadenas	Lista de identificadores de ejecución de tratamiento para la comparación.	Sí
type	enum	Tipo de solicitud. Valores posibles: EvaluationComparison	Sí

EvaluationComparisonInsightResult

Perspectivas de la comparación de la evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
comparaciones	matriz de EvalRunResultComparison	Resultados de comparación para cada tratamiento ejecutado en la línea base.	Sí
method	string	Método estadístico utilizado para la comparación.	Sí
type	enum	Tipo de resultado de información. Valores posibles: EvaluationComparison	Sí

EvaluationResultSample

Una muestra del resultado de la evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
correlationInfo	object	Información sobre la correlación del ejemplo de análisis.	Sí
evaluationResult	EvalResult	Resultado de la evaluación.	Sí
└─ Nombre	string	nombre de la comprobación	Sí
└─ aprobado	boolean	indica si se ha superado la comprobación o se ha producido un error.	Sí
└~ puntuación	número	puntuación	Sí
└─ Tipo	string	tipo de la comprobación	Sí
features	object	Características que ayudan con el filtrado adicional de datos en la experiencia de usuario.	Sí
id	string	Identificador único del ejemplo de análisis.	Sí
type	enum	Tipo de ejemplo de resultado de evaluación Valores posibles: EvaluationResultSample	Sí

EvaluationRule

Modelo de regla de evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acción	EvaluationRuleAction	Modelo de acción de evaluación.	Sí
└─ Tipo	EvaluationRuleActionType	Tipo de acción de evaluación.	Sí
description	string	Descripción de la regla de evaluación.	No
displayName	string	Nombre para mostrar de la regla de evaluación.	No
enabled	boolean	Indica si la regla de evaluación está habilitada. El valor predeterminado es verdadero.	Sí
eventType	EvaluationRuleEventType	Tipo de evento de regla de evaluación.	Sí
filter	EvaluationRuleFilter	Modelo de filtro de evaluación.	No
└] agentName	string	Filtre por nombre del agente.	Sí
id	string (solo lectura)	Identificador único de la regla de evaluación.	Sí
datos del sistema	objeto (solo lectura)	Metadatos del sistema para la regla de evaluación.	Sí

EvaluationRuleAction

Modelo de acción de evaluación.

Discriminador para EvaluationRuleAction

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

Tipo de valor	Schema
continuousEvaluation	ContinuousEvaluationRuleAction
humanEvaluationPreview	HumanEvaluationPreviewRuleAction

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	EvaluationRuleActionType	Tipo de acción de evaluación.	Sí

EvaluationRuleActionType

Tipo de acción de evaluación.

Propiedad	Value
Descripción	Tipo de acción de evaluación.
Type	string
Valores	continuousEvaluation humanEvaluationPreview

EvaluationRuleEventType

Tipo de evento de regla de evaluación.

Propiedad	Value
Descripción	Tipo de evento de regla de evaluación.
Type	string
Valores	responseCompleted manual

EvaluationRuleFilter

Modelo de filtro de evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
agentName	string	Filtre por nombre del agente.	Sí

EvaluationRunClusterInsightRequest

Información sobre el conjunto de resultados de la evaluación

Nombre	Tipo	Description	Obligatorio	Predeterminado
evalId	string	Identificador de evaluación de la información.	Sí
modelConfiguration	InsightModelConfiguration	Configuración del modelo utilizado en la generación de información.	No
└] modelDeploymentName	string	Implementación del modelo que se va a evaluar. Acepta solo el nombre de implementación o con el nombre de conexión como {connectionName}/<modelDeploymentName>.	Sí
runIds	matriz de cadenas	Lista de identificadores de ejecución de evaluación para la información.	Sí
type	enum	Tipo de solicitud de información. Valores posibles: EvaluationRunClusterInsight	Sí

EvaluationRunClusterInsightResult

La información de la evaluación ejecuta el análisis de clústeres.

Nombre	Tipo	Description	Obligatorio	Predeterminado
clusterInsight	ClusterInsightResult	Información del análisis de clústeres.	Sí
type	enum	Tipo de resultado de información. Valores posibles: EvaluationRunClusterInsight	Sí

EvaluationScheduleTask

Tarea de evaluación para el horario.

Nombre	Tipo	Description	Obligatorio	Predeterminado
configuration	object	Configuración de la tarea.	No
evalId	string	Identificador del grupo de evaluación.	Sí
evalRun	object	Carga de ejecución de evaluación.	Sí
type	enum	Valores posibles: Evaluation	Sí

EvaluationTaxonomy

Definición de taxonomía de evaluación

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	string (solo lectura)	ID de activo, un identificador único para el activo	No
nombre	string (solo lectura)	Nombre del recurso.	Sí
properties	object	Propiedades adicionales para la taxonomía de evaluación.	No
taxonomyCategories	matriz de TaxonomyCategory	Lista de categorías de taxonomía.	No
taxonomyInput	EvaluationTaxonomyInput	Configuración de entrada para la taxonomía de evaluación.	Sí
└─ Tipo	EvaluationTaxonomyInputType	Tipo de entrada de la taxonomía de evaluación.	Sí
version	string (solo lectura)	La versión del recurso	Sí

EvaluationTaxonomyCreateOrUpdate

Definición de taxonomía de evaluación

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Texto de descripción del recurso.	No
properties	object	Propiedades adicionales para la taxonomía de evaluación.	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
taxonomyCategories	matriz de TaxonomyCategory	Lista de categorías de taxonomía.	No
taxonomyInput	EvaluationTaxonomyInput	Configuración de entrada para la taxonomía de evaluación.	Sí
└─ Tipo	EvaluationTaxonomyInputType	Tipo de entrada de la taxonomía de evaluación.	Sí

EvaluationTaxonomyInput

Configuración de entrada para la taxonomía de evaluación.

Discriminador para EvaluationTaxonomyInput

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

Tipo de valor	Schema
agent	AgentTaxonomyInput

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	EvaluationTaxonomyInputType	Tipo de entrada de la taxonomía de evaluación.	Sí

EvaluationTaxonomyInputType

Tipo de entrada de la taxonomía de evaluación.

Propiedad	Value
Descripción	Tipo de entrada de la taxonomía de evaluación.
Type	string
Valores	agent policy

EvaluationTaxonomyInputUpdate

Configuración de entrada para la taxonomía de evaluación.

Discriminador para EvaluationTaxonomyInputUpdate

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

Tipo de valor	Schema
agent	AgentTaxonomyInputUpdate

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	EvaluationTaxonomyInputType	Tipo de entrada de la taxonomía de evaluación.	Sí

EvaluationTaxonomyUpdate

Definición de taxonomía de evaluación

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Texto de descripción del recurso.	No
properties	object	Propiedades adicionales para la taxonomía de evaluación.	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
taxonomyCategories	matriz de TaxonomyCategory	Lista de categorías de taxonomía.	No
taxonomyInput	EvaluationTaxonomyInputUpdate	Configuración de entrada para la taxonomía de evaluación.	No
└─ Tipo	EvaluationTaxonomyInputType	Tipo de entrada de la taxonomía de evaluación.	Sí

EvaluadorCategory

La categoría del evaluador

Propiedad	Value
Descripción	La categoría del evaluador
Type	string
Valores	quality safety agents

EvaluadorDefinition

Configuración del evaluador base con discriminador

Discriminador para EvaluadorDefinition

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

Tipo de valor	Schema
code	CodeBasedEvaluatorDefinition
prompt	PromptBasedEvaluatorDefinition

Nombre	Tipo	Description	Obligatorio	Predeterminado
data_schema	object	El esquema JSON (Borrador 2020-12) para los datos de entrada del evaluador. Esto incluye parámetros como tipo, propiedades, obligatorio.	No
init_parameters	object	El esquema JSON (Borrador 2020-12) para los parámetros de entrada del evaluador. Esto incluye parámetros como tipo, propiedades, obligatorio.	No
metrics	object	Lista de métricas de salida producidas por este evaluador	No
type	EvaluadorDefinitionType	El tipo de definición del evaluador	Sí

EvaluadorDefinitionType

El tipo de definición del evaluador

Propiedad	Value
Descripción	El tipo de definición del evaluador
Type	string
Valores	prompt code prompt_and_code service openai_graders

EvaluadorMetric

Métrica del evaluador

Nombre	Tipo	Description	Obligatorio	Predeterminado
desirable_direction	EvaluadorMetricDirection	La dirección de la métrica que indica si un valor más alto es mejor, un valor más bajo es mejor o neutral	No
is_primary	boolean	Indica si esta métrica es principal cuando hay varias métricas.	No
max_value	número	Valor máximo de la métrica. Si no se especifica, se supone que no está enlazado.	No
min_value	número	Valor mínimo para la métrica	No
type	EvaluadorMetricType	El tipo de evaluador	No

EvaluadorMetricDirection

La dirección de la métrica que indica si un valor más alto es mejor, un valor más bajo es mejor o neutral

Propiedad	Value
Descripción	La dirección de la métrica que indica si un valor más alto es mejor, un valor más bajo es mejor o neutral
Type	string
Valores	increase decrease neutral

EvaluadorMetricType

El tipo de evaluador

Propiedad	Value
Descripción	El tipo de evaluador
Type	string
Valores	ordinal continuous boolean

EvaluadorType

El tipo de evaluador

Propiedad	Value
Descripción	El tipo de evaluador
Type	string
Valores	builtin custom

EvaluadorVersion

Definición del evaluador

Nombre	Tipo	Description	Obligatorio	Predeterminado
categories	matriz de EvaluadorCategory	Las categorías del evaluador	Sí
fecha_de_creación	string (solo lectura)	Fecha/hora de creación del evaluador	Sí
created_by	string (solo lectura)	Creador del evaluador	Sí
definición	EvaluadorDefinition	Configuración del evaluador base con discriminador	Sí
└" data_schema	object	El esquema JSON (Borrador 2020-12) para los datos de entrada del evaluador. Esto incluye parámetros como tipo, propiedades, obligatorio.	No
└" init_parameters	object	El esquema JSON (Borrador 2020-12) para los parámetros de entrada del evaluador. Esto incluye parámetros como tipo, propiedades, obligatorio.	No
Métricas de └	object	Lista de métricas de salida producidas por este evaluador	No
└─ Tipo	EvaluadorDefinitionType	El tipo de definición del evaluador	Sí
display_name	string	Nombre para mostrar del evaluador. Ayuda a encontrar fácilmente al evaluador en AI Foundry. No es necesario que sea único.	No
evaluator_type	EvaluadorType	El tipo de evaluador	Sí
id	string (solo lectura)	ID de activo, un identificador único para el activo	No
metadatos	object	Metadatos sobre el evaluador	No
modified_at	string (solo lectura)	Fecha/hora de la última modificación del evaluador	Sí
nombre	string (solo lectura)	Nombre del recurso.	Sí
version	string (solo lectura)	La versión del recurso	Sí

EvaluadorVersionCreate

Definición del evaluador

Nombre	Tipo	Description	Obligatorio	Predeterminado
categories	matriz de EvaluadorCategory	Las categorías del evaluador	Sí
definición	EvaluadorDefinition	Configuración del evaluador base con discriminador	Sí
└" data_schema	object	El esquema JSON (Borrador 2020-12) para los datos de entrada del evaluador. Esto incluye parámetros como tipo, propiedades, obligatorio.	No
└" init_parameters	object	El esquema JSON (Borrador 2020-12) para los parámetros de entrada del evaluador. Esto incluye parámetros como tipo, propiedades, obligatorio.	No
Métricas de └	object	Lista de métricas de salida producidas por este evaluador	No
└─ Tipo	EvaluadorDefinitionType	El tipo de definición del evaluador	Sí
description	string	Texto de descripción del recurso.	No
display_name	string	Nombre para mostrar del evaluador. Ayuda a encontrar fácilmente al evaluador en AI Foundry. No es necesario que sea único.	No
evaluator_type	EvaluadorType	El tipo de evaluador	Sí
metadatos	object	Metadatos sobre el evaluador	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No

EvaluadorVersionUpdate

Definición del evaluador

Nombre	Tipo	Description	Obligatorio	Predeterminado
categories	matriz de EvaluadorCategory	Las categorías del evaluador	No
description	string	Texto de descripción del recurso.	No
display_name	string	Nombre para mostrar del evaluador. Ayuda a encontrar fácilmente al evaluador en AI Foundry. No es necesario que sea único.	No
metadatos	object	Metadatos sobre el evaluador	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No

FabricDataAgentToolParameters

Los parámetros de la herramienta Fabric Data Agent.

Nombre	Tipo	Description	Obligatorio	Predeterminado
project_connections	matriz de ToolProjectConnection	La project conexiones conectadas a esta herramienta. Puede haber un máximo de 1 conexión. recurso asociado a la herramienta.	No

FileDatasetVersion

FileDatasetVersion (Definición)

Nombre	Tipo	Description	Obligatorio	Predeterminado
connectionName	string	Nombre de la conexión de la cuenta de Azure Storage. Obligatorio si no se llamó a startPendingUploadVersion antes de crear el conjunto de datos	No
dataUri	string	URI de los datos (ejemplo) Restricciones: minLength: 1, patrón: [a-zA-Z0-9_]	Sí
id	string (solo lectura)	ID de activo, un identificador único para el activo	No
isReference	booleano (solo lectura)	Indica si el conjunto de datos contiene una referencia al almacenamiento o el conjunto de datos administra el propio almacenamiento. Si es true, los datos subyacentes no se eliminarán cuando se elimine la versión del conjunto de datos.	No
nombre	string (solo lectura)	Nombre del recurso.	Sí
type	enum	Tipo de conjunto de datos Valores posibles: uri_file	Sí
version	string (solo lectura)	La versión del recurso	Sí

FileDatasetVersionUpdate

FileDatasetVersion (Definición)

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Texto de descripción del recurso.	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
type	enum	Tipo de conjunto de datos Valores posibles: uri_file	Sí

FolderDatasetVersion

FileDatasetVersion (Definición)

Nombre	Tipo	Description	Obligatorio	Predeterminado
connectionName	string	Nombre de la conexión de la cuenta de Azure Storage. Obligatorio si no se llamó a startPendingUploadVersion antes de crear el conjunto de datos	No
dataUri	string	URI de los datos (ejemplo) Restricciones: minLength: 1, patrón: [a-zA-Z0-9_]	Sí
id	string (solo lectura)	ID de activo, un identificador único para el activo	No
isReference	booleano (solo lectura)	Indica si el conjunto de datos contiene una referencia al almacenamiento o el conjunto de datos administra el propio almacenamiento. Si es true, los datos subyacentes no se eliminarán cuando se elimine la versión del conjunto de datos.	No
nombre	string (solo lectura)	Nombre del recurso.	Sí
type	enum	Tipo de conjunto de datos Valores posibles: uri_folder	Sí
version	string (solo lectura)	La versión del recurso	Sí

FolderDatasetVersionUpdate

FileDatasetVersion (Definición)

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Texto de descripción del recurso.	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
type	enum	Tipo de conjunto de datos Valores posibles: uri_folder	Sí

FunctionToolCall

Detalles de una llamada a la herramienta de función.

Nombre	Tipo	Description	Obligatorio	Predeterminado
argumentos	string	Los argumentos para llamar a la función con, tal como se genera el modelo en formato JSON.	Sí
nombre	string	El nombre de la función para llamar.	Sí

HostedAgentDefinition

La definición del agente hospedado.

Nombre	Tipo	Description	Obligatorio	Predeterminado
container_protocol_versions	matriz de ProtocolVersionRecord	Los protocolos que admite el agente para la comunicación de entrada de los contenedores.	Sí
cpu	string	La configuración de la CPU para el agente hospedado.	Sí
environment_variables	object	Variables de entorno que se van a establecer en el contenedor del agente hospedado.	No
imagen	string	El identificador de imagen del agente, aplicable a los agentes hospedados basados en imágenes.	No
amable	enum	Valores posibles: hosted	Sí
memory	string	La configuración de memoria para el agente hospedado.	Sí
rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
└" rai_policy_name	string	Nombre de la directiva RAI que se va a aplicar.	Sí
tools	matriz de OpenAI.Tool	Una matriz de herramientas que el modelo del agente hospedado puede llamar mientras genera una respuesta. Tú puede especificar qué herramienta se va a usar estableciendo el tool_choice parámetro .	No

HourlyRecurrenceSchedule

Programación de periodicidad por hora.

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

HumanEvaluationPreviewRuleAction

Acción de regla de evaluación para la evaluación humana.

Nombre	Tipo	Description	Obligatorio	Predeterminado
templateId	AssetId	Identificador de un recurso guardado.	Sí
type	enum	Valores posibles: humanEvaluationPreview	Sí

Índice

Definición de recursos de índice

Discriminador para índice

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

Tipo de valor	Schema
AzureSearch	AzureAISearchIndex
ManagedAzureSearch	ManagedAzureAISearchIndex
CosmosDBNoSqlVectorStore	CosmosDBIndex

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	string (solo lectura)	ID de activo, un identificador único para el activo	No
nombre	string (solo lectura)	Nombre del recurso.	Sí
type	IndexType		Sí
version	string (solo lectura)	La versión del recurso	Sí

IndexType

Propiedad	Value
Type	string
Valores	AzureSearch CosmosDBNoSqlVectorStore ManagedAzureSearch

IndexUpdate

Definición de recursos de índice

Discriminador para IndexUpdate

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

Tipo de valor	Schema
AzureSearch	AzureAISearchIndexUpdate
ManagedAzureSearch	ManagedAzureAISearchIndexUpdate
CosmosDBNoSqlVectorStore	CosmosDBIndexUpdate

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Texto de descripción del recurso.	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
type	IndexType		Sí

Conclusión

El cuerpo de respuesta para la información del clúster.

Nombre	Tipo	Description	Obligatorio	Predeterminado
displayName	string	Nombre para mostrar descriptivo para la información.	Sí
id	string (solo lectura)	Identificador único del informe de conclusiones.	Sí
metadatos	InsightsMetadata (solo lectura)	Metadatos sobre la información.	Sí
└— completedAt	string	Marca de tiempo cuando se completó la información.	No
└— createdAt	string	Marca de tiempo cuando se creó la información.	Sí
request	InsightRequest	La solicitud del informe de información.	Sí
└─ Tipo	InsightType	Tipo de solicitud.	Sí
result	InsightResult (solo lectura)	El resultado de las ideas.	No
└─ Tipo	InsightType	Tipo de resultado de información.	Sí
state	Azure. Core.Foundations.OperationState (solo lectura)	Enumeración que describe los estados de operación permitidos.	Sí

InsightCluster

Un grupo de muestras de análisis.

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Descripción del clúster de análisis.	Sí
id	string	Identificador del clúster de análisis.	Sí
label	string	Etiqueta del clúster	Sí
ejemplos	matriz de InsightSample	Lista de ejemplos que pertenecen a este clúster. Vacío si los ejemplos forman parte de los subclusters.	No
subClusters	matriz de InsightCluster	Lista de subclusters dentro de este clúster. Está vacío si no existen subclusters.	No
sugerencia	string	Sugerencia para el clúster	Sí
suggestionTitle	string	Título de la sugerencia para el clúster	Sí
weight	integer	Peso del clúster de análisis. Esto indica el número de muestras del clúster.	Sí

InsightModelConfiguration

Configuración del modelo utilizado en la generación de información.

Nombre	Tipo	Description	Obligatorio	Predeterminado
modelDeploymentName	string	Implementación del modelo que se va a evaluar. Acepta solo el nombre de implementación o con el nombre de conexión como {connectionName}/<modelDeploymentName>.	Sí

InsightRequest

La solicitud del informe de información.

Discriminador para InsightRequest

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

Tipo de valor	Schema
EvaluationRunClusterInsight	EvaluationRunClusterInsightRequest
AgentClusterInsight	AgentClusterInsightRequest
EvaluationComparison	EvaluationComparisonInsightRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	InsightType	La solicitud de las ideas.	Sí

InsightResult

El resultado de las ideas.

Discriminador para InsightResult

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

Tipo de valor	Schema
EvaluationComparison	EvaluationComparisonInsightResult
EvaluationRunClusterInsight	EvaluationRunClusterInsightResult
AgentClusterInsight	AgentClusterInsightResult

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	InsightType	La solicitud de las ideas.	Sí

InsightSample

Una muestra del análisis.

Discriminador para InsightSample

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

Tipo de valor	Schema
EvaluationResultSample	EvaluationResultSample

Nombre	Tipo	Description	Obligatorio	Predeterminado
correlationInfo	object	Información sobre la correlación del ejemplo de análisis.	Sí
features	object	Características que ayudan con el filtrado adicional de datos en la experiencia de usuario.	Sí
id	string	Identificador único del ejemplo de análisis.	Sí
type	SampleType	El tipo de muestra utilizada en el análisis.	Sí

InsightScheduleTask

Tarea de información para la programación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
configuration	object	Configuración de la tarea.	No
perspectiva	Conclusiones	El cuerpo de respuesta para la información del clúster.	Sí
└] displayName	string	Nombre para mostrar descriptivo para la información.	Sí
└─ id.	string (solo lectura)	Identificador único del informe de conclusiones.	Sí
Metadatos └	InsightsMetadata (solo lectura)	Metadatos sobre el informe de información.	Sí
Solicitud └	InsightRequest	Solicite el análisis de conclusiones.	Sí
Resultado └	InsightResult (solo lectura)	Resultado del informe de conclusiones.	No
Estado └	Azure. Core.Foundations.OperationState (solo lectura)	Estado actual de la información.	Sí
type	enum	Valores posibles: Insight	Sí

InsightSummary

Resumen del análisis de conglomerados de errores.

Nombre	Tipo	Description	Obligatorio	Predeterminado
method	string	Método usado para la agrupación en clústeres.	Sí
sampleCount	integer	Número total de muestras analizadas.	Sí
uniqueClusterCount	integer	Número total de clústeres únicos.	Sí
uniqueSubclusterCount	integer	Número total de etiquetas de subcluster únicas.	Sí
uso	ClusterTokenUsage	Uso de tokens para el análisis de clústeres	Sí
└— inputTokenUsage	integer	uso del token de entrada	Sí
└— outputTokenUsage	integer	uso del token de salida	Sí
└— totalTokenUsage	integer	uso total de tokens	Sí

InsightType

La solicitud de las ideas.

Propiedad	Value
Descripción	La solicitud de las ideas.
Type	string
Valores	EvaluationRunClusterInsight AgentClusterInsight EvaluationComparison

InsightsMetadata

Metadatos sobre la información.

Nombre	Tipo	Description	Obligatorio	Predeterminado
completedAt	string	Marca de tiempo cuando se completó la información.	No
createdAt	string	Marca de tiempo cuando se creó la información.	Sí

ItemGenerationParams

Representa el conjunto de parámetros usados para controlar las operaciones de generación de elementos.

Discriminador para ItemGenerationParams

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

Tipo de valor	Schema
red_team	RedTeamItemGenerationParams
red_team_seed_prompts	RedTeamSeedPromptsItemGenerationParams
red_team_taxonomy	RedTeamTaxonomyItemGenerationParams
response_retrieval	ResponseRetrievalItemGenerationParams

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	ItemGenerationParamsType	Tipos de parámetros para la generación de elementos de equipo rojo.	Sí

ItemGenerationParamsType

Tipos de parámetros para la generación de elementos de equipo rojo.

Propiedad	Value
Descripción	Tipos de parámetros para la generación de elementos de equipo rojo.
Type	string
Valores	red_team response_retrieval red_team_seed_prompts red_team_taxonomy synthetic_data_gen_preview

ManagedAzureAISearchIndex

Definición de índice de Búsqueda de Azure AI administrada

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	string (solo lectura)	ID de activo, un identificador único para el activo	No
nombre	string (solo lectura)	Nombre del recurso.	Sí
type	enum	Tipo de índice Valores posibles: ManagedAzureSearch	Sí
version	string (solo lectura)	La versión del recurso	Sí

ManagedAzureAISearchIndexUpdate

Definición de índice de Búsqueda de Azure AI administrada

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Texto de descripción del recurso.	No
tags	object	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
type	enum	Tipo de índice Valores posibles: ManagedAzureSearch	Sí

MemoryItem

Un único elemento de memoria almacenado en el almacén de memoria, que contiene contenido y metadatos.

Discriminador para MemoryItem

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

Tipo de valor	Schema
user_profile	UserProfileMemoryItem
chat_summary	ChatSummaryMemoryItem

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	string	El contenido de la memoria.	Sí
amable	MemoryItemKind	Tipo de elemento de memoria.	Sí
memory_id	string	El identificador único del elemento de memoria.	Sí
scope	string	El espacio de nombres que agrupa y aísla lógicamente las memorias, como un ID de usuario.	Sí
updated_at	integer	La hora de la última actualización del elemento de memoria.	Sí

MemoryItemKind

Tipo de elemento de memoria.

Propiedad	Value
Descripción	Tipo de elemento de memoria.
Type	string
Valores	user_profile chat_summary

MemoryOperation

Representa una única operación de memoria (crear, actualizar o eliminar) realizada en un elemento de memoria.

Nombre	Tipo	Description	Obligatorio	Predeterminado
amable	MemoryOperationKind	Tipo de operación de memoria.	Sí
memory_item	MemoryItem	Un único elemento de memoria almacenado en el almacén de memoria, que contiene contenido y metadatos.	Sí
└─ Contenido	string	El contenido de la memoria.	Sí
└└ kind	MemoryItemKind	El tipo del elemento de memoria.	Sí
└" memory_id	string	El identificador único del elemento de memoria.	Sí
Ámbito └	string	El espacio de nombres que agrupa y aísla lógicamente las memorias, como un ID de usuario.	Sí
└" updated_at	integer	La hora de la última actualización del elemento de memoria.	Sí

MemoryOperationKind

Tipo de operación de memoria.

Propiedad	Value
Descripción	Tipo de operación de memoria.
Type	string
Valores	create update delete

MemorySearchItem

Un elemento de memoria recuperado de la búsqueda de memoria.

Nombre	Tipo	Description	Obligatorio	Predeterminado
memory_item	MemoryItem	Un único elemento de memoria almacenado en el almacén de memoria, que contiene contenido y metadatos.	Sí
└─ Contenido	string	El contenido de la memoria.	Sí
└└ kind	MemoryItemKind	El tipo del elemento de memoria.	Sí
└" memory_id	string	El identificador único del elemento de memoria.	Sí
Ámbito └	string	El espacio de nombres que agrupa y aísla lógicamente las memorias, como un ID de usuario.	Sí
└" updated_at	integer	La hora de la última actualización del elemento de memoria.	Sí

MemorySearchOptions

Opciones de búsqueda de memoria.

Nombre	Tipo	Description	Obligatorio	Predeterminado
max_memories	integer	Número máximo de elementos de memoria que se van a devolver.	No

MemorySearchPreviewTool

Una herramienta para integrar los recuerdos en el agente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
memory_store_name	string	El nombre del almacén de memoria que se va a usar.	Sí
scope	string	El espacio de nombres utilizado para agrupar y aislar recuerdos, como un ID de usuario. Limita los recuerdos que se pueden recuperar o actualizar. Use una variable {{$userId}} especial para limitar las memorias al usuario que ha iniciado sesión actual.	Sí
search_options	MemorySearchOptions	Opciones de búsqueda de memoria.	No
└" max_memories	integer	Número máximo de elementos de memoria que se van a devolver.	No
type	enum	Tipo de la herramienta. Siempre memory_search_preview. Valores posibles: memory_search_preview	Sí
update_delay	integer	Tiempo de espera antes de actualizar los recuerdos después de la inactividad (segundos). Predeterminado 300.	No	300

MemorySearchToolCallItemParam

Nombre	Tipo	Description	Obligatorio	Predeterminado
results	matriz de MemorySearchItem	Los resultados devueltos de la búsqueda de memoria.	No
type	enum	Valores posibles: memory_search_call	Sí

MemorySearchToolCallItemResource

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
response_id	string	Respuesta en la que se crea el elemento.	No
results	matriz de MemorySearchItem	Los resultados devueltos de la búsqueda de memoria.	No
status	enum	Estado de la llamada a la herramienta de búsqueda de memoria. Uno de in_progress, searching completed, incompleteo failed, Valores posibles: in_progress, searching, completed, , incomplete, failed	Sí
type	enum	Valores posibles: memory_search_call	Sí

MemoryStoreDefaultDefinition

Implementación predeterminada del almacén de memoria.

Nombre	Tipo	Description	Obligatorio	Predeterminado
chat_model	string	Nombre o identificador de la implementación del modelo de finalización de chat que se usa para el procesamiento de memoria.	Sí
embedding_model	string	Nombre o identificador de la implementación del modelo de inserción que se usa para el procesamiento de memoria.	Sí
amable	enum	Tipo del almacén de memoria. Valores posibles: default	Sí
options	MemoryStoreDefaultOptions	Configuraciones predeterminadas del almacén de memoria.	No
└" chat_summary_enabled	boolean	Si se habilita la extracción de resumen de chat y storage. El valor predeterminado es verdadero.	Sí	True
└" user_profile_details	string	Categorías o tipos específicos de información de perfil de usuario para extraer y almacenar.	No
└" user_profile_enabled	boolean	Si se va a habilitar la extracción de perfiles de usuario y storage. El valor predeterminado es verdadero.	Sí	True

MemoryStoreDefaultOptions

Configuraciones predeterminadas del almacén de memoria.

Nombre	Tipo	Description	Obligatorio	Predeterminado
chat_summary_enabled	boolean	Si se habilita la extracción de resumen de chat y storage. El valor predeterminado es verdadero.	Sí	True
user_profile_details	string	Categorías o tipos específicos de información de perfil de usuario para extraer y almacenar.	No
user_profile_enabled	boolean	Si se va a habilitar la extracción de perfiles de usuario y storage. El valor predeterminado es verdadero.	Sí	True

MemoryStoreDefinition

Definición base para configuraciones de almacén de memoria.

Discriminador para MemoryStoreDefinition

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

Tipo de valor	Schema
default	MemoryStoreDefaultDefinition

Nombre	Tipo	Description	Obligatorio	Predeterminado
amable	MemoryStoreKind	El tipo de implementación del almacén de memoria que se va a usar.	Sí

MemoryStoreDeleteScopeResponse

Respuesta para eliminar memorias de un ámbito.

Nombre	Tipo	Description	Obligatorio	Predeterminado
eliminado	boolean	Si la operación de eliminación se realizó correctamente.	Sí
nombre	string	Nombre del almacén de memoria.	Sí
object	enum	Tipo de objeto. Siempre "memory_store.scope.deleted". Valores posibles: memory_store.scope.deleted	Sí
scope	string	Ámbito del que se eliminaron los recuerdos.	Sí

MemoryStoreKind

El tipo de implementación del almacén de memoria que se va a usar.

Propiedad	Value
Descripción	El tipo de implementación del almacén de memoria que se va a usar.
Type	string
Valores	default

MemoryStoreObject

Un almacén de memoria que puede almacenar y recuperar recuerdos de usuario.

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	integer	Marca de tiempo de Unix (segundos) cuando se creó el almacén de memoria.	Sí
definición	MemoryStoreDefinition	Definición base para configuraciones de almacén de memoria.	Sí
└└ kind	MemoryStoreKind	Tipo del almacén de memoria.	Sí
description	string	Descripción legible del almacén de memoria. Restricciones: maxLength: 512	No
id	string	Identificador único del almacén de memoria.	Sí
metadatos	object	Metadatos de clave-valor arbitrarios que se van a asociar al almacén de memoria.	No
nombre	string	Nombre del almacén de memoria. Restricciones: maxLength: 256	Sí
object	enum	Tipo de objeto, que siempre es "memory_store". Valores posibles: memory_store	Sí
updated_at	integer	Marca de tiempo de Unix (segundos) cuando el almacén de memoria se actualizó por última vez.	Sí

MemoryStoreOperationUsage

Estadísticas de uso de una operación de almacén de memoria.

Nombre	Tipo	Description	Obligatorio	Predeterminado
embedding_tokens	integer	Número de tokens de inserción.	Sí
input_tokens	OpenAI.integer		Sí
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Sí
└─ tokens en caché	OpenAI.integer		Sí
output_tokens	OpenAI.integer		Sí
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Sí
─ reasoning_tokens	OpenAI.integer		Sí
total_tokens	OpenAI.integer		Sí

MemoryStoreSearchResponse

Respuesta de búsqueda de memoria.

Nombre	Tipo	Description	Obligatorio	Predeterminado
recuerdos	matriz de MemorySearchItem	Elementos de memoria relacionados encontrados durante la operación de búsqueda.	Sí
search_id	string	Identificador único de esta solicitud de búsqueda. Use este valor como previous_search_id en las solicitudes posteriores para realizar búsquedas incrementales.	Sí
uso	MemoryStoreOperationUsage	Estadísticas de uso de una operación de almacén de memoria.	Sí
└" embedding_tokens	integer	Número de tokens de inserción.	Sí
└─ input_tokens	OpenAI.integer	Número de tokens de entrada.	Sí
└─ detalles_de_tokens_de_entrada	OpenAI.ResponseUsageInputTokensDetails	Desglose detallado de los tokens de entrada.	Sí
└─ output_tokens	OpenAI.integer	Número de tokens de salida.	Sí
└" output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Desglose detallado de los tokens de salida.	Sí
└" total_tokens	OpenAI.integer	Número total de tokens usados.	Sí

MemoryStoreUpdateCompletedResult

Resultado de la actualización de memoria.

Nombre	Tipo	Description	Obligatorio	Predeterminado
memory_operations	matriz de MemoryOperation	Lista de operaciones de memoria individuales que se realizaron durante la actualización.	Sí
uso	MemoryStoreOperationUsage	Estadísticas de uso de una operación de almacén de memoria.	Sí
└" embedding_tokens	integer	Número de tokens de inserción.	Sí
└─ input_tokens	OpenAI.integer	Número de tokens de entrada.	Sí
└─ detalles_de_tokens_de_entrada	OpenAI.ResponseUsageInputTokensDetails	Desglose detallado de los tokens de entrada.	Sí
└─ output_tokens	OpenAI.integer	Número de tokens de salida.	Sí
└" output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Desglose detallado de los tokens de salida.	Sí
└" total_tokens	OpenAI.integer	Número total de tokens usados.	Sí

MemoryStoreUpdateResponse

Proporciona el estado de una operación de actualización del almacén de memoria.

Nombre	Tipo	Description	Obligatorio	Predeterminado
error	OpenAI.Error		No
└] additionalInfo	object		No
└─ código	string (que acepta valores NULL)		Sí
└] debugInfo	object		No
└─ detalles	matriz de OpenAI.Error		No
└─ Mensaje	string		Sí
└— param	string (que acepta valores NULL)		No
└─ Tipo	string		No
result	MemoryStoreUpdateCompletedResult	Resultado de la actualización de memoria.	No
└" memory_operations	matriz de MemoryOperation	Lista de operaciones de memoria individuales que se realizaron durante la actualización.	Sí
└─ uso	MemoryStoreOperationUsage	Estadísticas de uso asociadas a la operación de actualización de memoria.	Sí
status	MemoryStoreUpdateStatus	Estado de una operación de actualización del almacén de memoria.	Sí
superseded_by	string	El update_id la operación fue reemplazada por cuando el estado es "reemplazado".	No
update_id	string	Identificador único de esta solicitud de actualización. Use este valor como previous_update_id en las solicitudes posteriores para realizar actualizaciones incrementales.	Sí

MemoryStoreUpdateStatus

Estado de una operación de actualización del almacén de memoria.

Propiedad	Value
Type	string
Valores	queued in_progress completed failed superseded

MicrosoftFabricPreviewTool

La información de definición de entrada para una herramienta de Microsoft Fabric usada para configurar un agente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
fabric_dataagent_preview	FabricDataAgentToolParameters	Los parámetros de la herramienta Fabric Data Agent.	Sí
└" project_connections	matriz de ToolProjectConnection	La project conexiones conectadas a esta herramienta. Puede haber un máximo de 1 conexión. recurso asociado a la herramienta. Restricciones: maxItems: 1	No
type	enum	El tipo de objeto, que siempre es 'fabric_dataagent_preview'. Valores posibles: fabric_dataagent_preview	Sí

ModelDeployment

Definición de implementación de modelo

Nombre	Tipo	Description	Obligatorio	Predeterminado
capabilities	objeto (solo lectura)	Funcionalidades del modelo implementado	Sí
connectionName	string (solo lectura)	Nombre de la conexión de la que procede la implementación	No
modelName	string (solo lectura)	Publisher nombre específico del modelo implementado	Sí
modelPublisher	string (solo lectura)	Nombre del publicador del modelo implementado	Sí
modelVersion	string (solo lectura)	Publisher versión específica del modelo implementado	Sí
nombre	string (solo lectura)	Nombre de la implementación	Sí
sku	SKU (solo lectura)	Información de SKU	Sí
Capacidad └	integer	Capacidad de SKU	Sí
Familia └	string	Familia de SKU	Sí
└─ Nombre	string	Nombre de SKU	Sí
Tamaño └	string	Tamaño de SKU	Sí
Nivel └	string	Nivel de SKU	Sí
type	enum	Tipo de la implementación Valores posibles: ModelDeployment	Sí

ModelSamplingParams

Representa un conjunto de parámetros usados para controlar el comportamiento de muestreo de un modelo de lenguaje durante la generación de texto.

Nombre	Tipo	Description	Obligatorio	Predeterminado
max_completion_tokens	integer	Número máximo de tokens permitidos en la finalización.	Sí
inicialización	integer	Inicialización aleatoria para la reproducibilidad.	Sí
temperatura	número	Parámetro de temperatura para el muestreo.	Sí
top_p	número	Parámetro top-p para el muestreo de núcleos.	Sí

ModelSamplingParamsUpdate

Representa un conjunto de parámetros usados para controlar el comportamiento de muestreo de un modelo de lenguaje durante la generación de texto.

Nombre	Tipo	Description	Obligatorio	Predeterminado
max_completion_tokens	integer	Número máximo de tokens permitidos en la finalización.	No
inicialización	integer	Inicialización aleatoria para la reproducibilidad.	No
temperatura	número	Parámetro de temperatura para el muestreo.	No
top_p	número	Parámetro top-p para el muestreo de núcleos.	No

MonthlyRecurrenceSchedule

Programa de periodicidad mensual.

Nombre	Tipo	Description	Obligatorio	Predeterminado
daysOfMonth	matriz de enteros	Días del mes para la programación de periodicidad.	Sí
type	enum	Tipo de periodicidad mensual. Valores posibles: Monthly	Sí

NoAuthenticationCredentials

Credenciales que no requieren autenticación

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de credencial Valores posibles: None	Sí

OAuthConsentRequestOutputItem

Solicite al usuario que realice el consentimiento de OAuth desde el servicio.

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
consent_link	string	Vínculo que el usuario puede usar para realizar el consentimiento de OAuth.	Sí
id	string		Sí
response_id	string	Respuesta en la que se crea el elemento.	No
etiqueta del servidor	string	Etiqueta del servidor para la solicitud de consentimiento de OAuth.	Sí
type	enum	Valores posibles: oauth_consent_request	Sí

OneTimeTrigger

Disparador único.

Nombre	Tipo	Description	Obligatorio	Predeterminado
timeZone	string	Zona horaria para el desencadenador único.	No	UTC
triggerAt	string	Fecha y hora del disparador único en formato ISO 8601.	Sí
type	enum	Valores posibles: OneTime	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.ApplyPatchCallOutputStatusParam

Valores de resultados notificados para apply_patch salidas de llamada de herramienta.

Propiedad	Value
Type	string
Valores	completed failed

OpenAI.ApplyPatchCallStatus

Propiedad	Value
Type	string
Valores	in_progress completed

OpenAI.ApplyPatchCallStatusParam

Valores de estado notificados para las llamadas a herramientas de apply_patch.

Propiedad	Value
Type	string
Valores	in_progress completed

OpenAI.ApplyPatchCreateFileOperation

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í

OpenAI.ApplyPatchCreateFileOperationParam

Instrucciones para crear un archivo a través de la herramienta apply_patch.

Nombre	Tipo	Description	Obligatorio	Predeterminado
diferencias	string	Contenido de diferencias unificado que se aplicará al crear el archivo. Restricciones: maxLength: 10485760	Sí
path	string	Ruta de acceso del archivo que se va a crear en relación con la raíz del área de trabajo. Restricciones: minLength: 1	Sí
type	enum	Tipo de operación. Siempre create_file. Valores posibles: create_file	Sí

OpenAI.ApplyPatchDeleteFileOperation

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í

OpenAI.ApplyPatchDeleteFileOperationParam

Instrucciones para eliminar un archivo existente 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 en relación con la raíz del área de trabajo. Restricciones: minLength: 1	Sí
type	enum	Tipo de operación. Siempre delete_file. Valores posibles: delete_file	Sí

OpenAI.ApplyPatchFileOperation

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

Una de las operaciones de create_file, delete_file o update_file proporcionadas a la herramienta de apply_patch.

Discriminador para OpenAI.ApplyPatchOperationParam

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

Tipo de valor	Schema
create_file	OpenAI.ApplyPatchCreateFileOperationParam
delete_file	OpenAI.ApplyPatchDeleteFileOperationParam
update_file	OpenAI.ApplyPatchUpdateFileOperationParam

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ApplyPatchOperationParamType		Sí

OpenAI.ApplyPatchOperationParamType

Propiedad	Value
Type	string
Valores	create_file delete_file update_file

OpenAI.ApplyPatchToolParam

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í

OpenAI.ApplyPatchUpdateFileOperation

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í

OpenAI.ApplyPatchUpdateFileOperationParam

Instrucciones para actualizar un archivo existente a través de la herramienta apply_patch.

Nombre	Tipo	Description	Obligatorio	Predeterminado
diferencias	string	Contenido de diferencias unificado que se va a aplicar al archivo existente. Restricciones: maxLength: 10485760	Sí
path	string	Ruta de acceso del archivo que se va a actualizar en relación con la raíz del área de trabajo. Restricciones: minLength: 1	Sí
type	enum	Tipo de operación. Siempre update_file. Valores posibles: update_file	Sí

OpenAI.ApproximateLocation

Nombre	Tipo	Description	Obligatorio	Predeterminado
ciudad	string (que acepta valores NULL)		No
country	string (que acepta valores NULL)		No
region	string (que acepta valores NULL)		No
zona horaria	string (que acepta valores NULL)		No
type	enum	Tipo de aproximación de ubicación. Siempre approximate. Valores posibles: approximate	Sí

OpenAI.ChatCompletionTool

Herramienta de función que se puede usar para generar una respuesta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
function	OpenAI.FunctionObject		Sí
type	enum	Tipo de la herramienta. Actualmente, solo se admite function. Valores posibles: function	Sí

OpenAI.ChatModel

Propiedad	Value
Type	string
Valores	gpt-5.2 gpt-5.2-2025-12-11 gpt-5.2-chat-latest gpt-5.2-pro gpt-5.2-pro-2025-12-11 gpt-5.1 gpt-5.1-2025-11-13 gpt-5.1-codex gpt-5.1-mini gpt-5.1-chat-latest gpt-5 gpt-5-mini gpt-5-nano gpt-5-2025-08-07 gpt-5-mini-2025-08-07 gpt-5-nano-2025-08-07 gpt-5-chat-latest gpt-4.1 gpt-4.1-mini gpt-4.1-nano gpt-4.1-2025-04-14 gpt-4.1-mini-2025-04-14 gpt-4.1-nano-2025-04-14 o4-mini o4-mini-2025-04-16 o3 o3-2025-04-16 o3-mini o3-mini-2025-01-31 o1 o1-2024-12-17 o1-preview o1-preview-2024-09-12 o1-mini o1-mini-2024-09-12 gpt-4o gpt-4o-2024-11-20 gpt-4o-2024-08-06 gpt-4o-2024-05-13 gpt-4o-audio-preview gpt-4o-audio-preview-2024-10-01 gpt-4o-audio-preview-2024-12-17 gpt-4o-audio-preview-2025-06-03 gpt-4o-mini-audio-preview gpt-4o-mini-audio-preview-2024-12-17 gpt-4o-search-preview gpt-4o-mini-search-preview gpt-4o-search-preview-2025-03-11 gpt-4o-mini-search-preview-2025-03-11 chatgpt-4o-latest codex-mini-latest gpt-4o-mini gpt-4o-mini-2024-07-18 gpt-4-turbo gpt-4-turbo-2024-04-09 gpt-4-0125-preview gpt-4-turbo-preview gpt-4-1106-preview gpt-4-vision-preview gpt-4 gpt-4-0314 gpt-4-0613 gpt-4-32k gpt-4-32k-0314 gpt-4-32k-0613 gpt-3.5-turbo gpt-3.5-turbo-16k gpt-3.5-turbo-0301 gpt-3.5-turbo-0613 gpt-3.5-turbo-1106 gpt-3.5-turbo-0125 gpt-3.5-turbo-16k-0613

OpenAI.ClickButtonType

Propiedad	Value
Type	string
Valores	left right wheel back forward

OpenAI.ClickParam

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 clickes . Valores posibles: click	Sí
x	OpenAI.integer		Sí
y	OpenAI.integer		Sí

OpenAI.CodeInterpreterContainerAuto

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.	No
límite_de_memoria	OpenAI.ContainerMemoryLimit (que acepta valores NULL)		No
type	enum	Siempre auto. Valores posibles: auto	Sí

OpenAI.CodeInterpreterOutputImage

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í
url	string	Dirección URL de la salida de la imagen del intérprete de código.	Sí

OpenAI.CodeInterpreterOutputLogs

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í

OpenAI.CodeInterpreterTool

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 . Si no se proporciona, el servicio asume automáticamente.	No
type	enum	Tipo de la herramienta de intérprete de código. Siempre code_interpreter. Valores posibles: code_interpreter	Sí

OpenAI.CompactResource

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	integer	Marca de tiempo de Unix (en segundos) cuando se creó la conversación compacta.	Sí
id	string	Identificador único de la respuesta compactada.	Sí
object	enum	Tipo de objeto. Siempre response.compaction. Valores posibles: response.compaction	Sí
output	matriz de OpenAI.OutputItem	Lista compactada de elementos de salida. Se trata de una lista de todos los mensajes de usuario, seguidos de un único elemento de compactación.	Sí
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.	Sí
└─ input_tokens	OpenAI.integer	Número de tokens de entrada.	Sí
└─ detalles_de_tokens_de_entrada	OpenAI.ResponseUsageInputTokensDetails	Desglose detallado de los tokens de entrada.	Sí
└─ output_tokens	OpenAI.integer	Número de tokens de salida.	Sí
└" output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Desglose detallado de los tokens de salida.	Sí
└" total_tokens	OpenAI.integer	Número total de tokens usados.	Sí

OpenAI.CompactResponseMethodPublicBody

Nombre	Tipo	Description	Obligatorio	Predeterminado
input	cadena o matriz de OpenAI.InputItem		No
instructions	string (que acepta valores NULL)		No
model	OpenAI.ModelIdsCompaction	Id. de modelo usado para generar la respuesta, como gpt-5 o o3. OpenAI ofrece una amplia gama de modelos con diferentes funcionalidades, características de rendimiento y puntos de precio. Consulte la guía del modelo para examinar y comparar los modelos disponibles.	Sí
previous_response_id	string (que acepta valores NULL)		No

OpenAI.ComparisonFilter

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í
value	string o OpenAI.numeric o boolean o matriz 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

Tipo: string o OpenAI.numeric

OpenAI.CompoundFilter

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	Predeterminado
código	string (que acepta valores NULL)		No
id	string	Identificador de la comprobación de seguridad pendiente.	Sí
message	string (que acepta valores NULL)		No

OpenAI.ComputerEnvironment

Propiedad	Value
Type	string
Valores	windows mac linux ubuntu browser

OpenAI.ComputerScreenshotContent

Captura de pantalla de un equipo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
ID del archivo	string (que acepta valores NULL)		Sí
image_url	string		Sí
type	enum	Especifica el tipo de evento. Para una captura de pantalla del equipo, esta propiedad siempre se establece en computer_screenshot. Valores posibles: computer_screenshot	Sí

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

OpenAI.HerramientaDeVistaPreviaDeUsoDeComputadora

Herramienta que controla un equipo virtual.

Nombre	Tipo	Description	Obligatorio	Predeterminado
altura_de_pantalla	OpenAI.integer		Sí
ancho_de_pantalla	OpenAI.integer		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í

OpenAI.ContainerFileCitationBody

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	OpenAI.integer		Sí
ID del archivo	string	Identificador del archivo.	Sí
filename	string	Nombre de archivo del archivo de contenedor mencionado.	Sí
start_index	OpenAI.integer		Sí
type	enum	Tipo de la cita del archivo de contenedor. Siempre container_file_citation. Valores posibles: container_file_citation	Sí

OpenAI.ContainerMemoryLimit

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

OpenAI.ConversationItem

Un solo elemento dentro de una conversación. El conjunto de tipos posibles es el mismo que el output tipo de un objeto Response.

Discriminador para OpenAI.ConversationItem

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

Tipo de valor	Schema
message	OpenAI.ConversationItemMessage
function_call	OpenAI.ConversationItemFunctionToolCallResource
function_call_output	OpenAI.ConversationItemFunctionToolCallOutputResource
file_search_call	OpenAI.ConversationItemFileSearchToolCall
web_search_call	OpenAI.ConversationItemWebSearchToolCall
image_generation_call	OpenAI.ConversationItemImageGenToolCall
computer_call	OpenAI.ConversationItemComputerToolCall
computer_call_output	OpenAI.ConversationItemComputerToolCallOutputResource
reasoning	OpenAI.ConversationItemReasoningItem
code_interpreter_call	OpenAI.ConversationItemCodeInterpreterToolCall
local_shell_call	OpenAI.ConversationItemLocalShellToolCall
local_shell_call_output	OpenAI.ConversationItemLocalShellToolCallOutput
shell_call	OpenAI.ConversationItemFunctionShellCall
shell_call_output	OpenAI.ConversationItemFunctionShellCallOutput
apply_patch_call	OpenAI.ConversationItemApplyPatchToolCall
apply_patch_call_output	OpenAI.ConversationItemApplyPatchToolCallOutput
mcp_list_tools	OpenAI.ConversationItemMcpListTools
mcp_approval_request	OpenAI.ConversationItemMcpApprovalRequest
mcp_approval_response	OpenAI.ConversationItemMcpApprovalResponseResource
mcp_call	OpenAI.ConversationItemMcpToolCall
custom_tool_call	OpenAI.ConversationItemCustomToolCall
custom_tool_call_output	OpenAI.ConversationItemCustomToolCallOutput

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ConversationItemType		Sí

OpenAI.ConversationItemApplyPatchToolCall

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í

OpenAI.ConversationItemApplyPatchToolCallOutput

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 (que acepta valores NULL)		No
status	OpenAI.ApplyPatchCallOutputStatus		Sí
type	enum	Tipo del elemento. Siempre apply_patch_call_output. Valores posibles: apply_patch_call_output	Sí

OpenAI.ConversationItemCodeInterpreterToolCall

Una llamada de herramienta para ejecutar código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	string (que acepta valores 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		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, interpretingy 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í

OpenAI.ConversationItemComputerToolCall

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í

OpenAI.ConversationItemComputerToolCallOutputResource

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í

OpenAI.ConversationItemCustomToolCall

Una llamada a una herramienta personalizada creada por el modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
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.ConversationItemCustomToolCallOutput

La salida de una llamada de herramienta personalizada desde el código, que se devuelve al modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
call_id	string	El identificador de llamada, que se usa para asignar esta salida de llamada de herramienta personalizada a una llamada de herramienta personalizada.	Sí
id	string	Identificador único de la salida de llamada de herramienta personalizada en la plataforma OpenAI.	No
output	cadena o matriz de OpenAI.FunctionAndCustomToolCallOutput	Salida de la llamada a la herramienta personalizada generada por el código. Puede ser una cadena o una lista de contenido de salida.	Sí
type	enum	Tipo de la salida de la llamada a la herramienta personalizada. Siempre custom_tool_call_output. Valores posibles: custom_tool_call_output	Sí

OpenAI.ConversationItemFileSearchToolCall

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	Predeterminado
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		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.ConversationItemFunctionShellCall

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	OpenAI.integer (que acepta valores NULL)		Sí
└" timeout_ms	OpenAI.integer (que acepta valores 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í

OpenAI.ConversationItemFunctionShellCallOutput

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	OpenAI.integer (que acepta valores 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í

OpenAI.ConversationItemFunctionToolCallOutputResource

Nombre	Tipo	Description	Obligatorio	Predeterminado
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.ConversationItemFunctionToolCallResource

Nombre	Tipo	Description	Obligatorio	Predeterminado
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.ConversationItemImageGenToolCall

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	string	Identificador único de la llamada de generación de imágenes.	Sí
result	string (que acepta valores 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.ConversationItemList

Lista de elementos de conversación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
data	matriz de OpenAI.ConversationItem	Lista de elementos de conversación.	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.ConversationItemLocalShellToolCall

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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.ConversationItemLocalShellToolCallOutput

Salida de una llamada a la herramienta de shell local.

Nombre	Tipo	Description	Obligatorio	Predeterminado
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	enum	Valores posibles: in_progress, completed, incomplete	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.ConversationItemMcpApprovalRequest

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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.ConversationItemMcpApprovalResponseResource

Respuesta a una solicitud de aprobación de MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
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 (que acepta valores NULL)		No
type	enum	Tipo del elemento. Siempre mcp_approval_response. Valores posibles: mcp_approval_response	Sí

OpenAI.ConversationItemMcpListTools

Lista de herramientas disponibles en un servidor MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
error	string (que acepta valores 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.ConversationItemMcpToolCall

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
approval_request_id	string (que acepta valores NULL)		No
argumentos	string	Cadena JSON de los argumentos pasados a la herramienta.	Sí
error	string (que acepta valores 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 (que acepta valores 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.ConversationItemMessage

Mensaje hacia o desde el modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	matriz de OpenAI.MessageContent	Contenido del mensaje	Sí
id	string	Identificador único del mensaje.	Sí
role	OpenAI.MessageRole		Sí
status	OpenAI.MessageStatus		Sí
type	enum	Tipo del mensaje. Siempre se establece en message. Valores posibles: message	Sí

OpenAI.ConversationItemReasoningItem

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	Predeterminado
contenido	matriz de OpenAI.ReasoningTextContent	Contenido de texto de razonamiento.	No
encrypted_content	string (que acepta valores 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.ConversationItemType

Propiedad	Value
Type	string
Valores	message function_call function_call_output file_search_call web_search_call image_generation_call computer_call computer_call_output reasoning code_interpreter_call local_shell_call local_shell_call_output shell_call shell_call_output apply_patch_call apply_patch_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call custom_tool_call custom_tool_call_output

OpenAI.ConversationItemWebSearchToolCall

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

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.

OpenAI.ConversationParam-2

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	integer	Hora en la que se creó la conversación, medida en segundos desde la época de Unix.	Sí
id	string	Identificador único de la conversación.	Sí
metadatos	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 una estructura formatear 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.	Sí
object	enum	Tipo de objeto, que siempre conversationes . Valores posibles: conversation	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 Structured Outputs. 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
text	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
json_object	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.CreateChatCompletionRequestResponseFormatType		Sí

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

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

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
items	matriz de OpenAI.InputItem		No
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No

OpenAI.CreateEvalCompletionsRunDataSource

Objeto CompletionsRunDataSource que describe una configuración de muestreo del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
mensajes de entrada	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate o OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	Se usa al realizar el muestreo de un modelo. Dicta la estructura de los mensajes pasados al modelo. Puede ser una referencia a una trayectoria precompilada (es decir, item.input_trajectory), o una plantilla con referencias variables al item espacio de nombres.	No
model	string	Nombre del modelo que se va a usar para generar finalizaciones (por ejemplo, "o3-mini").	No
parámetros_de_muestreo	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		No
source	OpenAI.EvalJsonlFileContentSource o OpenAI.EvalJsonlFileIdSource o OpenAI.EvalStoredCompletionsSource	Determina lo que rellena el item espacio de nombres en el origen de datos de esta ejecución.	Sí
type	enum	Tipo de origen de datos de ejecución. Siempre completions. Valores posibles: completions	Sí

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

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

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Nombre	Tipo	Description	Obligatorio	Predeterminado
template	matriz de OpenAI.EasyInputMessage o OpenAI.EvalItem		Sí
type	enum	Valores posibles: template	Sí

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Nombre	Tipo	Description	Obligatorio	Predeterminado
max_completion_tokens	OpenAI.integer		No
esfuerzo de razonamiento	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de 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 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, mediumy 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-maxde .	No
formato_de_respuesta	OpenAI.ResponseFormatText o OpenAI.ResponseFormatJsonSchema o OpenAI.ResponseFormatJsonObject		No
inicialización	OpenAI.integer		No	42
temperatura	OpenAI.numeric		No	1
tools	matriz de OpenAI.ChatCompletionTool		No
top_p	OpenAI.numeric		No	1

OpenAI.CreateEvalCustomDataSourceConfig

Objeto CustomDataSourceConfig que define el esquema del origen de datos usado para las ejecuciones de evaluación. Este esquema se usa para definir la forma de los datos que serán:

• Se usa para definir los criterios de prueba y
• Qué datos son necesarios al crear una ejecución

Nombre	Tipo	Description	Obligatorio	Predeterminado
incluir_esquema_de_muestra	boolean	Si la evaluación debe esperar que rellene el espacio de nombres de ejemplo (por ejemplo, generando respuestas a partir de su origen de datos).	No
esquema_de_elemento	object	Esquema json para cada fila del origen de datos.	Sí
type	enum	Tipo de origen de datos. Siempre custom. Valores posibles: custom	Sí

OpenAI.CreateEvalJsonlRunDataSource

Un objeto JsonlRunDataSource que especifica un archivo JSONL que coincide con la evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
source	OpenAI.EvalJsonlFileContentSource o OpenAI.EvalJsonlFileIdSource	Determina lo que rellena el item espacio de nombres en el origen de datos.	Sí
type	enum	Tipo de origen de datos. Siempre jsonl. Valores posibles: jsonl	Sí

OpenAI.CreateEvalLogsDataSourceConfig

Una configuración del origen de datos que especifica la propiedad de metadatos de la consulta de registros. Esto suele ser metadatos como usecase=chatbot o prompt-version=v2, etc.

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadatos	object	Filtros de metadatos para el origen de datos de registros.	No
type	enum	Tipo de origen de datos. Siempre logs. Valores posibles: logs	Sí

OpenAI.CreateEvalResponsesRunDataSource

Objeto ResponsesRunDataSource que describe una configuración de muestreo del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
mensajes de entrada	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate o OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Se usa al realizar el muestreo de un modelo. Dicta la estructura de los mensajes pasados al modelo. Puede ser una referencia a una trayectoria precompilada (es decir, item.input_trajectory), o una plantilla con referencias variables al item espacio de nombres.	No
model	string	Nombre del modelo que se va a usar para generar finalizaciones (por ejemplo, "o3-mini").	No
parámetros_de_muestreo	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		No
source	OpenAI.EvalJsonlFileContentSource o OpenAI.EvalJsonlFileIdSource o OpenAI.EvalResponsesSource	Determina lo que rellena el item espacio de nombres en el origen de datos de esta ejecución.	Sí
type	enum	Tipo de origen de datos de ejecución. Siempre responses. Valores posibles: responses	Sí

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

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

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Nombre	Tipo	Description	Obligatorio	Predeterminado
template	matriz de objeto o OpenAI.EvalItem		Sí
type	enum	Valores posibles: template	Sí

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Nombre	Tipo	Description	Obligatorio	Predeterminado
max_completion_tokens	OpenAI.integer		No
esfuerzo de razonamiento	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de 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 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, mediumy 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-maxde .	No
inicialización	OpenAI.integer		No	42
temperatura	OpenAI.numeric		No	1
text	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		No
tools	matriz de OpenAI.Tool		No
top_p	OpenAI.numeric		No	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

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 gpt-4o y modelos 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

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

En desuso en favor de LogsDataSourceConfig.

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadatos	object	Filtros de metadatos para el origen de datos de finalizaciones almacenadas.	No
type	enum	Tipo de origen de datos. Siempre stored_completions. Valores posibles: stored_completions	Sí

OpenAI.CreateFineTuningJobRequest

Modelos válidos:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

Nombre	Tipo	Description	Obligatorio	Predeterminado
hiperparámetros	OpenAI.CreateFineTuningJobRequestHyperparameters		No
└─ tamaño del lote (batch_size)	string o OpenAI.integer		No	auto
"└─ learning_rate_multiplier"	string o OpenAI.numeric		No
├─ n_epochs	string o OpenAI.integer		No	auto
Integraciones	matriz de OpenAI.CreateFineTuningJobRequestIntegrations	Lista de integraciones que se habilitarán para el trabajo de ajuste preciso.	No
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
method	OpenAI.FineTuneMethod	Método que se usa para ajustar.	No
model	string (consulte los modelos válidos a continuación)	Nombre del modelo que se va a ajustar. Puede seleccionar una de las modelos soportados.	Sí
inicialización	OpenAI.integer (que acepta valores NULL)		No
sufijo	string (que acepta valores NULL)	Cadena de hasta 64 caracteres que se agregarán al nombre del modelo ajustado. Por ejemplo, un suffix de "custom-model-name" produciría un nombre de modelo como ft:gpt-4o-mini:openai:custom-model-name:7p4lURel. Restricciones: minLength: 1, maxLength: 64	No
archivo_de_entrenamiento	string	Identificador de un archivo cargado que contiene datos de entrenamiento. Consulte Upload file (Cargar archivo ) para obtener información sobre cómo cargar un archivo. El conjunto de datos debe tener el formato JSONL. Además, debe cargar el archivo con el propósito fine-tune. El contenido del archivo debe diferir en función de si el modelo usa el formato de chat, finalizaciones o si el método de ajuste utiliza el formato de preferencia . Consulta la guía ajuste fino para más detalles.	Sí
archivo_de_validación	string (que acepta valores NULL)	Identificador de un archivo cargado que contiene datos de validación. Si proporciona este archivo, los datos se usan para generar la validación. métricas periódicamente durante el ajuste preciso. Estas métricas se pueden ver en el archivo de resultados de ajuste preciso. Los mismos datos no deben estar presentes en los archivos de entrenamiento y validación. El conjunto de datos debe tener el formato JSONL. Debe cargar el archivo con el propósito fine-tune. Consulta la guía ajuste fino para más detalles.	No

OpenAI.CreateFineTuningJobRequestHyperparameters

Nombre	Tipo	Description	Obligatorio	Predeterminado
tamaño del lote	string o OpenAI.integer		No
multiplicador_de_tasa_de_aprendizaje	string o OpenAI.numeric		No
n_epochs (número de épocas)	string o OpenAI.integer		No

OpenAI.CreateFineTuningJobRequestIntegrations

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Valores posibles: wandb	Sí
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		Sí

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

Nombre	Tipo	Description	Obligatorio	Predeterminado
Entidad	string (que acepta valores NULL)		No
nombre	string (que acepta valores NULL)		No
proyecto	string		Sí
tags	matriz de cadenas		No

OpenAI.CreateResponseStreamingResponse

Tipo: OpenAI.ResponseAudioDeltaEvent o OpenAI.ResponseAudioTranscriptDeltaEvent o OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent o OpenAI.ResponseCodeInterpreterCallInProgressEvent o OpenAI.ResponseCodeInterpreterCallInterpretingEvent o OpenAI.ResponseContentPartAddedEvent o OpenAI.ResponseCreatedEvent o OpenAI.ResponseErrorEvent o OpenAI.ResponseErrorEvent o OpenAI.ResponseFileSearchCallInProgressEvent o OpenAI.ResponseFileSearchCallSearchingEvent o OpenAI.ResponseFunctionCallArgumentsDeltaEvent o OpenAI.ResponseInProgressEvent o OpenAI.ResponseFailedEvent o OpenAI.ResponseFailedEvent o OpenAI.ResponseIncompleteEvent o OpenAI.ResponseOutputItemAddedEvent o OpenAI.ResponseReasoningSummaryPartAddedEvent o OpenAI.ResponseReasoningSummaryTextDeltaEvent o OpenAI.ResponseReasoningTextDeltaEvent o OpenAI.ResponseRefusalDeltaEvent o OpenAI.ResponseTextDeltaEvent o OpenAI.ResponseWebSearchCallInProgressEvent o OpenAI.ResponseWebSearchCallSearchingEvent o OpenAI.ResponseImageGenCallGeneratingEvent o OpenAI.ResponseImageGenCallInProgressEvent o OpenAI.ResponseImageGenCallPartialImageEvent o OpenAI.ResponseImageGenPartialImageEvent o OpenAI.ResponseMCPCallArgumentsDeltaEvent o OpenAI.ResponseMCPCallFailedEvent o OpenAI.ResponseMCPCallInProgressEvent o OpenAI.ResponseMCPListToolsFailedEvent o OpenAI.ResponseMCPListToolsInProgressEvent o OpenAI.ResponseOutputTextAnnotationAddedEvent o OpenAI.ResponseQueuedEvent o OpenAI.ResponseCustomToolCallInputDeltaEvent o OpenAI.ResponseAudioDoneEvent o OpenAI.ResponseAudioTranscriptDoneEvent o OpenAI.ResponseCodeInterpreterCallCodeDoneEvent o OpenAI.ResponseCodeInterpreterCallCompletedEvent o OpenAI.ResponseCompletedEvent o OpenAI.ResponseContentPartDoneEvent o OpenAI.ResponseFileSearchCallCompletedEvent o OpenAI.ResponseFunctionCallArgumentsDoneEvent o OpenAI.ResponseOutputItemDoneEvent o OpenAI.ResponseOutputItemDoneEvent o OpenAI.ResponseReasoningSummaryPartDoneEvent o OpenAI.ResponseReasoningSummaryTextDoneEvent o OpenAI.ResponseReasoningTextDoneEvent o OpenAI.ResponseRefusalDoneEvent o OpenAI.ResponseTextDoneEvent o OpenAI.ResponseWebSearchCallCompletedEvent o OpenAI.ResponseImageGenCallCompletedEvent o OpenAI.ResponseMCPCallArgumentsDoneEvent o OpenAI.ResponseMCPCallCompletedEvent o OpenAI.ResponseMCPCallCompletedEvent o OpenAI.ResponseMCPListToolsCompletedEvent o OpenAI.ResponseCustomToolCallInputDoneEvent

OpenAI.CustomGrammarFormatParam

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í

OpenAI.CustomTextFormatParam

Texto de forma libre sin restricciones.

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

OpenAI.CustomToolParam

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í

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

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

OpenAI.DetailEnum

Propiedad	Value
Type	string
Valores	low high auto

OpenAI.DoubleClickAction

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í
x	OpenAI.integer		Sí
y	OpenAI.integer		Sí

OpenAI.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í

OpenAI.DragPoint

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
x	OpenAI.integer		Sí
y	OpenAI.integer		Sí

OpenAI.EasyInputMessage

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	Predeterminado
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í
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 message. Valores posibles: message	Sí

OpenAI.Error

Nombre	Tipo	Description	Obligatorio	Predeterminado
información adicional	object		No
código	string (que acepta valores NULL)		Sí
debugInfo	object		No
details	matriz de OpenAI.Error		No
message	string		Sí
param	string (que acepta valores NULL)		No
type	string		No

OpenAI.EvalApiError

Objeto que representa una respuesta de error de la API de Eval.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	string	Código de error.	Sí
message	string	El mensaje de error.	Sí

OpenAI.EvalGraderLabelModel

Nombre	Tipo	Description	Obligatorio	Predeterminado
input	matriz de OpenAI.EvalItem		Sí
labels	matriz de cadenas	Etiquetas que se van a asignar a cada elemento de la evaluación.	Sí
model	string	Modelo que se va a usar para la evaluación. Debe admitir salidas estructuradas.	Sí
nombre	string	Nombre del calificador.	Sí
passing_labels	matriz de cadenas	Las etiquetas que indican un resultado aprobado. Debe ser un subconjunto de etiquetas.	Sí
type	enum	Tipo de objeto, que siempre label_modeles . Valores posibles: label_model	Sí

OpenAI.EvalGraderPython

Nombre	Tipo	Description	Obligatorio	Predeterminado
image_tag	string	Etiqueta de imagen que se va a usar para el script de Python.	No
nombre	string	Nombre del calificador.	Sí
pass_threshold	OpenAI.numeric		No
source	string	Código fuente del script de Python.	Sí
type	enum	Tipo de objeto, que siempre pythones . Valores posibles: python	Sí

OpenAI.EvalGraderScoreModel

Nombre	Tipo	Description	Obligatorio	Predeterminado
input	matriz de OpenAI.EvalItem	Los mensajes de entrada evaluados por el calificador. Admite bloques de contenido de audio de texto, texto de salida, imagen de entrada y contenido de audio de entrada, y puede incluir cadenas de plantilla.	Sí
model	string	Modelo que se va a usar para la evaluación.	Sí
nombre	string	Nombre del calificador.	Sí
pass_threshold	OpenAI.numeric		No
intervalo	matriz de OpenAI.numeric	El rango de la puntuación. Tiene como valor predeterminado [0, 1].	No
parámetros_de_muestreo	OpenAI.EvalGraderScoreModelSamplingParams		No
└" max_completions_tokens	OpenAI.integer (que acepta valores NULL)		No
└─ esfuerzo_de_razonamiento	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de 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 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, mediumy 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-maxde .	No
└— semilla	OpenAI.integer (que acepta valores NULL)		No
└─ Temperatura	OpenAI.numeric (que acepta valores NULL)		No
└─ top_p	OpenAI.numeric (que acepta valores NULL)		No	1
type	enum	Tipo de objeto, que siempre score_modeles . Valores posibles: score_model	Sí

OpenAI.EvalGraderScoreModelSamplingParams

Nombre	Tipo	Description	Obligatorio	Predeterminado
max_completions_tokens	OpenAI.integer (que acepta valores NULL)		No
esfuerzo de razonamiento	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de 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 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, mediumy 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-maxde .	No
inicialización	OpenAI.integer (que acepta valores NULL)		No
temperatura	OpenAI.numeric (que acepta valores NULL)		No
top_p	OpenAI.numeric (que acepta valores NULL)		No	1

OpenAI.EvalGraderStringCheck

Nombre	Tipo	Description	Obligatorio	Predeterminado
input	string	Texto de entrada. Esto puede incluir cadenas de plantilla.	Sí
nombre	string	Nombre del calificador.	Sí
operation	enum	Operación de comprobación de cadena que se va a realizar. Uno de eq, ne, likeo ilike. Valores posibles: eq, ne, like, ilike	Sí
referencia	string	Texto de referencia. Esto puede incluir cadenas de plantilla.	Sí
type	enum	Tipo de objeto, que siempre string_checkes . Valores posibles: string_check	Sí

OpenAI.EvalGraderTextSimilarity

Nombre	Tipo	Description	Obligatorio	Predeterminado
métrica de evaluación	enum	Métrica de evaluación que se va a usar. Uno de los elementos cosine, fuzzy_match, , bleu gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5 o rouge_l. Valores posibles: cosine, fuzzy_match, , bleugleu, meteor, rouge_1rouge_2, rouge_3, , rouge_4, , rouge_5rouge_l	Sí
input	string	Texto que se va a calificar.	Sí
nombre	string	Nombre del calificador.	Sí
pass_threshold	OpenAI.numeric		Sí
referencia	string	Texto con el que se va a calificar.	Sí
type	enum	Tipo de calificador. Valores posibles: text_similarity	Sí

OpenAI.EvalItem

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	Predeterminado
contenido	OpenAI.EvalItemContent	Las entradas del modelo: pueden contener cadenas de plantilla. Admite texto, texto de salida, imágenes de entrada y audio de entrada, ya sea como un solo elemento o una matriz de elementos.	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	No

OpenAI.EvalItemContent

Las entradas del modelo: pueden contener cadenas de plantilla. Admite texto, texto de salida, imágenes de entrada y audio de entrada, ya sea como un solo elemento o una matriz de elementos.

Tipo: OpenAI.EvalItemContentItem o OpenAI.EvalItemContentArray

Las entradas del modelo: pueden contener cadenas de plantilla. Admite texto, texto de salida, imágenes de entrada y audio de entrada, ya sea como un solo elemento o una matriz de elementos.

OpenAI.EvalItemContentArray

Una lista de entradas, cada una de las cuales puede ser un texto de entrada, texto de salida, imagen de entrada o objeto de audio de entrada.

Matriz de: OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

Un único elemento de contenido: texto de entrada, texto de salida, imagen de entrada o audio de entrada.

Tipo: OpenAI.EvalItemContentText o OpenAI.EvalItemContentItemObject

Un único elemento de contenido: texto de entrada, texto de salida, imagen de entrada o audio de entrada.

OpenAI.EvalItemContentItemObject

Un único elemento de contenido: texto de entrada, texto de salida, imagen de entrada o audio de entrada.

Discriminador para OpenAI.EvalItemContentItemObject

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

Tipo de valor	Schema
output_text	OpenAI.EvalItemContentOutputText
input_image	OpenAI.EvalItemInputImage
input_audio	OpenAI.InputAudio
input_text	OpenAI.EvalItemContentItemObjectInputTextContent

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.EvalItemContentItemObjectType		Sí

OpenAI.EvalItemContentItemObjectInputTextContent

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í

OpenAI.EvalItemContentItemObjectType

Propiedad	Value
Type	string
Valores	input_text output_text input_image input_audio

OpenAI.EvalItemContentOutputText

Salida de texto del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
text	string	Salida de texto del modelo.	Sí
type	enum	Tipo del texto de salida. Siempre output_text. Valores posibles: output_text	Sí

OpenAI.EvalItemContentText

Entrada de texto al modelo.

Tipo: cadena

OpenAI.EvalItemInputImage

Bloque de entrada de imagen usado en matrices de contenido de EvalItem.

Nombre	Tipo	Description	Obligatorio	Predeterminado
detail	string	Nivel de detalle de la imagen que se va a enviar al modelo. Uno dehigh, low o auto. Tiene como valor predeterminado auto.	No
image_url	string	Dirección URL de la entrada de la imagen.	Sí
type	enum	Tipo de la entrada de la imagen. Siempre input_image. Valores posibles: input_image	Sí

OpenAI.EvalJsonlFileContentSource

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	matriz de OpenAI.EvalJsonlFileContentSourceContent	Contenido del archivo jsonl.	Sí
type	enum	Tipo de origen jsonl. Siempre file_content. Valores posibles: file_content	Sí

OpenAI.EvalJsonlFileContentSourceContent

Nombre	Tipo	Description	Obligatorio	Predeterminado
item	object		Sí
muestra	object		No

OpenAI.EvalJsonlFileIdSource

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	string	Identificador del archivo.	Sí
type	enum	Tipo de origen jsonl. Siempre file_id. Valores posibles: file_id	Sí

OpenAI.EvalResponsesSource

Objeto EvalResponsesSource que describe una configuración de origen de datos de ejecución.

Nombre	Tipo	Description	Obligatorio	Predeterminado
created_after	OpenAI.integer (que acepta valores NULL)		No
creado_antes_de	OpenAI.integer (que acepta valores NULL)		No
instructions_search	string (que acepta valores NULL)		No
metadatos	objeto (que acepta valores NULL)		No
model	string (que acepta valores NULL)		No
esfuerzo de razonamiento	OpenAI.ReasoningEffort (que acepta valores NULL)	Restringe el esfuerzo en el razonamiento de 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 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, mediumy 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-maxde .	No
temperatura	OpenAI.numeric (que acepta valores NULL)		No
tools	matriz de cadenas		No
top_p	OpenAI.numeric (que acepta valores NULL)		No
type	enum	Tipo de origen de datos de ejecución. Siempre responses. Valores posibles: responses	Sí
users	matriz de cadenas		No

OpenAI.EvalRunOutputItemSample

Nombre	Tipo	Description	Obligatorio	Predeterminado
error	OpenAI.EvalApiError	Objeto que representa una respuesta de error de la API de Eval.	Sí
razón de finalización	string		Sí
input	matriz de EvalRunOutputItemSampleInput		Sí
max_completion_tokens	OpenAI.integer		Sí
model	string		Sí
output	matriz de EvalRunOutputItemSampleOutput		Sí
inicialización	OpenAI.integer		Sí
temperatura	OpenAI.numeric		Sí
top_p	OpenAI.numeric		Sí
uso	OpenAI.EvalRunOutputItemSampleUsage		Sí

OpenAI.EvalRunOutputItemSampleUsage

Nombre	Tipo	Description	Obligatorio	Predeterminado
cached_tokens	OpenAI.integer		Sí
completion_tokens	OpenAI.integer		Sí
prompt_tokens	OpenAI.integer		Sí
total_tokens	OpenAI.integer		Sí

OpenAI.EvalRunPerModelUsage

Nombre	Tipo	Description	Obligatorio	Predeterminado
cached_tokens	OpenAI.integer		Sí
completion_tokens	OpenAI.integer		Sí
invocation_count	OpenAI.integer		Sí
model_name	string		Sí
prompt_tokens	OpenAI.integer		Sí
total_tokens	OpenAI.integer		Sí

OpenAI.EvalRunPerTestingCriteriaResults

Nombre	Tipo	Description	Obligatorio	Predeterminado
fallido	OpenAI.integer		Sí
pasado	OpenAI.integer		Sí
criterios_de_prueba	string		Sí

OpenAI.EvalRunResultCounts

Nombre	Tipo	Description	Obligatorio	Predeterminado
error	OpenAI.integer		Sí
fallido	OpenAI.integer		Sí
pasado	OpenAI.integer		Sí
total	OpenAI.integer		Sí

OpenAI.EvalStoredCompletionsSource

Una configuración StoredCompletionsRunDataSource que describe un conjunto de filtros

Nombre	Tipo	Description	Obligatorio	Predeterminado
created_after	OpenAI.integer (que acepta valores NULL)		No
creado_antes_de	OpenAI.integer (que acepta valores NULL)		No
limit	OpenAI.integer (que acepta valores NULL)		No
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
model	string (que acepta valores NULL)		No
type	enum	Tipo de origen. Siempre stored_completions. Valores posibles: stored_completions	Sí

OpenAI.FileCitationBody

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	OpenAI.integer		Sí
type	enum	Tipo de la cita de archivo. Siempre file_citation. Valores posibles: file_citation	Sí

OpenAI.FilePath

Ruta de acceso a un archivo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
ID del archivo	string	Identificador del archivo.	Sí
index	OpenAI.integer		Sí
type	enum	Tipo de la ruta de acceso del archivo. Siempre file_path. Valores posibles: file_path	Sí

OpenAI.FileSearchTool

Herramienta que busca contenido relevante de los archivos cargados.

Nombre	Tipo	Description	Obligatorio	Predeterminado
filtros	OpenAI.Filters (que acepta valores NULL)		No
número_máximo_de_resultados	OpenAI.integer		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	OpenAI.numeric	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í
vector_store_ids	matriz de cadenas	Identificadores de los almacenes vectoriales que se van a buscar.	Sí

OpenAI.FileSearchToolCallResults

Nombre	Tipo	Description	Obligatorio	Predeterminado
attributes	OpenAI.VectorStoreFileAttributes (que acepta valores NULL)	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 una estructura formatear 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 un máximo longitud de 512 caracteres, booleanos o números.	No
ID del archivo	string		No
filename	string		No
puntuación	número		No
text	string		No

OpenAI.Filters

Tipo: OpenAI.ComparisonFilter o OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

Hiperparámetros usados para el trabajo de ajuste de precisión del DPO.

Nombre	Tipo	Description	Obligatorio	Predeterminado
tamaño del lote	string o OpenAI.integer	Número de ejemplos de cada lote. Un tamaño de lote mayor significa que los parámetros del modelo se actualizan con menos frecuencia, pero con una varianza menor.	No
beta	string o OpenAI.numeric	Valor beta del método DPO. Un valor beta mayor aumentará el peso de la penalización entre la directiva y el modelo de referencia.	No
multiplicador_de_tasa_de_aprendizaje	string o OpenAI.numeric	Factor de escala para la velocidad de aprendizaje. Una tasa de aprendizaje más pequeña puede ser útil para evitar el sobreajuste.	No
n_epochs (número de épocas)	string o OpenAI.integer	El número de épocas para las que se entrenará el modelo. Una época hace referencia a un ciclo completo a través del conjunto de datos de entrenamiento.	No

OpenAI.FineTuneDPOMethod

Configuración para el método de ajuste de precisión de DPO.

Nombre	Tipo	Description	Obligatorio	Predeterminado
hiperparámetros	OpenAI.FineTuneDPOHyperparameters	Hiperparámetros usados para el trabajo de ajuste de precisión del DPO.	No

OpenAI.FineTuneMethod

Método que se usa para ajustar.

Nombre	Tipo	Description	Obligatorio	Predeterminado
dpo	OpenAI.FineTuneDPOMethod	Configuración para el método de ajuste de precisión de DPO.	No
refuerzo	OpenAI.FineTuneReinforcementMethod	Configuración del método de ajuste fino de refuerzo.	No
Supervisado	OpenAI.FineTuneSupervisedMethod	Configuración del método de ajuste fino supervisado.	No
type	enum	Tipo de método. supervisedEs , dpoo reinforcement. Valores posibles: supervised, dpo, reinforcement	Sí

OpenAI.FineTuneReinforcementHyperparameters

Los hiperparámetros usados para el trabajo de ajuste fino de refuerzo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
tamaño del lote	string o OpenAI.integer	Número de ejemplos de cada lote. Un tamaño de lote mayor significa que los parámetros del modelo se actualizan con menos frecuencia, pero con una varianza menor.	No
compute_multiplier	string o OpenAI.numeric	Multiplicador en la cantidad de proceso que se usa para explorar el espacio de búsqueda durante el entrenamiento.	No
eval_interval	string o OpenAI.integer	Número de pasos de entrenamiento antes de cada ejecución de evaluación.	No
eval_samples	string o OpenAI.integer	Número de muestras de evaluación que se van a generar por paso de entrenamiento.	No
multiplicador_de_tasa_de_aprendizaje	string o OpenAI.numeric	Factor de escala para la velocidad de aprendizaje. Una tasa de aprendizaje más pequeña puede ser útil para evitar el sobreajuste.	No
n_epochs (número de épocas)	string o OpenAI.integer	El número de épocas para las que se entrenará el modelo. Una época hace referencia a un ciclo completo a través del conjunto de datos de entrenamiento.	No
esfuerzo de razonamiento	enum	Nivel de esfuerzo de razonamiento. Valores posibles: default, low, medium, high	No

OpenAI.FineTuneReinforcementMethod

Configuración del método de ajuste fino de refuerzo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
grader	OpenAI.GraderStringCheck o OpenAI.GraderTextSimilarity o OpenAI.GraderPython o OpenAI.GraderScoreModel o OpenAI.GraderMulti	Calificador utilizado para el trabajo de ajuste fino.	Sí
hiperparámetros	OpenAI.FineTuneReinforcementHyperparameters	Los hiperparámetros usados para el trabajo de ajuste fino de refuerzo.	No

OpenAI.FineTuneSupervisedHyperparameters

Hiperparámetros usados para el trabajo de ajuste preciso.

Nombre	Tipo	Description	Obligatorio	Predeterminado
tamaño del lote	string o OpenAI.integer	Número de ejemplos de cada lote. Un tamaño de lote mayor significa que los parámetros del modelo se actualizan con menos frecuencia, pero con una varianza menor.	No
multiplicador_de_tasa_de_aprendizaje	string o OpenAI.numeric	Factor de escala para la velocidad de aprendizaje. Una tasa de aprendizaje más pequeña puede ser útil para evitar el sobreajuste.	No
n_epochs (número de épocas)	string o OpenAI.integer	El número de épocas para las que se entrenará el modelo. Una época hace referencia a un ciclo completo a través del conjunto de datos de entrenamiento.	No

OpenAI.FineTuneSupervisedMethod

Configuración del método de ajuste fino supervisado.

Nombre	Tipo	Description	Obligatorio	Predeterminado
hiperparámetros	OpenAI.FineTuneSupervisedHyperparameters	Hiperparámetros usados para el trabajo de ajuste preciso.	No

OpenAI.FineTuningIntegration

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de integración que se está habilitando para el trabajo de ajuste preciso Valores posibles: wandb	Sí
wandb	OpenAI.FineTuningIntegrationWandb		Sí
Entidad └	string (que acepta valores NULL)		No
└─ Nombre	string (que acepta valores NULL)		No
└─ proyecto	string		Sí
Etiquetas └—	matriz de cadenas		No

OpenAI.FineTuningIntegrationWandb

Nombre	Tipo	Description	Obligatorio	Predeterminado
Entidad	string (que acepta valores NULL)		No
nombre	string (que acepta valores NULL)		No
proyecto	string		Sí
tags	matriz de cadenas		No

OpenAI.FineTuningJob

El fine_tuning.job objeto representa un trabajo de ajuste preciso que se ha creado a través de la API.

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	integer	Marca de tiempo de Unix (en segundos) para cuando se creó el trabajo de ajuste preciso.	Sí
error	OpenAI.FineTuningJobError (que acepta valores NULL)		Sí
└─ código	string		Sí
└─ Mensaje	string		Sí
└— param	string (que acepta valores NULL)		Sí
fin estimado	integer		No
modelo afinado	string (que acepta valores NULL)		Sí
finished_at	integer		Sí
hiperparámetros	OpenAI.FineTuningJobHyperparameters		Sí
└─ tamaño del lote (batch_size)	string o OpenAI.integer		No	auto
"└─ learning_rate_multiplier"	string o OpenAI.numeric		No
├─ n_epochs	string o OpenAI.integer		No	auto
id	string	Identificador de objeto, al que se puede hacer referencia en los puntos de conexión de API.	Sí
Integraciones	matriz de OpenAI.FineTuningIntegration		No
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
method	OpenAI.FineTuneMethod	Método que se usa para ajustar.	No
model	string	Modelo base que se está ajustando.	Sí
object	enum	Tipo de objeto, que siempre es "fine_tuning.job". Valores posibles: fine_tuning.job	Sí
organization_id	string	La organización que posee el trabajo de ajuste preciso.	Sí
archivos_de_resultados	matriz de cadenas	Identificadores de archivo de resultados compilados para el trabajo de ajuste preciso. Puede recuperar los resultados con la API files.	Sí
inicialización	OpenAI.integer		Sí
status	enum	Estado actual del trabajo de ajuste fino, que puede ser validating_files, queued, running, succeeded, failedo cancelled. Valores posibles: validating_files, queued, running, succeeded, , failed, cancelled	Sí
trained_tokens	OpenAI.integer (que acepta valores NULL)		Sí
archivo_de_entrenamiento	string	Identificador de archivo usado para el entrenamiento. Puede recuperar los datos de entrenamiento con la API Files.	Sí
archivo_de_validación	string (que acepta valores NULL)		Sí

OpenAI.FineTuningJobCheckpoint

El fine_tuning.job.checkpoint objeto representa un punto de control de modelo para un trabajo de ajuste que está listo para usarse.

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	integer	Marca de tiempo de Unix (en segundos) para cuando se creó el punto de control.	Sí
fine_tuned_model_checkpoint	string	Nombre del modelo de punto de control ajustado que se crea.	Sí
fine_tuning_job_id	string	El nombre del trabajo de ajuste preciso del que se creó este punto de control.	Sí
id	string	Identificador de punto de control, al que se puede hacer referencia en los puntos de conexión de API.	Sí
metrics	OpenAI.FineTuningJobCheckpointMetrics		Sí
└─ full_valid_loss	OpenAI.numeric		No
└─ precisión de media de tokens válidos completos	OpenAI.numeric		No
Paso └	OpenAI.numeric		No
└─ pérdida_entrenamiento	OpenAI.numeric		No
└─ train_mean_token_accuracy (precisión media del token de entrenamiento)	OpenAI.numeric		No
└─ pérdida_de_validación	OpenAI.numeric		No
└" valid_mean_token_accuracy	OpenAI.numeric		No
object	enum	Tipo de objeto, que siempre es "fine_tuning.job.checkpoint". Valores posibles: fine_tuning.job.checkpoint	Sí
número_de_paso	OpenAI.integer		Sí

OpenAI.FineTuningJobCheckpointMetrics

Nombre	Tipo	Description	Obligatorio	Predeterminado
full_valid_loss	OpenAI.numeric		No
full_valid_mean_token_accuracy	OpenAI.numeric		No
paso	OpenAI.numeric		No
train_loss	OpenAI.numeric		No
train_mean_token_accuracy	OpenAI.numeric		No
valid_loss	OpenAI.numeric		No
valid_mean_token_accuracy	OpenAI.numeric		No

OpenAI.FineTuningJobError

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	string		Sí
message	string		Sí
param	string (que acepta valores NULL)		Sí

OpenAI.FineTuningJobEvent

Objeto de evento de trabajo de ajuste preciso

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	integer	Marca de tiempo de Unix (en segundos) para cuando se creó el trabajo de ajuste preciso.	Sí
data	OpenAI.FineTuningJobEventData		No
id	string	Identificador de objeto.	Sí
level	enum	Nivel de registro del evento. Valores posibles: info, warn, error	Sí
message	string	Mensaje del evento.	Sí
object	enum	Tipo de objeto, que siempre es "fine_tuning.job.event". Valores posibles: fine_tuning.job.event	Sí
type	enum	Tipo de evento. Valores posibles: message, metrics	No

OpenAI.FineTuningJobEventData

Tipo: objeto

OpenAI.FineTuningJobHyperparameters

Nombre	Tipo	Description	Obligatorio	Predeterminado
tamaño del lote	string o OpenAI.integer		No
multiplicador_de_tasa_de_aprendizaje	string o OpenAI.numeric		No
n_epochs (número de épocas)	string o OpenAI.integer		No

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

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 (que acepta valores NULL)		No
file_url	string	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í

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

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 (que acepta valores NULL)		No
image_url	string		No
type	enum	Tipo del elemento de entrada. Siempre input_image. Valores posibles: input_image	Sí

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

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í

OpenAI.FunctionAndCustomToolCallOutputType

Propiedad	Value
Type	string
Valores	input_text input_image input_file

OpenAI.FunctionCallItemStatus

Propiedad	Value
Type	string
Valores	in_progress completed incomplete

OpenAI.FunctionObject

Nombre	Tipo	Description	Obligatorio	Predeterminado
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 guía para ejemplos, y la referencia JSON Schema 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 (que acepta valores NULL)		No

OpenAI.FunctionParameters

Los parámetros que aceptan las funciones, que se describen como un objeto de esquema JSON. Consulta la guía para ejemplos, y la referencia JSON Schema 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.FunctionShellAction

Ejecute un comando de shell.

Nombre	Tipo	Description	Obligatorio	Predeterminado
commands	matriz de cadenas		Sí
max_output_length	OpenAI.integer (que acepta valores NULL)		Sí
tiempo_de_espera_ms	OpenAI.integer (que acepta valores NULL)		Sí

OpenAI.FunctionShellActionParam

Comandos y límites que describen cómo ejecutar la llamada a la herramienta de shell.

Nombre	Tipo	Description	Obligatorio	Predeterminado
commands	matriz de cadenas	Comandos de shell ordenados para que se ejecute el entorno de ejecución.	Sí
max_output_length	OpenAI.integer (que acepta valores NULL)		No
tiempo_de_espera_ms	OpenAI.integer (que acepta valores NULL)		No

OpenAI.FunctionShellCallItemStatus

Valores de estado notificados para las llamadas a herramientas de shell.

Propiedad	Value
Type	string
Valores	in_progress completed incomplete

OpenAI.FunctionShellCallOutputContent

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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.FunctionShellCallOutputContentParam

Stdout capturado y stderr para una parte de una salida de llamada de herramienta de shell.

Nombre	Tipo	Description	Obligatorio	Predeterminado
resultado	OpenAI.FunctionShellCallOutputOutcomeParam	Resultado de salida o tiempo de espera asociado a esta llamada de shell.	Sí
└─ Tipo	OpenAI.FunctionShellCallOutputOutcomeParamType		Sí
stderr	string	Salida stderr capturada para la llamada de shell. Restricciones: maxLength: 10485760	Sí
stdout	string	Salida stdout capturada para la llamada de shell. Restricciones: maxLength: 10485760	Sí

OpenAI.FunctionShellCallOutputExitOutcome

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
exit_code	OpenAI.integer		Sí
type	enum	Tipo de resultado. Siempre exit. Valores posibles: exit	Sí

OpenAI.FunctionShellCallOutputExitOutcomeParam

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
exit_code	OpenAI.integer		Sí
type	enum	Tipo de resultado. Siempre exit. Valores posibles: exit	Sí

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.

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

Resultado de salida o tiempo de espera asociado a esta llamada de shell.

Discriminador para OpenAI.FunctionShellCallOutputOutcomeParam

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

Tipo de valor	Schema
timeout	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
exit	OpenAI.FunctionShellCallOutputExitOutcomeParam

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.FunctionShellCallOutputOutcomeParamType		Sí

OpenAI.FunctionShellCallOutputOutcomeParamType

Propiedad	Value
Type	string
Valores	timeout exit

OpenAI.FunctionShellCallOutputOutcomeType

Propiedad	Value
Type	string
Valores	timeout exit

OpenAI.FunctionShellCallOutputTimeoutOutcome

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í

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

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í

OpenAI.FunctionShellToolParam

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í

OpenAI.FunctionTool

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string (que acepta valores NULL)		No
nombre	string	El nombre de la función para llamar.	Sí
parameters	objeto (que acepta valores NULL)		Sí
strict	booleano (que acepta valores NULL)		Sí
type	enum	Tipo de la herramienta de funciones. Siempre function. Valores posibles: function	Sí

OpenAI.GraderLabelModel

Objeto LabelModelGrader que usa un modelo para asignar etiquetas a cada elemento de la evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
input	matriz de OpenAI.EvalItem		Sí
labels	matriz de cadenas	Etiquetas que se van a asignar a cada elemento de la evaluación.	Sí
model	string	Modelo que se va a usar para la evaluación. Debe admitir salidas estructuradas.	Sí
nombre	string	Nombre del calificador.	Sí
passing_labels	matriz de cadenas	Las etiquetas que indican un resultado aprobado. Debe ser un subconjunto de etiquetas.	Sí
type	enum	Tipo de objeto, que siempre label_modeles . Valores posibles: label_model	Sí

OpenAI.GraderMulti

Un objeto MultiGrader combina la salida de varios calificadores para generar una sola puntuación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
calculate_output	string	Fórmula para calcular la salida en función de los resultados del calificador.	Sí
calificaciones	OpenAI.GraderStringCheck o OpenAI.GraderTextSimilarity o OpenAI.GraderPython o OpenAI.GraderScoreModel o OpenAI.GraderLabelModel		Sí
nombre	string	Nombre del calificador.	Sí
type	enum	Tipo de objeto, que siempre multies . Valores posibles: multi	Sí

OpenAI.GraderPython

Objeto PythonGrader que ejecuta un script de Python en la entrada.

Nombre	Tipo	Description	Obligatorio	Predeterminado
image_tag	string	Etiqueta de imagen que se va a usar para el script de Python.	No
nombre	string	Nombre del calificador.	Sí
source	string	Código fuente del script de Python.	Sí
type	enum	Tipo de objeto, que siempre pythones . Valores posibles: python	Sí

OpenAI.GraderScoreModel

Objeto ScoreModelGrader que usa un modelo para asignar una puntuación a la entrada.

Nombre	Tipo	Description	Obligatorio	Predeterminado
input	matriz de OpenAI.EvalItem	Los mensajes de entrada evaluados por el calificador. Admite bloques de contenido de audio de texto, texto de salida, imagen de entrada y contenido de audio de entrada, y puede incluir cadenas de plantilla.	Sí
model	string	Modelo que se va a usar para la evaluación.	Sí
nombre	string	Nombre del calificador.	Sí
intervalo	matriz de OpenAI.numeric	El rango de la puntuación. Tiene como valor predeterminado [0, 1].	No
parámetros_de_muestreo	OpenAI.EvalGraderScoreModelSamplingParams		No
└" max_completions_tokens	OpenAI.integer (que acepta valores NULL)		No
└─ esfuerzo_de_razonamiento	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de 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 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, mediumy 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-maxde .	No
└— semilla	OpenAI.integer (que acepta valores NULL)		No
└─ Temperatura	OpenAI.numeric (que acepta valores NULL)		No
└─ top_p	OpenAI.numeric (que acepta valores NULL)		No	1
type	enum	Tipo de objeto, que siempre score_modeles . Valores posibles: score_model	Sí

OpenAI.GraderStringCheck

Objeto StringCheckGrader que realiza una comparación de cadenas entre la entrada y la referencia mediante una operación especificada.

Nombre	Tipo	Description	Obligatorio	Predeterminado
input	string	Texto de entrada. Esto puede incluir cadenas de plantilla.	Sí
nombre	string	Nombre del calificador.	Sí
operation	enum	Operación de comprobación de cadena que se va a realizar. Uno de eq, ne, likeo ilike. Valores posibles: eq, ne, like, ilike	Sí
referencia	string	Texto de referencia. Esto puede incluir cadenas de plantilla.	Sí
type	enum	Tipo de objeto, que siempre string_checkes . Valores posibles: string_check	Sí

OpenAI.GraderTextSimilarity

Objeto TextSimilarityGrader que clasifica el texto en función de las métricas de similitud.

Nombre	Tipo	Description	Obligatorio	Predeterminado
métrica de evaluación	enum	Métrica de evaluación que se va a usar. Uno de los elementos cosine, fuzzy_match, , bleu gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5 o rouge_l. Valores posibles: cosine, fuzzy_match, , bleugleu, meteor, rouge_1rouge_2, rouge_3, , rouge_4, , rouge_5rouge_l	Sí
input	string	Texto que se va a calificar.	Sí
nombre	string	Nombre del calificador.	Sí
referencia	string	Texto con el que se va a calificar.	Sí
type	enum	Tipo de calificador. Valores posibles: text_similarity	Sí

OpenAI.GrammarSyntax1

Propiedad	Value
Type	string
Valores	lark regex

OpenAI.HybridSearchOptions

Nombre	Tipo	Description	Obligatorio	Predeterminado
embedding_weight	OpenAI.numeric		Sí
text_weight	OpenAI.numeric		Sí

OpenAI.ImageDetail

Propiedad	Value
Type	string
Valores	low high auto

OpenAI.ImageGenTool

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
input_fidelity	OpenAI.InputFidelity (que acepta valores NULL)	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.	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
compresión_de_salida	OpenAI.integer		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
imágenes_parciales	OpenAI.integer		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
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
type	enum	Tipo de la herramienta de generación de imágenes. Siempre image_generation. Valores posibles: image_generation	Sí

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: 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). | | Tipo | 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
memory_search_call.results |

OpenAI.InputAudio

Entrada de audio al modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
input_audio	OpenAI.InputAudioInputAudio		Sí
type	enum	Tipo del elemento de entrada. Siempre input_audio. Valores posibles: input_audio	Sí

OpenAI.InputAudioInputAudio

Nombre	Tipo	Description	Obligatorio	Predeterminado
data	string		Sí
format	enum	Valores posibles: mp3, wav	Sí

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

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 (que acepta valores NULL)		No
file_url	string	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í

OpenAI.InputContentInputImageContent

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 (que acepta valores NULL)		No
image_url	string		No
type	enum	Tipo del elemento de entrada. Siempre input_image. Valores posibles: input_image	Sí

OpenAI.InputContentInputTextContent

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í

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

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 (que acepta valores NULL)		No
file_url	string	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í

OpenAI.InputFileContentParam

Entrada de archivo para el modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
file_data	string (que acepta valores NULL)		No
ID del archivo	string (que acepta valores NULL)		No
file_url	string		No
filename	string (que acepta valores NULL)		No
type	enum	Tipo del elemento de entrada. Siempre input_file. Valores posibles: input_file	Sí

OpenAI.InputImageContent

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 (que acepta valores NULL)		No
image_url	string		No
type	enum	Tipo del elemento de entrada. Siempre input_image. Valores posibles: input_image	Sí

OpenAI.InputImageContentParamAutoParam

Entrada de imagen en el modelo. Más información sobre las entradas de imagen

Nombre	Tipo	Description	Obligatorio	Predeterminado
detail	OpenAI.DetailEnum (que acepta valores NULL)		No
ID del archivo	string (que acepta valores NULL)		No
image_url	string		No
type	enum	Tipo del elemento de entrada. Siempre input_image. Valores posibles: input_image	Sí

OpenAI.InputItem

Elemento que representa parte del contexto para que el modelo genere la respuesta. Puede contener entradas de texto, imágenes y audio, así como respuestas anteriores del asistente y salidas de llamadas a herramientas.

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
output_message	OpenAI.InputItemOutputMessage
file_search_call	OpenAI.InputItemFileSearchToolCall
computer_call	OpenAI.InputItemComputerToolCall
computer_call_output	OpenAI.InputItemComputerCallOutputItemParam
web_search_call	OpenAI.InputItemWebSearchToolCall
function_call	OpenAI.InputItemFunctionToolCall
function_call_output	OpenAI.InputItemFunctionCallOutputItemParam
reasoning	OpenAI.InputItemReasoningItem
compaction	OpenAI.InputItemCompactionSummaryItemParam
image_generation_call	OpenAI.InputItemImageGenToolCall
code_interpreter_call	OpenAI.InputItemCodeInterpreterToolCall
local_shell_call	OpenAI.InputItemLocalShellToolCall
local_shell_call_output	OpenAI.InputItemLocalShellToolCallOutput
shell_call	OpenAI.InputItemFunctionShellCallItemParam
shell_call_output	OpenAI.InputItemFunctionShellCallOutputItemParam
apply_patch_call	OpenAI.InputItemApplyPatchToolCallItemParam
apply_patch_call_output	OpenAI.InputItemApplyPatchToolCallOutputItemParam
mcp_list_tools	OpenAI.InputItemMcpListTools
mcp_approval_request	OpenAI.InputItemMcpApprovalRequest
mcp_approval_response	OpenAI.InputItemMcpApprovalResponse
mcp_call	OpenAI.InputItemMcpToolCall
custom_tool_call_output	OpenAI.InputItemCustomToolCallOutput
custom_tool_call	OpenAI.InputItemCustomToolCall

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.InputItemType		Sí

OpenAI.InputItemApplyPatchToolCallItemParam

Una llamada a herramienta que representa una solicitud para crear, eliminar o actualizar archivos mediante revisiones de diferencias.

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. Restricciones: minLength: 1, maxLength: 64	Sí
id	string (que acepta valores NULL)		No
operation	OpenAI.ApplyPatchOperationParam	Una de las operaciones de create_file, delete_file o update_file proporcionadas a la herramienta de apply_patch.	Sí
└─ Tipo	OpenAI.ApplyPatchOperationParamType		Sí
status	OpenAI.ApplyPatchCallStatusParam	Valores de estado notificados para las llamadas a herramientas de apply_patch.	Sí
type	enum	Tipo del elemento. Siempre apply_patch_call. Valores posibles: apply_patch_call	Sí

OpenAI.InputItemApplyPatchToolCallOutputItemParam

Salida transmitida por una llamada a la herramienta aplicar revisión.

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. Restricciones: minLength: 1, maxLength: 64	Sí
id	string (que acepta valores NULL)		No
output	string (que acepta valores NULL)		No
status	OpenAI.ApplyPatchCallOutputStatusParam	Valores de resultados notificados para apply_patch salidas de llamada de herramienta.	Sí
type	enum	Tipo del elemento. Siempre apply_patch_call_output. Valores posibles: apply_patch_call_output	Sí

OpenAI.InputItemCodeInterpreterToolCall

Una llamada de herramienta para ejecutar código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	string (que acepta valores 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		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, interpretingy 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í

OpenAI.InputItemCompactionSummaryItemParam

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
encrypted_content	string	Contenido cifrado del resumen de compactación. Restricciones: maxLength: 10485760	Sí
id	string (que acepta valores NULL)		No
type	enum	Tipo del elemento. Siempre compaction. Valores posibles: compaction	Sí

OpenAI.InputItemComputerCallOutputItemParam

Salida de una llamada a una herramienta de equipo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acknowledged_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam		No
call_id	string	Identificador de la llamada a la herramienta de equipo que generó la salida. Restricciones: minLength: 1, maxLength: 64	Sí
id	string (que acepta valores NULL)		No
output	OpenAI.ComputerScreenshotImage	Imagen de captura de pantalla del equipo que se usa con la herramienta de uso del equipo.	Sí
status	OpenAI.FunctionCallItemStatus (que acepta valores NULL)		No
type	enum	Tipo de la salida de llamada de la herramienta de equipo. Siempre computer_call_output. Valores posibles: computer_call_output	Sí

OpenAI.InputItemComputerToolCall

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í

OpenAI.InputItemCustomToolCall

Una llamada a una herramienta personalizada creada por el modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
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.InputItemCustomToolCallOutput

La salida de una llamada de herramienta personalizada desde el código, que se devuelve al modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
call_id	string	El identificador de llamada, que se usa para asignar esta salida de llamada de herramienta personalizada a una llamada de herramienta personalizada.	Sí
id	string	Identificador único de la salida de llamada de herramienta personalizada en la plataforma OpenAI.	No
output	cadena o matriz de OpenAI.FunctionAndCustomToolCallOutput	Salida de la llamada a la herramienta personalizada generada por el código. Puede ser una cadena o una lista de contenido de salida.	Sí
type	enum	Tipo de la salida de la llamada a la herramienta personalizada. Siempre custom_tool_call_output. Valores posibles: custom_tool_call_output	Sí

OpenAI.InputItemFileSearchToolCall

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	Predeterminado
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		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.InputItemFunctionCallOutputItemParam

Salida de una llamada a la herramienta de función.

Nombre	Tipo	Description	Obligatorio	Predeterminado
call_id	string	Identificador único de la llamada a la herramienta de función generada por el modelo. Restricciones: minLength: 1, maxLength: 64	Sí
id	string (que acepta valores NULL)		No
output	cadena o matriz de OpenAI.InputTextContentParam o OpenAI.InputImageContentParamAutoParam o OpenAI.InputFileContentParam	Salida de texto, imagen o archivo de la llamada a la herramienta de función.	Sí
status	OpenAI.FunctionCallItemStatus (que acepta valores NULL)		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.InputItemFunctionShellCallItemParam

Herramienta que representa una solicitud para ejecutar uno o varios comandos de shell.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acción	OpenAI.FunctionShellActionParam	Comandos y límites que describen cómo ejecutar la llamada a la herramienta de shell.	Sí
Comandos └	matriz de cadenas	Comandos de shell ordenados para que se ejecute el entorno de ejecución.	Sí
└" max_output_length	OpenAI.integer (que acepta valores NULL)		No
└" timeout_ms	OpenAI.integer (que acepta valores NULL)		No
call_id	string	Identificador único de la llamada a la herramienta de shell generada por el modelo. Restricciones: minLength: 1, maxLength: 64	Sí
id	string (que acepta valores NULL)		No
status	OpenAI.FunctionShellCallItemStatus (que acepta valores NULL)	Valores de estado notificados para las llamadas a herramientas de shell.	No
type	enum	Tipo del elemento. Siempre shell_call. Valores posibles: shell_call	Sí

OpenAI.InputItemFunctionShellCallOutputItemParam

Los elementos de salida transmitidos emitidos por una llamada a la herramienta de shell.

Nombre	Tipo	Description	Obligatorio	Predeterminado
call_id	string	Identificador único de la llamada a la herramienta de shell generada por el modelo. Restricciones: minLength: 1, maxLength: 64	Sí
id	string (que acepta valores NULL)		No
max_output_length	OpenAI.integer (que acepta valores NULL)		No
output	matriz de OpenAI.FunctionShellCallOutputContentParam	Fragmentos capturados de salida stdout y stderr, junto con sus resultados asociados.	Sí
type	enum	Tipo del elemento. Siempre shell_call_output. Valores posibles: shell_call_output	Sí

OpenAI.InputItemFunctionToolCall

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	Predeterminado
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.InputItemImageGenToolCall

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	string	Identificador único de la llamada de generación de imágenes.	Sí
result	string (que acepta valores 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.InputItemLocalShellToolCall

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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.InputItemLocalShellToolCallOutput

Salida de una llamada a la herramienta de shell local.

Nombre	Tipo	Description	Obligatorio	Predeterminado
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	enum	Valores posibles: in_progress, completed, incomplete	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.InputItemMcpApprovalRequest

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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.InputItemMcpApprovalResponse

Respuesta a una solicitud de aprobación de MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
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 (que acepta valores NULL)		No
razón	string (que acepta valores NULL)		No
type	enum	Tipo del elemento. Siempre mcp_approval_response. Valores posibles: mcp_approval_response	Sí

OpenAI.InputItemMcpListTools

Lista de herramientas disponibles en un servidor MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
error	string (que acepta valores 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.InputItemMcpToolCall

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
approval_request_id	string (que acepta valores NULL)		No
argumentos	string	Cadena JSON de los argumentos pasados a la herramienta.	Sí
error	string (que acepta valores 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 (que acepta valores 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.InputItemOutputMessage

Mensaje de salida del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
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.InputItemReasoningItem

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	Predeterminado
contenido	matriz de OpenAI.ReasoningTextContent	Contenido de texto de razonamiento.	No
encrypted_content	string (que acepta valores 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.InputItemType

Propiedad	Value
Type	string
Valores	message output_message file_search_call computer_call computer_call_output web_search_call function_call function_call_output reasoning compaction image_generation_call code_interpreter_call local_shell_call local_shell_call_output shell_call shell_call_output apply_patch_call apply_patch_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call custom_tool_call_output custom_tool_call item_reference

OpenAI.InputItemWebSearchToolCall

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	Predeterminado
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.InputMessage

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.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	OpenAI.InputMessageContentList	Una lista de uno o varios elementos de entrada para el modelo, que contiene contenido diferente types.	Sí
role	enum	Rol de la entrada del mensaje. Uno deuser, 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.InputMessageContentList

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	Predeterminado
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 deuser, 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:

• Entradas y salidas de texto
• Entradas de imagen
• Entradas de archivo
• Estado de conversación
• Invocación de funciones

Tipo: cadena o matriz de OpenAI.InputItem

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
• Invocación de funciones

OpenAI.InputTextContent

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í

OpenAI.InputTextContentParam

Entrada de texto al modelo.

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

OpenAI.Item

Elemento de contenido usado para generar una respuesta.

Discriminador para OpenAI.Item

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

Tipo de valor	Schema
memory_search_call	MemorySearchToolCallItemParam
message	OpenAI.InputMessage
output_message	OpenAI.ItemOutputMessage
file_search_call	OpenAI.ItemFileSearchToolCall
computer_call	OpenAI.ItemComputerToolCall
computer_call_output	OpenAI.ItemComputerCallOutputItemParam
web_search_call	OpenAI.ItemWebSearchToolCall
function_call	OpenAI.ItemFunctionToolCall
function_call_output	OpenAI.ItemFunctionCallOutputItemParam
reasoning	OpenAI.ItemReasoningItem
compaction	OpenAI.ItemCompactionSummaryItemParam
image_generation_call	OpenAI.ItemImageGenToolCall
code_interpreter_call	OpenAI.ItemCodeInterpreterToolCall
local_shell_call	OpenAI.ItemLocalShellToolCall
local_shell_call_output	OpenAI.ItemLocalShellToolCallOutput
shell_call	OpenAI.ItemFunctionShellCallItemParam
shell_call_output	OpenAI.ItemFunctionShellCallOutputItemParam
apply_patch_call	OpenAI.ItemApplyPatchToolCallItemParam
apply_patch_call_output	OpenAI.ItemApplyPatchToolCallOutputItemParam
mcp_list_tools	OpenAI.ItemMcpListTools
mcp_approval_request	OpenAI.ItemMcpApprovalRequest
mcp_approval_response	OpenAI.ItemMcpApprovalResponse
mcp_call	OpenAI.ItemMcpToolCall
custom_tool_call_output	OpenAI.ItemCustomToolCallOutput
custom_tool_call	OpenAI.ItemCustomToolCall

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ItemType		Sí

OpenAI.ItemApplyPatchToolCallItemParam

Una llamada a herramienta que representa una solicitud para crear, eliminar o actualizar archivos mediante revisiones de diferencias.

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. Restricciones: minLength: 1, maxLength: 64	Sí
id	string (que acepta valores NULL)		No
operation	OpenAI.ApplyPatchOperationParam	Una de las operaciones de create_file, delete_file o update_file proporcionadas a la herramienta de apply_patch.	Sí
└─ Tipo	OpenAI.ApplyPatchOperationParamType		Sí
status	OpenAI.ApplyPatchCallStatusParam	Valores de estado notificados para las llamadas a herramientas de apply_patch.	Sí
type	enum	Tipo del elemento. Siempre apply_patch_call. Valores posibles: apply_patch_call	Sí

OpenAI.ItemApplyPatchToolCallOutputItemParam

Salida transmitida por una llamada a la herramienta aplicar revisión.

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. Restricciones: minLength: 1, maxLength: 64	Sí
id	string (que acepta valores NULL)		No
output	string (que acepta valores NULL)		No
status	OpenAI.ApplyPatchCallOutputStatusParam	Valores de resultados notificados para apply_patch salidas de llamada de herramienta.	Sí
type	enum	Tipo del elemento. Siempre apply_patch_call_output. Valores posibles: apply_patch_call_output	Sí

OpenAI.ItemCodeInterpreterToolCall

Una llamada de herramienta para ejecutar código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	string (que acepta valores 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		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, interpretingy 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í

OpenAI.ItemCompactionSummaryItemParam

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
encrypted_content	string	Contenido cifrado del resumen de compactación. Restricciones: maxLength: 10485760	Sí
id	string (que acepta valores NULL)		No
type	enum	Tipo del elemento. Siempre compaction. Valores posibles: compaction	Sí

OpenAI.ItemComputerCallOutputItemParam

Salida de una llamada a una herramienta de equipo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acknowledged_safety_checks	matriz de OpenAI.ComputerCallSafetyCheckParam		No
call_id	string	Identificador de la llamada a la herramienta de equipo que generó la salida. Restricciones: minLength: 1, maxLength: 64	Sí
id	string (que acepta valores NULL)		No
output	OpenAI.ComputerScreenshotImage	Imagen de captura de pantalla del equipo que se usa con la herramienta de uso del equipo.	Sí
status	OpenAI.FunctionCallItemStatus (que acepta valores NULL)		No
type	enum	Tipo de la salida de llamada de la herramienta de equipo. Siempre computer_call_output. Valores posibles: computer_call_output	Sí

OpenAI.ItemComputerToolCall

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í

OpenAI.ItemCustomToolCall

Una llamada a una herramienta personalizada creada por el modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
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.ItemCustomToolCallOutput

La salida de una llamada de herramienta personalizada desde el código, que se devuelve al modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
call_id	string	El identificador de llamada, que se usa para asignar esta salida de llamada de herramienta personalizada a una llamada de herramienta personalizada.	Sí
id	string	Identificador único de la salida de llamada de herramienta personalizada en la plataforma OpenAI.	No
output	cadena o matriz de OpenAI.FunctionAndCustomToolCallOutput	Salida de la llamada a la herramienta personalizada generada por el código. Puede ser una cadena o una lista de contenido de salida.	Sí
type	enum	Tipo de la salida de la llamada a la herramienta personalizada. Siempre custom_tool_call_output. Valores posibles: custom_tool_call_output	Sí

OpenAI.ItemFileSearchToolCall

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	Predeterminado
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		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.ItemFunctionCallOutputItemParam

Salida de una llamada a la herramienta de función.

Nombre	Tipo	Description	Obligatorio	Predeterminado
call_id	string	Identificador único de la llamada a la herramienta de función generada por el modelo. Restricciones: minLength: 1, maxLength: 64	Sí
id	string (que acepta valores NULL)		No
output	cadena o matriz de OpenAI.InputTextContentParam o OpenAI.InputImageContentParamAutoParam o OpenAI.InputFileContentParam	Salida de texto, imagen o archivo de la llamada a la herramienta de función.	Sí
status	OpenAI.FunctionCallItemStatus (que acepta valores NULL)		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.ItemFunctionShellCallItemParam

Herramienta que representa una solicitud para ejecutar uno o varios comandos de shell.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acción	OpenAI.FunctionShellActionParam	Comandos y límites que describen cómo ejecutar la llamada a la herramienta de shell.	Sí
Comandos └	matriz de cadenas	Comandos de shell ordenados para que se ejecute el entorno de ejecución.	Sí
└" max_output_length	OpenAI.integer (que acepta valores NULL)		No
└" timeout_ms	OpenAI.integer (que acepta valores NULL)		No
call_id	string	Identificador único de la llamada a la herramienta de shell generada por el modelo. Restricciones: minLength: 1, maxLength: 64	Sí
id	string (que acepta valores NULL)		No
status	OpenAI.FunctionShellCallItemStatus (que acepta valores NULL)	Valores de estado notificados para las llamadas a herramientas de shell.	No
type	enum	Tipo del elemento. Siempre shell_call. Valores posibles: shell_call	Sí

OpenAI.ItemFunctionShellCallOutputItemParam

Los elementos de salida transmitidos emitidos por una llamada a la herramienta de shell.

Nombre	Tipo	Description	Obligatorio	Predeterminado
call_id	string	Identificador único de la llamada a la herramienta de shell generada por el modelo. Restricciones: minLength: 1, maxLength: 64	Sí
id	string (que acepta valores NULL)		No
max_output_length	OpenAI.integer (que acepta valores NULL)		No
output	matriz de OpenAI.FunctionShellCallOutputContentParam	Fragmentos capturados de salida stdout y stderr, junto con sus resultados asociados.	Sí
type	enum	Tipo del elemento. Siempre shell_call_output. Valores posibles: shell_call_output	Sí

OpenAI.ItemFunctionToolCall

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	Predeterminado
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.ItemImageGenToolCall

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	string	Identificador único de la llamada de generación de imágenes.	Sí
result	string (que acepta valores 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.ItemLocalShellToolCall

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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.ItemLocalShellToolCallOutput

Salida de una llamada a la herramienta de shell local.

Nombre	Tipo	Description	Obligatorio	Predeterminado
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	enum	Valores posibles: in_progress, completed, incomplete	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.ItemMcpApprovalRequest

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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.ItemMcpApprovalResponse

Respuesta a una solicitud de aprobación de MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
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 (que acepta valores NULL)		No
razón	string (que acepta valores NULL)		No
type	enum	Tipo del elemento. Siempre mcp_approval_response. Valores posibles: mcp_approval_response	Sí

OpenAI.ItemMcpListTools

Lista de herramientas disponibles en un servidor MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
error	string (que acepta valores 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.ItemMcpToolCall

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
approval_request_id	string (que acepta valores NULL)		No
argumentos	string	Cadena JSON de los argumentos pasados a la herramienta.	Sí
error	string (que acepta valores 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 (que acepta valores 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.ItemOutputMessage

Mensaje de salida del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
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.ItemReasoningItem

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	Predeterminado
contenido	matriz de OpenAI.ReasoningTextContent	Contenido de texto de razonamiento.	No
encrypted_content	string (que acepta valores 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.ItemReferenceParam

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í

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

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í

OpenAI.ItemResourceApplyPatchToolCallOutput

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 (que acepta valores NULL)		No
status	OpenAI.ApplyPatchCallOutputStatus		Sí
type	enum	Tipo del elemento. Siempre apply_patch_call_output. Valores posibles: apply_patch_call_output	Sí

OpenAI.ItemResourceCodeInterpreterToolCall

Una llamada de herramienta para ejecutar código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	string (que acepta valores 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		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, interpretingy 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í

OpenAI.ItemResourceComputerToolCall

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í

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í

OpenAI.ItemResourceFileSearchToolCall

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

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	OpenAI.integer (que acepta valores NULL)		Sí
└" timeout_ms	OpenAI.integer (que acepta valores 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í

OpenAI.ItemResourceFunctionShellCallOutput

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	OpenAI.integer (que acepta valores 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í

OpenAI.ItemResourceFunctionToolCallOutputResource

Nombre	Tipo	Description	Obligatorio	Predeterminado
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	Predeterminado
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

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	string	Identificador único de la llamada de generación de imágenes.	Sí
result	string (que acepta valores 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

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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 de una llamada a la herramienta de shell local.

Nombre	Tipo	Description	Obligatorio	Predeterminado
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	enum	Valores posibles: in_progress, completed, incomplete	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 humana de una invocación de herramienta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
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 a una solicitud de aprobación de MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
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 (que acepta valores NULL)		No
type	enum	Tipo del elemento. Siempre mcp_approval_response. Valores posibles: mcp_approval_response	Sí

OpenAI.ItemResourceMcpListTools

Lista de herramientas disponibles en un servidor MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
error	string (que acepta valores 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

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
approval_request_id	string (que acepta valores NULL)		No
argumentos	string	Cadena JSON de los argumentos pasados a la herramienta.	Sí
error	string (que acepta valores 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 (que acepta valores 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 del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
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 structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.ItemResourceWebSearchToolCall

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	Predeterminado
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.ItemType

Propiedad	Value
Type	string
Valores	message output_message file_search_call computer_call computer_call_output web_search_call function_call function_call_output reasoning compaction image_generation_call code_interpreter_call local_shell_call local_shell_call_output shell_call shell_call_output apply_patch_call apply_patch_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call custom_tool_call_output custom_tool_call structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.ItemWebSearchToolCall

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

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í

OpenAI.ListFineTuningJobCheckpointsResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
data	matriz de OpenAI.FineTuningJobCheckpoint		Sí
first_id	string (que acepta valores NULL)		No
has_more	boolean		Sí
last_id	string (que acepta valores NULL)		No
object	enum	Valores posibles: list	Sí

OpenAI.ListFineTuningJobEventsResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
data	matriz de OpenAI.FineTuningJobEvent		Sí
has_more	boolean		Sí
object	enum	Valores posibles: list	Sí

OpenAI.ListPaginatedFineTuningJobsResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
data	matriz de OpenAI.FineTuningJob		Sí
has_more	boolean		Sí
object	enum	Valores posibles: list	Sí

OpenAI.LocalShellCallStatus

Propiedad	Value
Type	string
Valores	in_progress completed incomplete

OpenAI.LocalShellExecAction

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	OpenAI.integer (que acepta valores NULL)		No
type	enum	Tipo de la acción de shell local. Siempre exec. Valores posibles: exec	Sí
user	string (que acepta valores NULL)		No
working_directory	string (que acepta valores NULL)		No

OpenAI.LocalShellToolParam

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í

OpenAI.LogProb

Probabilidad de registro de un token.

Nombre	Tipo	Description	Obligatorio	Predeterminado
bytes	matriz de OpenAI.integer		Sí
logprob	OpenAI.numeric		Sí
token	string		Sí
top_logprobs	matriz de OpenAI.TopLogProb		Sí

OpenAI.MCPListToolsTool

Una herramienta disponible en un servidor MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
annotations	OpenAI.MCPListToolsToolAnnotations (que acepta valores NULL)		No
description	string (que acepta valores NULL)		No
input_schema	OpenAI.MCPListToolsToolInputSchema		Sí
nombre	string	Nombre de la herramienta.	Sí

OpenAI.MCPListToolsToolAnnotations

Tipo: objeto

OpenAI.MCPListToolsToolInputSchema

Tipo: objeto

OpenAI.MCPTool

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	Predeterminado
herramientas_permitidas	matriz de cadena o OpenAI.MCPToolFilter		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	objeto (que acepta valores NULL)		No
project_connection_id	string	Identificador de conexión del project para el servidor MCP. La conexión almacena la autenticación y otros detalles de conexión necesarios para conectarse al servidor MCP.	No
requerir_aprobación	object (consulte los modelos válidos a continuación)		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	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

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

Elemento de contenido que compone un elemento de entrada o salida.

Discriminador para OpenAI.MessageContent

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

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.MessageContentType		Sí

OpenAI.MessageContentInputFileContent

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 (que acepta valores NULL)		No
file_url	string	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í

OpenAI.MessageContentInputImageContent

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 (que acepta valores NULL)		No
image_url	string		No
type	enum	Tipo del elemento de entrada. Siempre input_image. Valores posibles: input_image	Sí

OpenAI.MessageContentInputTextContent

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í

OpenAI.MessageContentOutputTextContent

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í

OpenAI.MessageContentReasoningTextContent

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í

OpenAI.MessageContentRefusalContent

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í

OpenAI.MessageContentType

Propiedad	Value
Type	string
Valores	input_text output_text text summary_text reasoning_text refusal input_image computer_screenshot input_file

OpenAI.MessageRole

Propiedad	Value
Type	string
Valores	unknown user assistant system critic discriminator developer tool

OpenAI.MessageStatus

Propiedad	Value
Type	string
Valores	in_progress completed incomplete

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

Id. de modelo usado para generar la respuesta, como gpt-5 o o3. OpenAI ofrece una amplia gama de modelos con diferentes funcionalidades, características de rendimiento y puntos de precio. Consulte la guía del modelo para examinar y comparar los modelos disponibles.

Tipo: OpenAI.ModelIdsResponses o string

Id. de modelo usado para generar la respuesta, como gpt-5 o o3. OpenAI ofrece una amplia gama de modelos con diferentes funcionalidades, características de rendimiento y puntos de precio. Consulte la guía del modelo para examinar y comparar los modelos disponibles.

OpenAI.ModelIdsResponses

Propiedad	Value
Type	string
Valores	o1-pro o1-pro-2025-03-19 o3-pro o3-pro-2025-06-10 o3-deep-research o3-deep-research-2025-06-26 o4-mini-deep-research o4-mini-deep-research-2025-06-26 computer-use-preview computer-use-preview-2025-03-11 gpt-5-codex gpt-5-pro gpt-5-pro-2025-10-06 gpt-5.1-codex-max

OpenAI.ModelIdsShared

Tipo: string o OpenAI.ChatModel

OpenAI.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í
x	OpenAI.integer		Sí
y	OpenAI.integer		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
reasoning_text	OpenAI.OutputContentReasoningTextContent

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.OutputContentType		Sí

OpenAI.OutputContentOutputTextContent

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í

OpenAI.OutputContentReasoningTextContent

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í

OpenAI.OutputContentRefusalContent

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í

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
structured_outputs	StructuredOutputsOutputItem
workflow_action	WorkflowActionOutputItem
oauth_consent_request	OAuthConsentRequestOutputItem
memory_search_call	MemorySearchToolCallItemResource
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
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
response_id	string	Respuesta en la que se crea el elemento.	No
type	OpenAI.OutputItemType		Sí

OpenAI.OutputItemApplyPatchToolCall

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
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
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í
response_id	string	Respuesta en la que se crea el elemento.	No
status	OpenAI.ApplyPatchCallStatus		Sí
type	enum	Tipo del elemento. Siempre apply_patch_call. Valores posibles: apply_patch_call	Sí

OpenAI.OutputItemApplyPatchToolCallOutput

Salida emitida por una llamada a la herramienta apply patch.

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
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 (que acepta valores NULL)		No
response_id	string	Respuesta en la que se crea el elemento.	No
status	OpenAI.ApplyPatchCallOutputStatus		Sí
type	enum	Tipo del elemento. Siempre apply_patch_call_output. Valores posibles: apply_patch_call_output	Sí

OpenAI.OutputItemCodeInterpreterToolCall

Una llamada de herramienta para ejecutar código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
código	string (que acepta valores 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		Sí
response_id	string	Respuesta en la que se crea el elemento.	No
status	enum	Estado de la llamada a la herramienta de intérprete de código. Los valores válidos son in_progress, completed, incomplete, interpretingy 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í

OpenAI.OutputItemCompactionBody

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
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í
response_id	string	Respuesta en la que se crea el elemento.	No
type	enum	Tipo del elemento. Siempre compaction. Valores posibles: compaction	Sí

OpenAI.OutputItemComputerToolCall

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í
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
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í
response_id	string	Respuesta en la que se crea el elemento.	No
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í

OpenAI.OutputItemCustomToolCall

Una llamada a una herramienta personalizada creada por el modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
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í
response_id	string	Respuesta en la que se crea el elemento.	No
type	enum	Tipo de la llamada a herramienta personalizada. Siempre custom_tool_call. Valores posibles: custom_tool_call	Sí

OpenAI.OutputItemFileSearchToolCall

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	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
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í
response_id	string	Respuesta en la que se crea el elemento.	No
results	matriz de OpenAI.FileSearchToolCallResults		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

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	OpenAI.integer (que acepta valores NULL)		Sí
└" timeout_ms	OpenAI.integer (que acepta valores NULL)		Sí
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
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í
response_id	string	Respuesta en la que se crea el elemento.	No
status	OpenAI.LocalShellCallStatus		Sí
type	enum	Tipo del elemento. Siempre shell_call. Valores posibles: shell_call	Sí

OpenAI.OutputItemFunctionShellCallOutput

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
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	OpenAI.integer (que acepta valores NULL)		Sí
output	matriz de OpenAI.FunctionShellCallOutputContent	Matriz de contenido de salida de la llamada de shell	Sí
response_id	string	Respuesta en la que se crea el elemento.	No
type	enum	Tipo de la salida de la llamada de shell. Siempre shell_call_output. Valores posibles: shell_call_output	Sí

OpenAI.OutputItemFunctionToolCall

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	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
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í
response_id	string	Respuesta en la que se crea el elemento.	No
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

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
id	string	Identificador único de la llamada de generación de imágenes.	Sí
response_id	string	Respuesta en la que se crea el elemento.	No
result	string (que acepta valores 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

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
acción	OpenAI.LocalShellExecAction	Ejecute un comando de shell en el servidor.	Sí
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
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í
response_id	string	Respuesta en la que se crea el elemento.	No
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 humana de una invocación de herramienta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
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í
response_id	string	Respuesta en la que se crea el elemento.	No
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

Lista de herramientas disponibles en un servidor MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
error	string (que acepta valores NULL)		No
id	string	Identificador único de la lista.	Sí
response_id	string	Respuesta en la que se crea el elemento.	No
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

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
approval_request_id	string (que acepta valores NULL)		No
argumentos	string	Cadena JSON de los argumentos pasados a la herramienta.	Sí
error	string (que acepta valores 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 (que acepta valores NULL)		No
response_id	string	Respuesta en la que se crea el elemento.	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 del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
contenido	matriz de OpenAI.OutputMessageContent	Contenido del mensaje de salida.	Sí
id	string	Identificador único del mensaje de salida.	Sí
response_id	string	Respuesta en la que se crea el elemento.	No
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

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	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
contenido	matriz de OpenAI.ReasoningTextContent	Contenido de texto de razonamiento.	No
encrypted_content	string (que acepta valores NULL)		No
id	string	Identificador único del contenido de razonamiento.	Sí
response_id	string	Respuesta en la que se crea el elemento.	No
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 structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.OutputItemWebSearchToolCall

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	Predeterminado
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í
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
id	string	Identificador único de la llamada a la herramienta de búsqueda web.	Sí
response_id	string	Respuesta en la que se crea el elemento.	No
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

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í

OpenAI.OutputMessageContentRefusalContent

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í

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	Predeterminado
id	string	Identificador único de la plantilla de solicitud que se va a usar.	Sí
variables	OpenAI.ResponsePromptVariables (que acepta valores NULL)	Asignación opcional de valores que se sustituyen por las variables de la mensaje. Los valores de sustitución pueden ser cadenas u otros tipos de entrada de respuesta como imágenes o archivos.	No
version	string (que acepta valores NULL)		No

OpenAI.RankerVersionType

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

OpenAI.RankingOptions

Nombre	Tipo	Description	Obligatorio	Predeterminado
hybrid_search	OpenAI.HybridSearchOptions		No
└" embedding_weight	OpenAI.numeric	El peso de la incrustación en la fusión de clasificación recíproca.	Sí
└" text_weight	OpenAI.numeric	Peso del texto en la fusión de clasificación recíproca.	Sí
clasificador	OpenAI.RankerVersionType		No
umbral de puntuación	OpenAI.numeric		No

OpenAI.Reasoning

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
effort	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de 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 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, mediumy 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-maxde .	No
generate_summary	enum	Valores posibles: auto, concise, detailed	No
summary	enum	Valores posibles: auto, concise, detailed	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
Type	string
Nullable	Sí
Valores	none minimal low medium high xhigh

OpenAI.ReasoningTextContent

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í

OpenAI.Response

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_reference	AgentReference (que acepta valores NULL)		Sí
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
fondo	booleano (que acepta valores NULL)		No
completado_en	integer		No
conversación	OpenAI.ConversationReference (que acepta valores NULL)	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.	No
└─ id.	string	Identificador único de la conversación a la que estaba asociada esta respuesta.	Sí
fecha_de_creación	integer	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
error	OpenAI.ResponseError (que acepta valores NULL)	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	Sí
└─ código	OpenAI.ResponseErrorCode	Código de error de la respuesta.	Sí
└─ Mensaje	string	Descripción legible del error.	Sí
id	string	Identificador único de esta respuesta.	Sí
incomplete_details	OpenAI.ResponseIncompleteDetails (que acepta valores NULL)		Sí
└─ Motivo	enum	Valores posibles: max_output_tokens, content_filter	No
instructions	cadena o matriz de OpenAI.InputItem		Sí
max_output_tokens	OpenAI.integer (que acepta valores NULL)		No
max_tool_calls	OpenAI.integer (que acepta valores NULL)		No
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
model	string	Implementación del modelo que se va a usar para la creación de esta respuesta.	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 (que acepta valores NULL)		No
parallel_tool_calls	boolean	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	Sí	True
previous_response_id	string (que acepta valores 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	enum	Valores posibles: in-memory, 24h	No
reasoning	OpenAI.Reasoning (que acepta valores NULL)	Modelos de serie gpt-5 y o solo Opciones de configuración para modelos de razonamiento.	No
└─ esfuerzo	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de 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 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, mediumy 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-maxde .	No
└─ generar_resumen	enum	Valores posibles: auto, concise, detailed	No
└─ resumen	enum	Valores posibles: auto, concise, detailed	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
nivel de servicio	OpenAI.ServiceTier	Especifica el tipo de procesamiento utilizado para atender la solicitud. - Si se establece en "auto", la solicitud se procesará con el nivel de servicio configurado en la configuración de Project. A menos que se configure lo contrario, el Project usará "default". - Si se establece en "valor predeterminado", la solicitud se procesará con los precios estándar y el rendimiento del modelo seleccionado. - Si se establece en "flex" o "priority", la solicitud se procesará con el nivel de servicio correspondiente. - Cuando no se establece, el comportamiento predeterminado es "auto". Cuando se establece el service_tier parámetro , el cuerpo de la respuesta incluirá el service_tier valor en función del modo de procesamiento usado realmente para atender la solicitud. Este valor de respuesta puede ser diferente del valor establecido en el parámetro .	No
status	enum	Estado de la generación de respuesta. Uno de completed, , failed in_progress, cancelled, queuedo incomplete. Valores posibles: completed, failed, in_progress, cancelled, , queued, incomplete	No
temperatura	OpenAI.numeric (que acepta valores NULL)		No	1
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.ToolChoiceOptions o OpenAI.ToolChoiceParam		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	OpenAI.integer (que acepta valores NULL)		No
top_p	OpenAI.numeric (que acepta valores NULL)		No	1
truncation	enum	Valores posibles: auto, disabled	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	Predeterminado
delta	string	Fragmento de bytes de audio de respuesta codificados en Base64.	Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.audio.delta. Valores posibles: response.audio.delta	Sí

OpenAI.ResponseAudioDoneEvent

Se genera cuando se completa la respuesta de audio.

Nombre	Tipo	Description	Obligatorio	Predeterminado
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.audio.done. Valores posibles: response.audio.done	Sí

OpenAI.ResponseAudioTranscriptDeltaEvent

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
delta	string	Transcripción parcial de la respuesta de audio.	Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.audio.transcript.delta. Valores posibles: response.audio.transcript.delta	Sí

OpenAI.ResponseAudioTranscriptDoneEvent

Se genera cuando se completa la transcripción de audio completa.

Nombre	Tipo	Description	Obligatorio	Predeterminado
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.audio.transcript.done. Valores posibles: response.audio.transcript.done	Sí

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.code_interpreter_call_code.delta. Valores posibles: response.code_interpreter_call_code.delta	Sí

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	string	Resultado del fragmento de código final por 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	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.code_interpreter_call_code.done. Valores posibles: response.code_interpreter_call_code.done	Sí

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Se genera cuando se completa la llamada del intérprete de código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	Identificador único del elemento de llamada de la herramienta de intérprete de código.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.code_interpreter_call.completed. Valores posibles: response.code_interpreter_call.completed	Sí

OpenAI.ResponseCodeInterpreterCallInProgressEvent

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	Identificador único del elemento de llamada de la herramienta de intérprete de código.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		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	Predeterminado
item_id	string	Identificador único del elemento de llamada de la herramienta de intérprete de código.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.code_interpreter_call.interpreting. Valores posibles: response.code_interpreter_call.interpreting	Sí

OpenAI.ResponseCompletedEvent

Se genera cuando se completa la respuesta del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
respuesta	OpenAI.Response		Sí
└" agent_reference	AgentReference (que acepta valores NULL)	Agente usado para esta respuesta	Sí
└─ fondo	booleano (que acepta valores NULL)		No
└" completed_at	entero (que acepta valores NULL)		No
Conversación └	OpenAI.ConversationReference (que acepta valores NULL)	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.	No
└─ created_at	integer	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
└─ Error	OpenAI.ResponseError (que acepta valores NULL)	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	Sí
└─ id.	string	Identificador único de esta respuesta.	Sí
└─ detalles_incompletos	OpenAI.ResponseIncompleteDetails (que acepta valores NULL)		Sí
└─ Instrucciones	cadena o matriz de OpenAI.InputItem (que acepta valores NULL)		Sí
└─ max_output_tokens (máximo de tokens de salida)	OpenAI.integer (que acepta valores NULL)		No
└─ «max_tool_calls»	OpenAI.integer (que acepta valores NULL)		No
Metadatos └	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
└─ modelo	string	Implementación del modelo que se va a usar para la creación de esta respuesta.	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 (que acepta valores 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 (que acepta valores 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	enum	Valores posibles: in-memory, 24h	No
└─ razonamiento	OpenAI.Reasoning (que acepta valores NULL)	Modelos de serie gpt-5 y o solo Opciones de configuración para modelos de razonamiento.	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
└" service_tier	OpenAI.ServiceTier	Especifica el tipo de procesamiento utilizado para atender la solicitud. - Si se establece en "auto", la solicitud se procesará con el nivel de servicio configurado en la configuración de Project. A menos que se configure lo contrario, el Project usará "default". - Si se establece en "valor predeterminado", la solicitud se procesará con los precios estándar y el rendimiento del modelo seleccionado. - Si se establece en "flex" o "priority", la solicitud se procesará con el nivel de servicio correspondiente. - Cuando no se establece, el comportamiento predeterminado es "auto". Cuando se establece el service_tier parámetro , el cuerpo de la respuesta incluirá el service_tier valor en función del modo de procesamiento usado realmente para atender la solicitud. Este valor de respuesta puede ser diferente del valor establecido en el parámetro .	No
└─ estado	enum	Estado de la generación de respuesta. Uno de completed, , failed in_progress, cancelled, queuedo incomplete. Valores posibles: completed, failed, in_progress, cancelled, , queued, incomplete	No
└─ Temperatura	OpenAI.numeric (que acepta valores 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.ToolChoiceOptions o OpenAI.ToolChoiceParam		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	OpenAI.integer (que acepta valores NULL)		No
└─ top_p	OpenAI.numeric (que acepta valores NULL)		No	1
└─ truncamiento	enum	Valores posibles: auto, disabled	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
└─ 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	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.completed. Valores posibles: response.completed	Sí

OpenAI.ResponseContentPartAddedEvent

Se genera cuando se agrega una nueva parte de contenido.

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

OpenAI.ResponseContentPartDoneEvent

Se emite cuando se finaliza una parte de contenido.

Nombre	Tipo	Description	Obligatorio	Predeterminado
content_index	OpenAI.integer		Sí
item_id	string	Identificador del elemento de salida al que se agregó la parte de contenido.	Sí
output_index	OpenAI.integer		Sí
part	OpenAI.OutputContent		Sí
└─ Tipo	OpenAI.OutputContentType		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.content_part.done. Valores posibles: response.content_part.done	Sí

OpenAI.ResponseCreatedEvent

Evento que se genera cuando se crea una respuesta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
respuesta	OpenAI.Response		Sí
└" agent_reference	AgentReference (que acepta valores NULL)	Agente usado para esta respuesta	Sí
└─ fondo	booleano (que acepta valores NULL)		No
└" completed_at	entero (que acepta valores NULL)		No
Conversación └	OpenAI.ConversationReference (que acepta valores NULL)	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.	No
└─ created_at	integer	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
└─ Error	OpenAI.ResponseError (que acepta valores NULL)	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	Sí
└─ id.	string	Identificador único de esta respuesta.	Sí
└─ detalles_incompletos	OpenAI.ResponseIncompleteDetails (que acepta valores NULL)		Sí
└─ Instrucciones	cadena o matriz de OpenAI.InputItem (que acepta valores NULL)		Sí
└─ max_output_tokens (máximo de tokens de salida)	OpenAI.integer (que acepta valores NULL)		No
└─ «max_tool_calls»	OpenAI.integer (que acepta valores NULL)		No
Metadatos └	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
└─ modelo	string	Implementación del modelo que se va a usar para la creación de esta respuesta.	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 (que acepta valores 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 (que acepta valores 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	enum	Valores posibles: in-memory, 24h	No
└─ razonamiento	OpenAI.Reasoning (que acepta valores NULL)	Modelos de serie gpt-5 y o solo Opciones de configuración para modelos de razonamiento.	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
└" service_tier	OpenAI.ServiceTier	Especifica el tipo de procesamiento utilizado para atender la solicitud. - Si se establece en "auto", la solicitud se procesará con el nivel de servicio configurado en la configuración de Project. A menos que se configure lo contrario, el Project usará "default". - Si se establece en "valor predeterminado", la solicitud se procesará con los precios estándar y el rendimiento del modelo seleccionado. - Si se establece en "flex" o "priority", la solicitud se procesará con el nivel de servicio correspondiente. - Cuando no se establece, el comportamiento predeterminado es "auto". Cuando se establece el service_tier parámetro , el cuerpo de la respuesta incluirá el service_tier valor en función del modo de procesamiento usado realmente para atender la solicitud. Este valor de respuesta puede ser diferente del valor establecido en el parámetro .	No
└─ estado	enum	Estado de la generación de respuesta. Uno de completed, , failed in_progress, cancelled, queuedo incomplete. Valores posibles: completed, failed, in_progress, cancelled, , queued, incomplete	No
└─ Temperatura	OpenAI.numeric (que acepta valores 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.ToolChoiceOptions o OpenAI.ToolChoiceParam		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	OpenAI.integer (que acepta valores NULL)		No
└─ top_p	OpenAI.numeric (que acepta valores NULL)		No	1
└─ truncamiento	enum	Valores posibles: auto, disabled	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
└─ 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	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.created. Valores posibles: response.created	Sí

OpenAI.ResponseCustomToolCallInputDeltaEvent

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	Identificador del tipo de evento. Valores posibles: response.custom_tool_call_input.delta	Sí

OpenAI.ResponseCustomToolCallInputDoneEvent

Evento que indica que la entrada de una llamada a herramienta personalizada está completa.

Nombre	Tipo	Description	Obligatorio	Predeterminado
input	string	Los datos de entrada completos para la llamada a la herramienta personalizada.	Sí
item_id	string	Identificador único del elemento de API asociado a este evento.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	Identificador del tipo de evento. Valores posibles: response.custom_tool_call_input.done	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	Predeterminado
código	string (que acepta valores NULL)		Sí
message	string	El mensaje de error.	Sí
param	string (que acepta valores NULL)		Sí
sequence_number	OpenAI.integer		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í
└" agent_reference	AgentReference (que acepta valores NULL)	Agente usado para esta respuesta	Sí
└─ fondo	booleano (que acepta valores NULL)		No
└" completed_at	entero (que acepta valores NULL)		No
Conversación └	OpenAI.ConversationReference (que acepta valores NULL)	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.	No
└─ created_at	integer	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
└─ Error	OpenAI.ResponseError (que acepta valores NULL)	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	Sí
└─ id.	string	Identificador único de esta respuesta.	Sí
└─ detalles_incompletos	OpenAI.ResponseIncompleteDetails (que acepta valores NULL)		Sí
└─ Instrucciones	cadena o matriz de OpenAI.InputItem (que acepta valores NULL)		Sí
└─ max_output_tokens (máximo de tokens de salida)	OpenAI.integer (que acepta valores NULL)		No
└─ «max_tool_calls»	OpenAI.integer (que acepta valores NULL)		No
Metadatos └	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
└─ modelo	string	Implementación del modelo que se va a usar para la creación de esta respuesta.	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 (que acepta valores 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 (que acepta valores 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	enum	Valores posibles: in-memory, 24h	No
└─ razonamiento	OpenAI.Reasoning (que acepta valores NULL)	Modelos de serie gpt-5 y o solo Opciones de configuración para modelos de razonamiento.	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
└" service_tier	OpenAI.ServiceTier	Especifica el tipo de procesamiento utilizado para atender la solicitud. - Si se establece en "auto", la solicitud se procesará con el nivel de servicio configurado en la configuración de Project. A menos que se configure lo contrario, el Project usará "default". - Si se establece en "valor predeterminado", la solicitud se procesará con los precios estándar y el rendimiento del modelo seleccionado. - Si se establece en "flex" o "priority", la solicitud se procesará con el nivel de servicio correspondiente. - Cuando no se establece, el comportamiento predeterminado es "auto". Cuando se establece el service_tier parámetro , el cuerpo de la respuesta incluirá el service_tier valor en función del modo de procesamiento usado realmente para atender la solicitud. Este valor de respuesta puede ser diferente del valor establecido en el parámetro .	No
└─ estado	enum	Estado de la generación de respuesta. Uno de completed, , failed in_progress, cancelled, queuedo incomplete. Valores posibles: completed, failed, in_progress, cancelled, , queued, incomplete	No
└─ Temperatura	OpenAI.numeric (que acepta valores 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.ToolChoiceOptions o OpenAI.ToolChoiceParam		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	OpenAI.integer (que acepta valores NULL)		No
└─ top_p	OpenAI.numeric (que acepta valores NULL)		No	1
└─ truncamiento	enum	Valores posibles: auto, disabled	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
└─ 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	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.failed. Valores posibles: response.failed	Sí

OpenAI.ResponseFileSearchCallCompletedEvent

Se genera cuando se completa una llamada de búsqueda de archivos (resultados encontrados).

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	Identificador del elemento de salida con el que se inicia la llamada de búsqueda de archivos.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.file_search_call.completed. Valores posibles: response.file_search_call.completed	Sí

OpenAI.ResponseFileSearchCallInProgressEvent

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	Identificador del elemento de salida con el que se inicia la llamada de búsqueda de archivos.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		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	Predeterminado
item_id	string	Identificador del elemento de salida con el que se inicia la llamada de búsqueda de archivos.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.file_search_call.searching. Valores posibles: response.file_search_call.searching	Sí

OpenAI.ResponseFormatJsonObject

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

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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 (que acepta valores 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	Predeterminado
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 (que acepta valores NULL)		No

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

Tipo: objeto

OpenAI.ResponseFormatText

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

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.function_call_arguments.delta. Valores posibles: response.function_call_arguments.delta	Sí

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Se genera cuando se finalizan los argumentos de llamada de función.

Nombre	Tipo	Description	Obligatorio	Predeterminado
argumentos	string	Argumentos de llamada de función.	Sí
item_id	string	Identificador del elemento.	Sí
nombre	string	El nombre de la función que se llamó.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	Valores posibles: response.function_call_arguments.done	Sí

OpenAI.ResponseImageGenCallCompletedEvent

Se genera cuando se ha completado una llamada a la herramienta de generación de imágenes y la imagen final está disponible.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	Identificador único del elemento de generación de imágenes que se está procesando.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre 'response.image_generation_call.completed'. Valores posibles: response.image_generation_call.completed	Sí

OpenAI.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	Predeterminado
item_id	string	Identificador único del elemento de generación de imágenes que se está procesando.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre "response.image_generation_call.generating". Valores posibles: response.image_generation_call.generating	Sí

OpenAI.ResponseImageGenCallInProgressEvent

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	Identificador único del elemento de generación de imágenes que se está procesando.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		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

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	Identificador único del elemento de generación de imágenes que se está procesando.	Sí
output_index	OpenAI.integer		Sí
partial_image_b64	string	Datos de imagen parcial codificados en Base64, adecuados para la representación como una imagen.	Sí
partial_image_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		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í
└" agent_reference	AgentReference (que acepta valores NULL)	Agente usado para esta respuesta	Sí
└─ fondo	booleano (que acepta valores NULL)		No
└" completed_at	entero (que acepta valores NULL)		No
Conversación └	OpenAI.ConversationReference (que acepta valores NULL)	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.	No
└─ created_at	integer	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
└─ Error	OpenAI.ResponseError (que acepta valores NULL)	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	Sí
└─ id.	string	Identificador único de esta respuesta.	Sí
└─ detalles_incompletos	OpenAI.ResponseIncompleteDetails (que acepta valores NULL)		Sí
└─ Instrucciones	cadena o matriz de OpenAI.InputItem (que acepta valores NULL)		Sí
└─ max_output_tokens (máximo de tokens de salida)	OpenAI.integer (que acepta valores NULL)		No
└─ «max_tool_calls»	OpenAI.integer (que acepta valores NULL)		No
Metadatos └	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
└─ modelo	string	Implementación del modelo que se va a usar para la creación de esta respuesta.	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 (que acepta valores 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 (que acepta valores 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	enum	Valores posibles: in-memory, 24h	No
└─ razonamiento	OpenAI.Reasoning (que acepta valores NULL)	Modelos de serie gpt-5 y o solo Opciones de configuración para modelos de razonamiento.	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
└" service_tier	OpenAI.ServiceTier	Especifica el tipo de procesamiento utilizado para atender la solicitud. - Si se establece en "auto", la solicitud se procesará con el nivel de servicio configurado en la configuración de Project. A menos que se configure lo contrario, el Project usará "default". - Si se establece en "valor predeterminado", la solicitud se procesará con los precios estándar y el rendimiento del modelo seleccionado. - Si se establece en "flex" o "priority", la solicitud se procesará con el nivel de servicio correspondiente. - Cuando no se establece, el comportamiento predeterminado es "auto". Cuando se establece el service_tier parámetro , el cuerpo de la respuesta incluirá el service_tier valor en función del modo de procesamiento usado realmente para atender la solicitud. Este valor de respuesta puede ser diferente del valor establecido en el parámetro .	No
└─ estado	enum	Estado de la generación de respuesta. Uno de completed, , failed in_progress, cancelled, queuedo incomplete. Valores posibles: completed, failed, in_progress, cancelled, , queued, incomplete	No
└─ Temperatura	OpenAI.numeric (que acepta valores 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.ToolChoiceOptions o OpenAI.ToolChoiceParam		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	OpenAI.integer (que acepta valores NULL)		No
└─ top_p	OpenAI.numeric (que acepta valores NULL)		No	1
└─ truncamiento	enum	Valores posibles: auto, disabled	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
└─ 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	OpenAI.integer		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í
└" agent_reference	AgentReference (que acepta valores NULL)	Agente usado para esta respuesta	Sí
└─ fondo	booleano (que acepta valores NULL)		No
└" completed_at	entero (que acepta valores NULL)		No
Conversación └	OpenAI.ConversationReference (que acepta valores NULL)	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.	No
└─ created_at	integer	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
└─ Error	OpenAI.ResponseError (que acepta valores NULL)	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	Sí
└─ id.	string	Identificador único de esta respuesta.	Sí
└─ detalles_incompletos	OpenAI.ResponseIncompleteDetails (que acepta valores NULL)		Sí
└─ Instrucciones	cadena o matriz de OpenAI.InputItem (que acepta valores NULL)		Sí
└─ max_output_tokens (máximo de tokens de salida)	OpenAI.integer (que acepta valores NULL)		No
└─ «max_tool_calls»	OpenAI.integer (que acepta valores NULL)		No
Metadatos └	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
└─ modelo	string	Implementación del modelo que se va a usar para la creación de esta respuesta.	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 (que acepta valores 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 (que acepta valores 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	enum	Valores posibles: in-memory, 24h	No
└─ razonamiento	OpenAI.Reasoning (que acepta valores NULL)	Modelos de serie gpt-5 y o solo Opciones de configuración para modelos de razonamiento.	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
└" service_tier	OpenAI.ServiceTier	Especifica el tipo de procesamiento utilizado para atender la solicitud. - Si se establece en "auto", la solicitud se procesará con el nivel de servicio configurado en la configuración de Project. A menos que se configure lo contrario, el Project usará "default". - Si se establece en "valor predeterminado", la solicitud se procesará con los precios estándar y el rendimiento del modelo seleccionado. - Si se establece en "flex" o "priority", la solicitud se procesará con el nivel de servicio correspondiente. - Cuando no se establece, el comportamiento predeterminado es "auto". Cuando se establece el service_tier parámetro , el cuerpo de la respuesta incluirá el service_tier valor en función del modo de procesamiento usado realmente para atender la solicitud. Este valor de respuesta puede ser diferente del valor establecido en el parámetro .	No
└─ estado	enum	Estado de la generación de respuesta. Uno de completed, , failed in_progress, cancelled, queuedo incomplete. Valores posibles: completed, failed, in_progress, cancelled, , queued, incomplete	No
└─ Temperatura	OpenAI.numeric (que acepta valores 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.ToolChoiceOptions o OpenAI.ToolChoiceParam		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	OpenAI.integer (que acepta valores NULL)		No
└─ top_p	OpenAI.numeric (que acepta valores NULL)		No	1
└─ truncamiento	enum	Valores posibles: auto, disabled	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
└─ 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	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.incomplete. Valores posibles: response.incomplete	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	Predeterminado
logprob	OpenAI.numeric		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	OpenAI.numeric		No
token	string		No

OpenAI.ResponseMCPCallArgumentsDeltaEvent

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre 'response.mcp_call_arguments.delta'. Valores posibles: response.mcp_call_arguments.delta	Sí

OpenAI.ResponseMCPCallArgumentsDoneEvent

Se genera cuando se finalizan los argumentos de una llamada a la herramienta MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
argumentos	string	Cadena JSON que contiene los argumentos finalizados para 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	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre 'response.mcp_call_arguments.done'. Valores posibles: response.mcp_call_arguments.done	Sí

OpenAI.ResponseMCPCallCompletedEvent

Se genera cuando una llamada a la herramienta MCP se ha completado correctamente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	Identificador del elemento de llamada a la herramienta MCP que se completó.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre 'response.mcp_call.completed'. Valores posibles: response.mcp_call.completed	Sí

OpenAI.ResponseMCPCallFailedEvent

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	Identificador del elemento de llamada a la herramienta MCP que produjo un error.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre "response.mcp_call.failed". Valores posibles: response.mcp_call.failed	Sí

OpenAI.ResponseMCPCallInProgressEvent

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	Identificador único del elemento de llamada a la herramienta MCP que se está procesando.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre "response.mcp_call.in_progress". Valores posibles: response.mcp_call.in_progress	Sí

OpenAI.ResponseMCPListToolsCompletedEvent

Se genera cuando se ha recuperado correctamente la lista de herramientas de MCP disponibles.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	Identificador del elemento de llamada a la herramienta MCP que generó esta salida.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre "response.mcp_list_tools.completed". Valores posibles: response.mcp_list_tools.completed	Sí

OpenAI.ResponseMCPListToolsFailedEvent

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	Identificador del elemento de llamada a la herramienta MCP que produjo un error.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre 'response.mcp_list_tools.failed'. Valores posibles: response.mcp_list_tools.failed	Sí

OpenAI.ResponseMCPListToolsInProgressEvent

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	Identificador del elemento de llamada a la herramienta MCP que se está procesando.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		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	Predeterminado
item	OpenAI.OutputItem		Sí
└" agent_reference	AgentReference	Agente que creó el elemento.	No
└" response_id	string	Respuesta en la que se crea el elemento.	No
└─ Tipo	OpenAI.OutputItemType		Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.output_item.added. Valores posibles: response.output_item.added	Sí

OpenAI.ResponseOutputItemDoneEvent

Se genera cuando un elemento de salida se marca como completado.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item	OpenAI.OutputItem		Sí
└" agent_reference	AgentReference	Agente que creó el elemento.	No
└" response_id	string	Respuesta en la que se crea el elemento.	No
└─ Tipo	OpenAI.OutputItemType		Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.output_item.done. Valores posibles: response.output_item.done	Sí

OpenAI.ResponseOutputTextAnnotationAddedEvent

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

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

OpenAI.ResponsePromptVariables

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

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í
└" agent_reference	AgentReference (que acepta valores NULL)	Agente usado para esta respuesta	Sí
└─ fondo	booleano (que acepta valores NULL)		No
└" completed_at	entero (que acepta valores NULL)		No
Conversación └	OpenAI.ConversationReference (que acepta valores NULL)	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.	No
└─ created_at	integer	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
└─ Error	OpenAI.ResponseError (que acepta valores NULL)	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	Sí
└─ id.	string	Identificador único de esta respuesta.	Sí
└─ detalles_incompletos	OpenAI.ResponseIncompleteDetails (que acepta valores NULL)		Sí
└─ Instrucciones	cadena o matriz de OpenAI.InputItem (que acepta valores NULL)		Sí
└─ max_output_tokens (máximo de tokens de salida)	OpenAI.integer (que acepta valores NULL)		No
└─ «max_tool_calls»	OpenAI.integer (que acepta valores NULL)		No
Metadatos └	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
└─ modelo	string	Implementación del modelo que se va a usar para la creación de esta respuesta.	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 (que acepta valores 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 (que acepta valores 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	enum	Valores posibles: in-memory, 24h	No
└─ razonamiento	OpenAI.Reasoning (que acepta valores NULL)	Modelos de serie gpt-5 y o solo Opciones de configuración para modelos de razonamiento.	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
└" service_tier	OpenAI.ServiceTier	Especifica el tipo de procesamiento utilizado para atender la solicitud. - Si se establece en "auto", la solicitud se procesará con el nivel de servicio configurado en la configuración de Project. A menos que se configure lo contrario, el Project usará "default". - Si se establece en "valor predeterminado", la solicitud se procesará con los precios estándar y el rendimiento del modelo seleccionado. - Si se establece en "flex" o "priority", la solicitud se procesará con el nivel de servicio correspondiente. - Cuando no se establece, el comportamiento predeterminado es "auto". Cuando se establece el service_tier parámetro , el cuerpo de la respuesta incluirá el service_tier valor en función del modo de procesamiento usado realmente para atender la solicitud. Este valor de respuesta puede ser diferente del valor establecido en el parámetro .	No
└─ estado	enum	Estado de la generación de respuesta. Uno de completed, , failed in_progress, cancelled, queuedo incomplete. Valores posibles: completed, failed, in_progress, cancelled, , queued, incomplete	No
└─ Temperatura	OpenAI.numeric (que acepta valores 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.ToolChoiceOptions o OpenAI.ToolChoiceParam		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	OpenAI.integer (que acepta valores NULL)		No
└─ top_p	OpenAI.numeric (que acepta valores NULL)		No	1
└─ truncamiento	enum	Valores posibles: auto, disabled	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
└─ 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	OpenAI.integer		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	Predeterminado
item_id	string	El identificador del elemento al que está asociado este elemento de resumen.	Sí
output_index	OpenAI.integer		Sí
part	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Sí
└─ texto	string		Sí
└─ Tipo	enum	Valores posibles: summary_text	Sí
sequence_number	OpenAI.integer		Sí
summary_index	OpenAI.integer		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.ResponseReasoningSummaryPartDoneEvent

Se emite cuando se completa una parte del resumen de razonamiento.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	El identificador del elemento al que está asociado este elemento de resumen.	Sí
output_index	OpenAI.integer		Sí
part	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Sí
└─ texto	string		Sí
└─ Tipo	enum	Valores posibles: summary_text	Sí
sequence_number	OpenAI.integer		Sí
summary_index	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.reasoning_summary_part.done. Valores posibles: response.reasoning_summary_part.done	Sí

OpenAI.ResponseReasoningSummaryPartDoneEventPart

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	Predeterminado
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	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
summary_index	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.reasoning_summary_text.delta. Valores posibles: response.reasoning_summary_text.delta	Sí

OpenAI.ResponseReasoningSummaryTextDoneEvent

Se genera cuando se completa un texto de resumen de razonamiento.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	El identificador del elemento al que está asociado este texto de resumen.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
summary_index	OpenAI.integer		Sí
text	string	Texto completo del resumen de razonamiento completado.	Sí
type	enum	El tipo de evento. Siempre response.reasoning_summary_text.done. Valores posibles: response.reasoning_summary_text.done	Sí

OpenAI.ResponseReasoningTextDeltaEvent

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
content_index	OpenAI.integer		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	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.reasoning_text.delta. Valores posibles: response.reasoning_text.delta	Sí

OpenAI.ResponseReasoningTextDoneEvent

Se genera cuando se completa un texto de razonamiento.

Nombre	Tipo	Description	Obligatorio	Predeterminado
content_index	OpenAI.integer		Sí
item_id	string	El identificador del elemento al que está asociado este texto de razonamiento.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
text	string	Texto completo del contenido de razonamiento completado.	Sí
type	enum	El tipo de evento. Siempre response.reasoning_text.done. Valores posibles: response.reasoning_text.done	Sí

OpenAI.ResponseRefusalDeltaEvent

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
content_index	OpenAI.integer		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	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.refusal.delta. Valores posibles: response.refusal.delta	Sí

OpenAI.ResponseRefusalDoneEvent

Se emite cuando se finaliza el texto de rechazo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
content_index	OpenAI.integer		Sí
item_id	string	Identificador del elemento de salida que finaliza el texto de denegación.	Sí
output_index	OpenAI.integer		Sí
refusal	string	Texto de denegación finalizado.	Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.refusal.done. Valores posibles: response.refusal.done	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	Predeterminado
content_index	OpenAI.integer		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	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.output_text.delta. Valores posibles: response.output_text.delta	Sí

OpenAI.ResponseTextDoneEvent

Se genera cuando se finaliza el contenido de texto.

Nombre	Tipo	Description	Obligatorio	Predeterminado
content_index	OpenAI.integer		Sí
item_id	string	Identificador del elemento de salida que finaliza el contenido del texto.	Sí
logprobs	matriz de OpenAI.ResponseLogProb	Probabilidades de registro de los tokens en la diferencia.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
text	string	Contenido de texto finalizado.	Sí
type	enum	El tipo de evento. Siempre response.output_text.done. Valores posibles: response.output_text.done	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:

• Entradas y salidas de texto
• Salidas estructuradas

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 gpt-4o y modelos 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, mediumy 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	Predeterminado
input_tokens	OpenAI.integer		Sí
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Sí
└─ tokens en caché	OpenAI.integer		Sí
output_tokens	OpenAI.integer		Sí
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Sí
─ reasoning_tokens	OpenAI.integer		Sí
total_tokens	OpenAI.integer		Sí

OpenAI.ResponseUsageInputTokensDetails

Nombre	Tipo	Description	Obligatorio	Predeterminado
cached_tokens	OpenAI.integer		Sí

OpenAI.ResponseUsageOutputTokensDetails

Nombre	Tipo	Description	Obligatorio	Predeterminado
reasoning_tokens	OpenAI.integer		Sí

OpenAI.ResponseWebSearchCallCompletedEvent

Se genera cuando se completa una llamada de búsqueda web.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	Identificador único del elemento de salida asociado a la llamada de búsqueda web.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.web_search_call.completed. Valores posibles: response.web_search_call.completed	Sí

OpenAI.ResponseWebSearchCallInProgressEvent

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	Identificador único del elemento de salida asociado a la llamada de búsqueda web.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		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

Se genera cuando se ejecuta una llamada de búsqueda web.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	string	Identificador único del elemento de salida asociado a la llamada de búsqueda web.	Sí
output_index	OpenAI.integer		Sí
sequence_number	OpenAI.integer		Sí
type	enum	El tipo de evento. Siempre response.web_search_call.searching. Valores posibles: response.web_search_call.searching	Sí

OpenAI.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í

OpenAI.Scroll

Una acción de desplazamiento.

Nombre	Tipo	Description	Obligatorio	Predeterminado
scroll_x	OpenAI.integer		Sí
scroll_y	OpenAI.integer		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í
x	OpenAI.integer		Sí
y	OpenAI.integer		Sí

OpenAI.SearchContextSize

Propiedad	Value
Type	string
Valores	low medium high

OpenAI.ServiceTier

Especifica el tipo de procesamiento utilizado para atender la solicitud.

• Si se establece en "auto", la solicitud se procesará con el nivel de servicio configurado en la configuración de Project. A menos que se configure lo contrario, el Project usará "default".
• Si se establece en "valor predeterminado", la solicitud se procesará con los precios estándar y el rendimiento del modelo seleccionado.
• Si se establece en "flex" o "priority", la solicitud se procesará con el nivel de servicio correspondiente.
• Cuando no se establece, el comportamiento predeterminado es "auto". Cuando se establece el service_tier parámetro , el cuerpo de la respuesta incluirá el service_tier valor en función del modo de procesamiento usado realmente para atender la solicitud. Este valor de respuesta puede ser diferente del valor establecido en el parámetro .

Propiedad	Value
Type	string
Nullable	Sí
Valores	auto default flex scale priority

OpenAI.SpecificApplyPatchParam

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í

OpenAI.SpecificFunctionShellParam

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í

OpenAI.Summary

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í

OpenAI.SummaryTextContent

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í

OpenAI.TextContent

Contenido de texto.

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

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 se recomienda para gpt-4o y modelos más recientes:* Configuración para { "type": "json_object" } habilitar el modo JSON anterior, lo que garantiza que el mensaje que genera el modelo es 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

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

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

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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 (que acepta valores 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
bing_grounding	BingGroundingTool
fabric_dataagent_preview	MicrosoftFabricPreviewTool
sharepoint_grounding_preview	SharepointPreviewTool
azure_ai_search	AzureAISearchTool
openapi	OpenApiTool
bing_custom_search_preview	BingCustomSearchPreviewTool
browser_automation_preview	BrowserAutomationPreviewTool
azure_function	AzureFunctionTool
capture_structured_outputs	CaptureStructuredOutputsTool
a2a_preview	A2APreviewTool
memory_search_preview	MemorySearchPreviewTool
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

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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

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 customes . 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.ToolChoiceFunction

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
nombre	string	El nombre de la función para llamar.	Sí
type	enum	En el caso de las llamadas a funciones, el tipo siempre es function. Valores posibles: function	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

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
nombre	string (que acepta valores 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 mcpes . Valores posibles: mcp	Sí

OpenAI.ToolChoiceOptions

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

Propiedad	Value
Type	string
Valores	none auto required

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
function	OpenAI.ToolChoiceFunction
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

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	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 a2a_preview bing_custom_search_preview browser_automation_preview fabric_dataagent_preview sharepoint_grounding_preview memory_search_preview azure_ai_search azure_function bing_grounding capture_structured_outputs openapi

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

La probabilidad de registro superior de un token.

Nombre	Tipo	Description	Obligatorio	Predeterminado
bytes	matriz de OpenAI.integer		Sí
logprob	OpenAI.numeric		Sí
token	string		Sí

OpenAI.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í

OpenAI.UpdateConversationBody

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	Sí

OpenAI.UrlCitationBody

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
end_index	OpenAI.integer		Sí
start_index	OpenAI.integer		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	string	Dirección URL del recurso web.	Sí

OpenAI.VectorStoreFileAttributes

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, booleanos o números.

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
Type	string
Nullable	Sí
Valores	low medium high

OpenAI.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í

OpenAI.WebSearchActionFind

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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	Dirección URL de la página en la que se busca el patrón.	Sí

OpenAI.WebSearchActionOpenPage

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	Dirección URL abierta por el modelo.	Sí

OpenAI.WebSearchActionSearch

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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 del usuario.

Nombre	Tipo	Description	Obligatorio	Predeterminado
ciudad	string (que acepta valores NULL)		No
country	string (que acepta valores NULL)		No
region	string (que acepta valores NULL)		No
zona horaria	string (que acepta valores NULL)		No
type	enum	Tipo de aproximación de ubicación. Siempre approximate. Valores posibles: approximate	No

OpenAI.WebSearchPreviewTool

Esta herramienta busca en la web resultados relevantes para usar en una respuesta. Obtenga más información sobre la herramienta de búsqueda web.

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í
ubicación_del_usuario	OpenAI.ApproximateLocation (que acepta valores NULL)		No
└└ ciudad	string (que acepta valores NULL)		No
País └	string (que acepta valores NULL)		No
Región └	string (que acepta valores NULL)		No
└— zona horaria	string (que acepta valores NULL)		No
└─ Tipo	enum	Tipo de aproximación de ubicación. Siempre approximate. Valores posibles: approximate	Sí

OpenAI.WebSearchTool

Busca en Internet fuentes relacionadas con el tema. Obtenga más información sobre la herramienta de búsqueda web.

Nombre	Tipo	Description	Obligatorio	Predeterminado
custom_search_configuration	WebSearchConfiguration	Una configuración de búsqueda web para bing búsqueda personalizada	No
└" instance_name	string	Nombre de la instancia de configuración personalizada dada a config.	Sí
└" project_connection_id	string	Project identificador de conexión para conectar con bing custom search	Sí
filtros	OpenAI.WebSearchToolFilters (que acepta valores NULL)		No
└" allowed_domains	matriz de cadena (que acepta valores 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 delow, medium o high. medium es el valor predeterminado. Valores posibles: low, medium, high	No
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í
ubicación_del_usuario	OpenAI.WebSearchApproximateLocation (que acepta valores NULL)	Ubicación aproximada del usuario.	No
└└ ciudad	string (que acepta valores NULL)		No
País └	string (que acepta valores NULL)		No
Región └	string (que acepta valores NULL)		No
└— zona horaria	string (que acepta valores NULL)		No
└─ Tipo	enum	Tipo de aproximación de ubicación. Siempre approximate. Valores posibles: approximate	No

OpenAI.WebSearchToolFilters

Nombre	Tipo	Description	Obligatorio	Predeterminado
allowed_domains	matriz de cadenas		No

OpenAI.integer

Tipo: entero

Formato: int64

OpenAI.numeric

Tipo: número

Formato: double

OpenApiAnonymousAuthDetails

Detalles de seguridad para la autenticación anónima de OpenApi

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de objeto, que siempre es "anónimo". Valores posibles: anonymous	Sí

OpenApiAuthDetails

detalles de autenticación de OpenApiFunctionDefinition

Discriminador para OpenApiAuthDetails

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

Tipo de valor	Schema
anonymous	OpenApiAnonymousAuthDetails
project_connection	OpenApiProjectConnectionAuthDetails
managed_identity	OpenApiManagedAuthDetails

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenApiAuthType	Tipo de autenticación para el punto de conexión de OpenApi. Los tipos permitidos son: - Anónimo (sin autenticación necesaria) - Project conexión (requiere project_connection_id al punto de conexión, como configuración en AI Foundry) - Managed_Identity (requiere audiencia para la autenticación basada en identidades)	Sí

OpenApiAuthType

Tipo de autenticación para el punto de conexión de OpenApi. Los tipos permitidos son:

• Anónimo (no se requiere autenticación)
• Project Conexión (requiere project_connection_id para terminar, tal como se configura en AI Foundry)
• Managed_Identity (requiere audiencia para la autenticación basada en identidad)

Propiedad	Value
Descripción	Tipo de autenticación para el punto de conexión de OpenApi. Los tipos permitidos son: - Anónimo (sin autenticación necesaria) - Project conexión (requiere project_connection_id al punto de conexión, como configuración en AI Foundry) - Managed_Identity (requiere audiencia para la autenticación basada en identidades)
Type	string
Valores	anonymous project_connection managed_identity

OpenApiFunctionDefinition

Información de definición de entrada para una función openapi.

Nombre	Tipo	Description	Obligatorio	Predeterminado
auth	OpenApiAuthDetails	detalles de autenticación de OpenApiFunctionDefinition	Sí
└─ Tipo	OpenApiAuthType	El tipo de autenticación debe ser anónimo,project_connection/managed_identity	Sí
default_params	matriz de cadenas	Lista de parámetros de especificación de OpenAPI que usarán los valores predeterminados proporcionados por el usuario	No
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
functions	matriz de objeto	Lista de definiciones de función usadas por la herramienta OpenApi	No
nombre	string	El nombre de la función que se llamará.	Sí
spec	object	Forma de la función openapi, que se describe como un objeto de esquema JSON.	Sí

OpenApiManagedAuthDetails

Detalles de seguridad para la autenticación de openApi managed_identity

Nombre	Tipo	Description	Obligatorio	Predeterminado
security_scheme	OpenApiManagedSecurityScheme	Esquema de seguridad para la autenticación de openApi managed_identity	Sí
Audiencia └—	string	Ámbito de autenticación para managed_identity tipo de autenticación	Sí
type	enum	Tipo de objeto, que siempre es "managed_identity". Valores posibles: managed_identity	Sí

OpenApiManagedSecurityScheme

Esquema de seguridad para la autenticación de openApi managed_identity

Nombre	Tipo	Description	Obligatorio	Predeterminado
audience	string	Ámbito de autenticación para managed_identity tipo de autenticación	Sí

OpenApiProjectConnectionAuthDetails

Detalles de seguridad para la autenticación de conexión de OpenApi project

Nombre	Tipo	Description	Obligatorio	Predeterminado
security_scheme	OpenApiProjectConnectionSecurityScheme	Esquema de seguridad para la autenticación de openApi managed_identity	Sí
└" project_connection_id	string	Project identificador de conexión para Project tipo de autenticación de conexión	Sí
type	enum	Tipo de objeto, que siempre es "project_connection". Valores posibles: project_connection	Sí

OpenApiProjectConnectionSecurityScheme

Esquema de seguridad para la autenticación de openApi managed_identity

Nombre	Tipo	Description	Obligatorio	Predeterminado
project_connection_id	string	Project identificador de conexión para Project tipo de autenticación de conexión	Sí

OpenApiTool

La información de definición de entrada de una herramienta OpenAPI como se usa para configurar un agente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
openapi	OpenApiFunctionDefinition	Información de definición de entrada para una función openapi.	Sí
Autenticación └	OpenApiAuthDetails	Detalles de autenticación de Open API	Sí
└" default_params	matriz de cadenas	Lista de parámetros de especificación de OpenAPI que usarán los valores predeterminados proporcionados por el usuario	No
└─ Descripción	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
Funciones └	matriz de objeto (solo lectura)	Lista de definiciones de función usadas por la herramienta OpenApi	No
└─ Descripción	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á.	Sí
Parámetros └	object	Los parámetros que aceptan las funciones, que se describen como un objeto de esquema JSON.	Sí
└─ Nombre	string	El nombre de la función que se llamará.	Sí
Especificación └	object	Forma de la función openapi, que se describe como un objeto de esquema JSON.	Sí
type	enum	El tipo de objeto, que siempre es 'openapi'. Valores posibles: openapi	Sí

PageOrder

Propiedad	Value
Type	string
Valores	asc desc

PagedConnection

Colección paginada de elementos connection

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	string	Vínculo a la página siguiente de elementos	No
value	matriz de conexión	Elementos de conexión de esta página	Sí

PagedDatasetVersion

Colección paginada de elementos DatasetVersion

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	string	Vínculo a la página siguiente de elementos	No
value	matriz de DatasetVersion	Los elementos DatasetVersion de esta página	Sí

PagedDeployment

Colección paginada de elementos de implementación

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	string	Vínculo a la página siguiente de elementos	No
value	matriz de implementación	Elementos de implementación de esta página	Sí

PagedEvaluationRule

Colección paginada de elementos EvaluationRule

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	string	Vínculo a la página siguiente de elementos	No
value	matriz de EvaluationRule	Elementos EvaluationRule de esta página	Sí

PagedEvaluationTaxonomy

Colección paginada de elementos EvaluationTaxonomy

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	string	Vínculo a la página siguiente de elementos	No
value	matriz de EvaluationTaxonomy	Elementos EvaluationTaxonomy de esta página	Sí

PagedEvaluatorVersion

Colección paginada de elementos de EvaluatorVersion

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	string	Vínculo a la página siguiente de elementos	No
value	matriz de EvaluadorVersion	Elementos de EvaluadorVersion de esta página	Sí

PagedIndex

Colección paginada de elementos de índice

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	string	Vínculo a la página siguiente de elementos	No
value	matriz de índice	Elementos de índice de esta página	Sí

PagedInsight

Colección paginada de elementos de Insight

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	string	Vínculo a la página siguiente de elementos	No
value	matriz de Insight	Elementos de información de esta página	Sí

PagedRedTeam

Colección paginada de elementos de RedTeam

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	string	Vínculo a la página siguiente de elementos	No
value	matriz de RedTeam	Elementos redTeam de esta página	Sí

PagedSchedule

Colección paginada de elementos schedule

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	string	Vínculo a la página siguiente de elementos	No
value	matriz de programación	Los elementos Programación de esta página	Sí

PagedScheduleRun

Colección paginada de elementos ScheduleRun

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	string	Vínculo a la página siguiente de elementos	No
value	matriz de ScheduleRun	Los elementos ScheduleRun de esta página	Sí

PendingUploadRequest

Representa una solicitud de una carga pendiente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
connectionName	string	Nombre de conexión de la cuenta de almacenamiento de Azure que se va a usar para generar un token de SAS temporal	No
pendingUploadId	string	Si no se proporciona PendingUploadId, se usará un GUID aleatorio.	No
pendingUploadType	enum	BlobReference es el único tipo admitido. Valores posibles: BlobReference	Sí

PendingUploadResponse

Representa la respuesta a una solicitud de carga pendiente

Nombre	Tipo	Description	Obligatorio	Predeterminado
blobReference	BlobReference	Detalles de referencia de blobs.	Sí
└— blobUri	string	Ruta de acceso del URI del blob para que el cliente cargue datos. Ejemplo: https://blob.windows.core.net/Container/Path	Sí
Credencial de └	SasCredential	Información de credenciales para acceder a la cuenta de almacenamiento.	Sí
└] storageAccountArmId	string	Identificador de ARM de la cuenta de almacenamiento que se va a usar.	Sí
pendingUploadId	string	ID para esta solicitud de carga.	Sí
pendingUploadType	enum	BlobReference es el único tipo admitido Valores posibles: BlobReference	Sí
version	string	Versión del recurso que se va a crear si el usuario no especificó la versión al crear inicialmente la carga	No

PromptAgentDefinition

Definición del agente del símbolo del sistema

Nombre	Tipo	Description	Obligatorio	Predeterminado
instructions	string (que acepta valores NULL)	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo.	No
amable	enum	Valores posibles: prompt	Sí
model	string	Implementación del modelo que se va a usar para este agente.	Sí
rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
└" rai_policy_name	string	Nombre de la directiva RAI que se va a aplicar.	Sí
reasoning	OpenAI.Reasoning (que acepta valores NULL)	Modelos de serie gpt-5 y o solo Opciones de configuración para modelos de razonamiento.	No
└─ esfuerzo	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de 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 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, mediumy 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-maxde .	No
└─ generar_resumen	enum	Valores posibles: auto, concise, detailed	No
└─ resumen	enum	Valores posibles: auto, concise, detailed	No
structured_inputs	object	Conjunto de entradas estructuradas que pueden participar en la sustitución de plantillas de solicitud o enlaces de argumentos de herramientas.	No
temperatura	número	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. Por lo general, se recomienda modificar esto o top_p no ambos.	No	1
text	PromptAgentDefinitionTextOptions	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados.	No
└─ Formato	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 gpt-4o y modelos 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
tool_choice	string o 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.	No
tools	matriz de OpenAI.Tool	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 .	No
top_p	número	Alternativa al muestreo con temperatura, denominado muestreo de núcleo, donde el modelo considera los resultados de los tokens con top_p probabilidad masa. Por lo tanto, 0,1 significa solo los tokens que comprenden la masa de probabilidad del 10 % superior se consideran. Por lo general, se recomienda modificar esto o temperature no ambos.	No	1

PromptAgentDefinitionTextOptions

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

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 gpt-4o y modelos 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

PromptBasedEvaluatorDefinition

Evaluador basado en indicaciones

Nombre	Tipo	Description	Obligatorio	Predeterminado
data_schema	object	El esquema JSON (Borrador 2020-12) para los datos de entrada del evaluador. Esto incluye parámetros como tipo, propiedades, obligatorio.	No
init_parameters	object	El esquema JSON (Borrador 2020-12) para los parámetros de entrada del evaluador. Esto incluye parámetros como tipo, propiedades, obligatorio.	No
metrics	object	Lista de métricas de salida producidas por este evaluador	No
prompt_text	string	El texto del mensaje usado para la evaluación	Sí
type	enum	Valores posibles: prompt	Sí

ProtocolVersionRecord

Una asignación de registros para un solo protocolo y su versión.

Nombre	Tipo	Description	Obligatorio	Predeterminado
protocol	AgentProtocol		Sí
version	string	Cadena de versión del protocolo, por ejemplo, "v0.1.1".	Sí

RaiConfig

Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).

Nombre	Tipo	Description	Obligatorio	Predeterminado
rai_policy_name	string	Nombre de la directiva RAI que se va a aplicar.	Sí

RecurrenceSchedule

Modelo de programación de periodicidad.

Discriminador para RecurrenceSchedule

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

Tipo de valor	Schema
Hourly	HourlyRecurrenceSchedule
Daily	DailyRecurrenceSchedule
Weekly	WeeklyRecurrenceSchedule
Monthly	MonthlyRecurrenceSchedule

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	RecurrenceType	Tipo de recurrencia.	Sí

RecurrenceTrigger

Desencadenador basado en recurrencia.

Nombre	Tipo	Description	Obligatorio	Predeterminado
endTime	string	Hora de finalización de la programación de periodicidad en formato ISO 8601.	No
interval	integer	Intervalo para el programa de periodicidad.	Sí
schedule	RecurrenceSchedule	Modelo de programación de periodicidad.	Sí
└─ Tipo	RecurrenceType	Tipo de periodicidad para la programación de periodicidad.	Sí
startTime	string	Hora de inicio de la programación de recurrencia en formato ISO 8601.	No
timeZone	string	Zona horaria para la programación de periodicidad.	No	UTC
type	enum	Tipo de desencadenante. Valores posibles: Recurrence	Sí

RecurrenceType

Tipo de recurrencia.

Propiedad	Value
Descripción	Tipo de recurrencia.
Type	string
Valores	Hourly Daily Weekly Monthly

RedTeam

Detalles del equipo rojo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
applicationScenario	string	Escenario de aplicación para la operación de equipo rojo, para generar ataques específicos del escenario.	No
attackStrategies	matriz de AttackStrategy	Lista de estrategias de ataque o listas anidadas de estrategias de ataque.	No
displayName	string	Nombre de la ejecución del equipo rojo.	No
id	string (solo lectura)	Identificador de la ejecución del equipo rojo.	Sí
numTurns	integer	Número de rondas de simulación.	No
properties	object	Propiedades del equipo rojo. A diferencia de las etiquetas, las propiedades son de solo complemento. Una vez agregado, no se puede quitar una propiedad.	No
riskCategories	matriz de RiskCategory	Lista de categorías de riesgo para las que se van a generar objetivos de ataque.	No
simulationOnly	boolean	Solo simulación o Simulación + Evaluación. El valor predeterminado es false, si es true, la conversación genera el resultado de la conversación no de evaluación.	No	Falso
status	string (solo lectura)	Estado del equipo rojo. Se establece por servicio y es de solo lectura.	No
tags	object	Etiquetas del equipo rojo. A diferencia de las propiedades, las etiquetas son completamente mutables.	No
target	TargetConfig	Clase abstracta para la configuración de destino.	Sí
└─ Tipo	string	Tipo de la configuración del modelo.	Sí

RedTeamEvalRunDataSource

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_generation_params	ItemGenerationParams	Representa el conjunto de parámetros usados para controlar las operaciones de generación de elementos.	Sí
└─ Tipo	ItemGenerationParamsType	Tipo de parámetros de generación de elementos que se van a usar.	Sí
target	Target	Clase base para destinos con compatibilidad con discriminadores.	Sí
└─ Tipo	string	Tipo de destino.	Sí
type	enum	Tipo de origen de datos. Siempre azure_ai_red_team. Valores posibles: azure_ai_red_team	Sí

RedTeamItemGenerationParams

Nombre	Tipo	Description	Obligatorio	Predeterminado
attack_strategies	matriz de AttackStrategy	Colección de estrategias de ataque que se van a usar.	Sí
num_turns	integer	Número de turnos permitidos en el juego.	Sí	20
type	enum	Tipo de parámetros de generación de elementos. Valores posibles: red_team	Sí

RedTeamSeedPromptsItemGenerationParams

Representa los parámetros para la generación de elementos de inicialización del equipo rojo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
attack_strategies	matriz de AttackStrategy	Colección de estrategias de ataque que se van a usar.	Sí
num_turns	integer	Número de turnos permitidos en el juego.	Sí	20
source	OpenAI.EvalJsonlFileContentSource		Sí
└─ Contenido	matriz de OpenAI.EvalJsonlFileContentSourceContent	Contenido del archivo jsonl.	Sí
└─ Tipo	enum	Tipo de origen jsonl. Siempre file_content. Valores posibles: file_content	Sí
type	enum	Tipo de parámetros de generación de elementos, siempre red_team_seed_prompts. Valores posibles: red_team_seed_prompts	Sí

RedTeamTaxonomyItemGenerationParams

Representa los parámetros para la generación de elementos de taxonomía de equipo rojo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
attack_strategies	matriz de AttackStrategy	Colección de estrategias de ataque que se van a usar.	Sí
num_turns	integer	Número de turnos permitidos en el juego.	Sí	20
source	OpenAI.EvalJsonlFileContentSource		Sí
└─ Contenido	matriz de OpenAI.EvalJsonlFileContentSourceContent	Contenido del archivo jsonl.	Sí
└─ Tipo	enum	Tipo de origen jsonl. Siempre file_content. Valores posibles: file_content	Sí
type	enum	Tipo de parámetros de generación de elementos, siempre red_team_taxonomy. Valores posibles: red_team_taxonomy	Sí

ResponseRetrievalItemGenerationParams

Representa los parámetros para la generación de elementos de recuperación de respuesta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
mapeo de datos	object	Asignación de campos de origen a response_id campo, necesario para recuperar el historial de chats.	Sí
max_num_turns	integer	Número máximo de turnos del historial de chat que se va a evaluar.	Sí
source	OpenAI.EvalJsonlFileContentSource o OpenAI.EvalJsonlFileIdSource	Origen desde el que se lee el contenido JSONL.	Sí
type	enum	Tipo de parámetros de generación de elementos, siempre response_retrieval. Valores posibles: response_retrieval	Sí

RiskCategory

Categoría de riesgo para el objetivo del ataque.

Propiedad	Value
Descripción	Categoría de riesgo para el objetivo del ataque.
Type	string
Valores	HateUnfairness Violence Sexual SelfHarm ProtectedMaterial CodeVulnerability UngroundedAttributes ProhibitedActions SensitiveDataLeakage TaskAdherence

SASCredentials

Definición de credenciales de firma de acceso compartido (SAS)

Nombre	Tipo	Description	Obligatorio	Predeterminado
SAS	string (solo lectura)	Token de SAS	No
type	enum	Tipo de credencial Valores posibles: SAS	Sí

SampleType

El tipo de muestra utilizada en el análisis.

Propiedad	Value
Descripción	El tipo de muestra utilizada en el análisis.
Type	string
Valores	EvaluationResultSample

SasCredential

Definición de credenciales de SAS

Nombre	Tipo	Description	Obligatorio	Predeterminado
sasUri	string (solo lectura)	URI de SAS	Sí
type	enum	Tipo de credencial Valores posibles: SAS	Sí

Schedule

Modelo de programación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Descripción de la programación.	No
displayName	string	Nombre de la programación.	No
enabled	boolean	Estado habilitado de la programación.	Sí
id	string (solo lectura)	Identificador de la programación.	Sí
properties	object	Propiedades de la programación. A diferencia de las etiquetas, las propiedades son de solo complemento. Una vez agregado, no se puede quitar una propiedad.	No
provisioningStatus	ScheduleProvisioningStatus (solo lectura)	Programar el estado de aprovisionamiento.	No
datos del sistema	objeto (solo lectura)	Metadatos del sistema para el recurso.	Sí
tags	object	Etiquetas de programación. A diferencia de las propiedades, las etiquetas son completamente mutables.	No
task	ScheduleTask	Modelo de tareas de programación.	Sí
Configuración de └	object	Configuración de la tarea.	No
└─ Tipo	ScheduleTaskType	Tipo de la tarea.	Sí
trigger	Trigger	Modelo base para el Disparador del horario.	Sí
└─ Tipo	Tipo de desencadenante	Tipo de desencadenante.	Sí

ScheduleProvisioningStatus

Programar el estado de aprovisionamiento.

Propiedad	Value
Descripción	Programar el estado de aprovisionamiento.
Type	string
Valores	Creating Updating Deleting Succeeded Failed

ScheduleRun

Programar modelo de ejecución.

Nombre	Tipo	Description	Obligatorio	Predeterminado
error	string (solo lectura)	Información de error para la ejecución de programación.	No
id	string (solo lectura)	Identificador de la ejecución de programación.	Sí
properties	objeto (solo lectura)	Propiedades de la ejecución de programación.	Sí
scheduleId	string	Identificador de la programación.	Sí
éxito	booleano (solo lectura)	Desencadene el estado correcto de la ejecución de programación.	Sí
triggerTime	string	Tiempo de desencadenamiento de la ejecución de la programación.	No

ScheduleTask

Modelo de tareas de programación.

Discriminador para ScheduleTask

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

Tipo de valor	Schema
Evaluation	EvaluationScheduleTask
Insight	InsightScheduleTask

Nombre	Tipo	Description	Obligatorio	Predeterminado
configuration	object	Configuración de la tarea.	No
type	ScheduleTaskType	Tipo de la tarea.	Sí

ScheduleTaskType

Tipo de la tarea.

Propiedad	Value
Descripción	Tipo de la tarea.
Type	string
Valores	Evaluation Insight

SharepointGroundingToolParameters

Los parámetros de la herramienta de conexión a tierra de SharePoint.

Nombre	Tipo	Description	Obligatorio	Predeterminado
project_connections	matriz de ToolProjectConnection	La project conexiones conectadas a esta herramienta. Puede haber un máximo de 1 conexión. recurso asociado a la herramienta.	No

SharepointPreviewTool

La información de definición de entrada de una herramienta de sharepoint como se usa para configurar un agente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
sharepoint_grounding_preview	SharepointGroundingToolParameters	Los parámetros de la herramienta de conexión a tierra de SharePoint.	Sí
└" project_connections	matriz de ToolProjectConnection	La project conexiones conectadas a esta herramienta. Puede haber un máximo de 1 conexión. recurso asociado a la herramienta. Restricciones: maxItems: 1	No
type	enum	El tipo de objeto, que siempre es 'sharepoint_grounding_preview'. Valores posibles: sharepoint_grounding_preview	Sí

Sku

Información de SKU

Nombre	Tipo	Description	Obligatorio	Predeterminado
capacity	integer	Capacidad de SKU	Sí
family	string	Familia de SKU	Sí
nombre	string	Nombre de SKU	Sí
size	string	Tamaño de SKU	Sí
tier	string	Nivel de SKU	Sí

StructuredInputDefinition

Una entrada estructurada que puede participar en sustituciones de plantillas de solicitud y enlace de argumentos de herramientas.

Nombre	Tipo	Description	Obligatorio	Predeterminado
default_value		El valor predeterminado para la entrada si no se proporciona ningún valor en tiempo de ejecución.	No
description	string	Una descripción legible por humanos de la entrada.	No
required	boolean	Si la propiedad de entrada es necesaria cuando se invoca el agente.	No	Falso
schema	object	El esquema JSON para la entrada estructurada (opcional).	No

StructuredOutputDefinition

Salida estructurada que el agente puede generar.

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Descripción de la salida que se va a emitir. Usado por el modelo para determinar cuándo emitir la salida.	Sí
nombre	string	Nombre de la salida estructurada.	Sí
schema	object	Esquema JSON para la salida estructurada.	Sí
strict	booleano (que acepta valores NULL)	Si se aplica una validación estricta. Por defecto true.	Sí

StructuredOutputsOutputItem

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
output		Salida estructurada capturada durante la respuesta.	Sí
response_id	string	Respuesta en la que se crea el elemento.	No
type	enum	Valores posibles: structured_outputs	Sí

SyntheticDataGenerationPreviewEvalRunDataSource

Representa un origen de datos para las ejecuciones de evaluación que se evalúan en función de los datos sintéticos generados con fines de prueba.

Nombre	Tipo	Description	Obligatorio	Predeterminado
mensajes de entrada	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		No
└─ Plantilla	matriz de objeto o OpenAI.EvalItem		Sí
└─ Tipo	enum	Valores posibles: template	Sí
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		Sí
└" model_deployment_name	string	Nombre de la implementación del modelo que se va a usar para generar datos sintéticos.	Sí
└" output_dataset_id	string (solo lectura)	Identificador del conjunto de datos de salida donde se almacenan los datos sintéticos generados. Los datos generados son un archivo jsonl con id. de columnas, consulta y test_description.	No
└" output_dataset_name	string	Nombre del conjunto de datos de salida donde se almacenarán los datos sintéticos generados. Si no se proporciona, el servicio genera automáticamente el nombre del conjunto de datos.	No
└─ indicación	string	Solicitud que se usa para generar datos sintéticos. Esta es la opción si el destino es de tipo "azure_ai_agent" con instrucciones configuradas en el agente.	No
└" samples_count	integer	Número máximo de muestras de datos que se van a generar.	Sí
Orígenes └	matriz de OpenAI.EvalJsonlFileIdSource	Archivos de origen de contenido de datos de inicialización opcionales para la generación de datos.	Sí
└─ Tipo	enum	Tipo de parámetros de generación de elementos. Valores posibles: synthetic_data_gen_preview	Sí
target	Target	Clase base para destinos con compatibilidad con discriminadores.	Sí
└─ Tipo	string	Tipo de destino.	Sí
type	enum	Tipo de origen de datos, siempre azure_ai_synthetic_data_gen_preview. Valores posibles: azure_ai_synthetic_data_gen_preview	Sí

SyntheticDataGenerationPreviewItemGenerationParams

Nombre	Tipo	Description	Obligatorio	Predeterminado
model_deployment_name	string	Nombre de la implementación del modelo que se va a usar para generar datos sintéticos.	Sí
output_dataset_id	string (solo lectura)	Identificador del conjunto de datos de salida donde se almacenan los datos sintéticos generados. Los datos generados son un archivo jsonl con id. de columnas, consulta y test_description.	No
output_dataset_name	string	Nombre del conjunto de datos de salida donde se almacenarán los datos sintéticos generados. Si no se proporciona, el servicio genera automáticamente el nombre del conjunto de datos.	No
prompt	string	Solicitud que se usa para generar datos sintéticos. Esta es la opción si el destino es de tipo "azure_ai_agent" con instrucciones configuradas en el agente.	No
samples_count	integer	Número máximo de muestras de datos que se van a generar.	Sí
orígenes	matriz de OpenAI.EvalJsonlFileIdSource	Archivos de origen de contenido de datos de inicialización opcionales para la generación de datos.	Sí
type	enum	Tipo de parámetros de generación de elementos. Valores posibles: synthetic_data_gen_preview	Sí

Target

Clase base para destinos con compatibilidad con discriminadores.

Discriminador para destino

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

Tipo de valor	Schema
azure_ai_model	AzureAIModelTarget
azure_ai_agent	AzureAIAgentTarget

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	string	Tipo de destino.	Sí

TargetCompletionEvalRunDataSource

Representa un origen de datos para la configuración de evaluación de finalización basada en destino.

Nombre	Tipo	Description	Obligatorio	Predeterminado
mensajes de entrada	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		No
└─ referencia_elemento	string		Sí
└─ Tipo	enum	Valores posibles: item_reference	Sí
source	OpenAI.EvalJsonlFileContentSource o OpenAI.EvalJsonlFileIdSource	Configuración de origen para datos insertados o de archivo.	Sí
target	Target	Clase base para destinos con compatibilidad con discriminadores.	Sí
└─ Tipo	string	Tipo de destino.	Sí
type	enum	Tipo de origen de datos, siempre azure_ai_target_completions. Valores posibles: azure_ai_target_completions	Sí

TargetConfig

Clase abstracta para la configuración de destino.

Discriminador para TargetConfig

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

Tipo de valor	Schema
AzureOpenAIModel	AzureOpenAIModelConfiguration

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	string	Tipo de la configuración del modelo.	Sí

TargetUpdate

Clase base para destinos con compatibilidad con discriminadores.

Discriminador para TargetUpdate

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

Tipo de valor	Schema
azure_ai_model	AzureAIModelTargetUpdate
azure_ai_agent	AzureAIAgentTargetUpdate

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	string	Tipo de destino.	Sí

TaxonomíaCategory

Definición de categoría de taxonomía.

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Descripción de la categoría de taxonomía.	No
id	string	Identificador único de la categoría de taxonomía.	Sí
nombre	string	Nombre de la categoría de taxonomía.	Sí
properties	object	Propiedades adicionales para la categoría de taxonomía.	No
riskCategory	RiskCategory	Categoría de riesgo para el objetivo del ataque.	Sí
subCategories	matriz de taxonomíaSubCategory	Lista de sub categorías de taxonomía.	Sí

TaxonomíaSubCategory

Definición de subcategoría de taxonomía.

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Descripción de la subconsulta taxonomía.	No
enabled	boolean	Lista de elementos de taxonomía en esta subconsulta.	Sí
id	string	Identificador único de la subconsulta taxonomía.	Sí
nombre	string	Nombre de la sub-categoría taxonomía.	Sí
properties	object	Propiedades adicionales para la sub-categoría taxonomía.	No

ToolDescription

Descripción de una herramienta que puede ser utilizada por un agente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Una breve descripción del propósito de la herramienta.	No
nombre	string	Nombre de la herramienta.	No

ToolProjectConnection

Un recurso de conexión project.

Nombre	Tipo	Description	Obligatorio	Predeterminado
project_connection_id	string	Una conexión de proyecto en un ToolProjectConnectionList adjunto a esta herramienta.	Sí

TracesPreviewEvalRunDataSource

Representa un origen de datos para las ejecuciones de evaluación que operan a través de seguimientos del agente almacenados en Application Insights.

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent_id	string	Identificador del agente que se usa para filtrar los seguimientos de la evaluación.	No
agent_name	string	Nombre del agente que se usa para filtrar los seguimientos de la evaluación.	No
hora_de_terminación	integer	Marca de tiempo de Unix (en segundos) que marca el final de la ventana de consulta de seguimiento. El valor predeterminado es la hora actual.	No
ingestion_delay_seconds	integer	Retraso que se va a aplicar para la ingesta al consultar seguimientos.	No	300
lookback_hours	integer	Ventana de devolución de búsqueda (en horas) aplicada al recuperar seguimientos de Application Insights. Para las evaluaciones programadas, esto se deduce del intervalo de periodicidad.	No	168
max_traces	integer	Límite de muestreo aplicado a seguimientos recuperados para la evaluación.	No	1000
trace_ids	matriz de cadenas	Colección de identificadores de seguimiento del agente que se deben evaluar.	No
type	enum	Tipo de origen de datos, siempre azure_ai_traces_preview. Valores posibles: azure_ai_traces_preview	Sí

TreatmentEffectType

Tipo de efecto del tratamiento.

Propiedad	Value
Descripción	Tipo de efecto del tratamiento.
Type	string
Valores	TooFewSamples Inconclusive Changed Improved Degraded

Trigger

Modelo base para el Disparador del horario.

Discriminador para desencadenador

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

Tipo de valor	Schema
Cron	CronTrigger
Recurrence	recurrenceTrigger
OneTime	OneTimeTrigger

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	Tipo de desencadenante	Tipo de desencadenante.	Sí

Tipo de Activador

Tipo de desencadenante.

Propiedad	Value
Descripción	Tipo de desencadenante.
Type	string
Valores	Cron Recurrence OneTime

UpdateAgentFromManifestRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
description	string	Descripción legible del agente. Restricciones: maxLength: 512	No
manifest_id	string	Identificador de manifiesto desde el que se va a importar la versión del agente.	Sí
metadatos	object	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 una estructura formatear 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.	No
parameter_values	object	Las entradas del manifiesto que darán lugar a un agente totalmente materializado.	Sí

UpdateAgentRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
definición	AgentDefinition		Sí
└└ kind	AgentKind		Sí
└" rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
description	string	Descripción legible del agente. Restricciones: maxLength: 512	No
metadatos	object	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 una estructura formatear 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.	No

UpdateEvalParametersBody

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadatos	OpenAI.Metadata (que acepta valores NULL)	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 una estructura formatear 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.	No
nombre	string		No
properties	object	Conjunto de pares clave-valor inmutables de 16 que se pueden adjuntar a un objeto para almacenar información adicional. Las claves son cadenas con una longitud máxima de 64 caracteres. Los valores son cadenas con una longitud máxima de 512 caracteres.	No

UserProfileMemoryItem

Un elemento de memoria que contiene específicamente información de perfil de usuario extraída de conversaciones, como preferencias, intereses y datos personales.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	string	El contenido de la memoria.	Sí
amable	enum	El tipo del elemento de memoria. Valores posibles: user_profile	Sí
memory_id	string	El identificador único del elemento de memoria.	Sí
scope	string	El espacio de nombres que agrupa y aísla lógicamente las memorias, como un ID de usuario.	Sí
updated_at	integer	La hora de la última actualización del elemento de memoria.	Sí

WebSearchConfiguration

Una configuración de búsqueda web para bing búsqueda personalizada

Nombre	Tipo	Description	Obligatorio	Predeterminado
nombre_instancia	string	Nombre de la instancia de configuración personalizada dada a config.	Sí
project_connection_id	string	Project identificador de conexión para conectar con bing custom search	Sí

WeeklyRecurrenceSchedule

Calendario de recurrencia semanal.

Nombre	Tipo	Description	Obligatorio	Predeterminado
daysOfWeek	matriz de DayOfWeek	Días de la semana para la programación de periodicidad.	Sí
type	enum	Tipo de periodicidad semanal. Valores posibles: Weekly	Sí

WorkflowActionOutputItem

Nombre	Tipo	Description	Obligatorio	Predeterminado
action_id	string	Identificador único de la acción.	Sí
agent_reference	AgentReference		No
└─ Nombre	string	Nombre del agente. Restricciones: maxLength: 256	Sí
└─ Tipo	enum	Valores posibles: agent_reference	Sí
└─ versión	string	Identificador de versión del agente.	No
amable	string	El tipo de acción CSDL (por ejemplo, "SetVariable", "InvokeAzureAgent").	Sí
parent_action_id	string	Identificador de la acción primaria si se trata de una acción anidada.	No
previous_action_id	string	Identificador de la acción anterior si esta acción sigue a otra.	No
response_id	string	Respuesta en la que se crea el elemento.	No
status	enum	Estado de la acción (por ejemplo, "in_progress", "completed", "failed", "cancelled"). Valores posibles: completed, failed, in_progress, cancelled	Sí
type	enum	Valores posibles: workflow_action	Sí

WorkflowAgentDefinition

La definición del agente de flujo de trabajo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
amable	enum	Valores posibles: workflow	Sí
rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
└" rai_policy_name	string	Nombre de la directiva RAI que se va a aplicar.	Sí
flujo de trabajo	string	Definición de YAML de CSDL del flujo de trabajo.	No

integer

Tipo: entero

Formato: int64