Referencia de REST de Microsoft Foundry Project

Versión de API: 2025-11-15-preview

Agentes: creación de agente

POST {endpoint}/agents?api-version=2025-11-15-preview

Crea el agente.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
definición	objeto		Sí
└└ kind	AgentKind		No
└" rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
descripción	cuerda / cadena	Descripción legible del agente.	No
metadata	objeto	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	cuerda / cadena	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.	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AgentObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Agentes: enumerar agentes

GET {endpoint}/agents?api-version=2025-11-15-preview

Devuelve la lista de todos los agentes.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
amable	query	No		Filtrar agentes por tipo. Si no se proporciona, se devuelven todos los agentes.
limit	query	No	entero	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	cuerda / cadena Valores posibles: `asc`, `desc`	Criterio de ordenación por la `created_at` marca de tiempo de los objetos. `asc` para orden ascendente y`desc` para orden descendente.
after	query	No	cuerda / cadena	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	cuerda / cadena	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.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	objeto	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	Tipo	Descripción
application/json	ApiErrorResponse

Agentes: obtener agente

GET {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

Recupera el agente.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	El nombre del agente que se va a recuperar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AgentObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Agentes: agente de actualización

POST {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

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	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	El nombre del agente que se va a recuperar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
definición	objeto		Sí
└└ kind	AgentKind		No
└" rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
descripción	cuerda / cadena	Descripción legible del agente.	No
metadata	objeto	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

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AgentObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Agentes: eliminación del agente

DELETE {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

Elimina un agente.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	El nombre del agente que se va a eliminar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	DeleteAgentResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Agentes: actualización del agente desde el manifiesto

POST {endpoint}/agents/{agent_name}/import?api-version=2025-11-15-preview

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	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	Nombre del agente que se va a actualizar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Descripción legible del agente.	No
manifest_id	cuerda / cadena	Identificador de manifiesto desde el que se va a importar la versión del agente.	Sí
metadata	objeto	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	objeto	Las entradas del manifiesto que darán lugar a un agente totalmente materializado.	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AgentObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Agentes: enumerar las operaciones de contenedor del agente

GET {endpoint}/agents/{agent_name}/operations?api-version=2025-11-15-preview

Enumerar las operaciones de contenedor para un agente.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	Nombre del agente.
limit	query	No	entero	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	cuerda / cadena Valores posibles: `asc`, `desc`	Criterio de ordenación por la `created_at` marca de tiempo de los objetos. `asc` para orden ascendente y`desc` para orden descendente.
after	query	No	cuerda / cadena	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	cuerda / cadena	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.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	objeto	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	Tipo	Descripción
application/json	ApiErrorResponse

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

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	Nombre del agente.
operation_id	ruta	Sí	cuerda / cadena	Identificador de la operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AgentContainerOperationObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse o ApiErrorResponse

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

POST {endpoint}/agents/{agent_name}/versions?api-version=2025-11-15-preview

Cree una nueva versión del agente.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	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.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
definición	objeto		Sí
└└ kind	AgentKind		No
└" rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
descripción	cuerda / cadena	Descripción legible del agente.	No
metadata	objeto	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

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AgentVersionObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Agentes: enumerar las versiones del agente

GET {endpoint}/agents/{agent_name}/versions?api-version=2025-11-15-preview

Devuelve la lista de versiones de un agente.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	Nombre del agente para el que se van a recuperar versiones.
limit	query	No	entero	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	cuerda / cadena Valores posibles: `asc`, `desc`	Criterio de ordenación por la `created_at` marca de tiempo de los objetos. `asc` para orden ascendente y`desc` para orden descendente.
after	query	No	cuerda / cadena	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	cuerda / cadena	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.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	objeto	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	Tipo	Descripción
application/json	ApiErrorResponse

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

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	El nombre del agente que se va a recuperar.
agent_version	ruta	Sí	cuerda / cadena	Versión del agente que se va a recuperar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AgentVersionObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

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

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	El nombre del agente que se va a eliminar.
agent_version	ruta	Sí	cuerda / cadena	Versión del agente que se va a eliminar

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	DeleteAgentVersionResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Agentes: obtención del contenedor de agentes

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	Nombre del agente.
agent_version	ruta	Sí	cuerda / cadena	Versión del agente.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AgentContainerObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

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

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	Nombre del agente.
agent_version	ruta	Sí	cuerda / cadena	Versión del agente.
limit	query	No	entero	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	cuerda / cadena Valores posibles: `asc`, `desc`	Criterio de ordenación por la `created_at` marca de tiempo de los objetos. `asc` para orden ascendente y`desc` para orden descendente.
after	query	No	cuerda / cadena	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	cuerda / cadena	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.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	objeto	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	Tipo	Descripción
application/json	ApiErrorResponse

Agentes: eliminación del contenedor del agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	Nombre del agente.
agent_version	ruta	Sí	cuerda / cadena	Versión del agente.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

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	Tipo	Descripción
application/json	AgentContainerOperationObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Agentes: iniciar el contenedor del agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	Nombre del agente.
agent_version	ruta	Sí	cuerda / cadena	Versión del agente.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
max_replicas	entero	Número máximo de réplicas. El valor predeterminado es 1.	No	1
min_replicas	entero	Número mínimo de réplicas. El valor predeterminado es 1.	No	1

Respuestas

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	Tipo	Descripción
application/json	AgentContainerOperationObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Agentes: detener el contenedor del agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	Nombre del agente.
agent_version	ruta	Sí	cuerda / cadena	Versión del agente.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

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	Tipo	Descripción
application/json	AgentContainerOperationObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse o ApiErrorResponse

Agentes: actualización del contenedor del agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	Nombre del agente.
agent_version	ruta	Sí	cuerda / cadena	Versión del agente.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

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

Respuestas

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	Tipo	Descripción
application/json	AgentContainerOperationObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	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=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
agent_name	ruta	Sí	cuerda / cadena	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.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Descripción legible del agente.	No
manifest_id	cuerda / cadena	Identificador de manifiesto desde el que se va a importar la versión del agente.	Sí
metadata	objeto	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	objeto	Las entradas del manifiesto que darán lugar a un agente totalmente materializado.	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AgentVersionObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Agentes: creación de agente a partir del manifiesto

POST {endpoint}/agents:import?api-version=2025-11-15-preview

Crea un agente a partir de un manifiesto.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Descripción legible del agente.	No
manifest_id	cuerda / cadena	Identificador de manifiesto desde el que se va a importar la versión del agente.	Sí
metadata	objeto	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	cuerda / cadena	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.	Sí
parameter_values	objeto	Las entradas del manifiesto que darán lugar a un agente totalmente materializado.	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AgentObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Conexiones: lista

GET {endpoint}/connections?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
tipo de conexión	query	No		Enumerar conexiones de este tipo específico
defaultConnection	query	No	booleano	Enumerar las conexiones que son conexiones predeterminadas
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	PagedConnection

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Conexiones: obtener

GET {endpoint}/connections/{name}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	El nombre descriptivo de la conexión, proporcionado por el usuario.
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	Conexión

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Conexiones: obtención con credenciales

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	El nombre descriptivo de la conexión, proporcionado por el usuario.
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	Conexión

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Conjuntos de datos: enumeración más reciente

GET {endpoint}/datasets?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	PagedDatasetVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Conjuntos de datos: enumerar versiones

GET {endpoint}/datasets/{name}/versions?api-version=2025-11-15-preview

Enumerar todas las versiones de la DatasetVersion dada

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	PagedDatasetVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Conjuntos de datos: obtener versión

GET {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso
version	ruta	Sí	cuerda / cadena	El identificador de versión específico de DatasetVersion que se va a recuperar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	DatasetVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

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

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso
version	ruta	Sí	cuerda / cadena	La versión de DatasetVersion que se va a eliminar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

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	Tipo	Descripción
application/json	Azure.Core.Foundations.ErrorResponse

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

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso
version	ruta	Sí	cuerda / cadena	Identificador de versión específico de DatasetVersion que se va a crear o actualizar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/merge-patch+json

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Texto de descripción del recurso.	No
tags	objeto	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
type	objeto	Enumeración para determinar el tipo de datos.	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	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	Tipo	Descripción
application/json	DatasetVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Conjuntos de datos: obtención de credenciales

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=2025-11-15-preview

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	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso
version	ruta	Sí	cuerda / cadena	El identificador de versión específico de DatasetVersion en el que se va a operar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AssetCredentialResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

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

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso
version	ruta	Sí	cuerda / cadena	El identificador de versión específico de DatasetVersion en el que se va a operar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
connectionName	cuerda / cadena	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	cuerda / cadena	Si no se proporciona PendingUploadId, se usará un GUID aleatorio.	No
pendingUploadType	enum	BlobReference es el único tipo admitido. Valores posibles: `BlobReference`	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	PendingUploadResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Implementaciones: lista

GET {endpoint}/deployments?api-version=2025-11-15-preview

Enumerar todos los modelos implementados en el proyecto

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
modelPublisher	query	No	cuerda / cadena	Editor de modelos para filtrar modelos por
modelName	query	No	cuerda / cadena	Nombre del modelo (el nombre específico del editor) para filtrar los modelos
deploymentType	query	No		Tipo de implementación por la que filtrar la lista
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	PagedDeployment

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Implementaciones: obtener

GET {endpoint}/deployments/{name}?api-version=2025-11-15-preview

Obtener un modelo implementado.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre de la implementación
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Reglas de evaluación: lista

GET {endpoint}/evaluationrules?api-version=2025-11-15-preview

Enumerar todas las reglas de evaluación.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
actionType	query	No		Filtre por el tipo de regla de evaluación.
agentName	query	No	cuerda / cadena	Filtre por el nombre del agente.
habilitado	query	No	booleano	Filtre por el estado habilitado.
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	PagedEvaluationRule

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Reglas de evaluación: obtener

GET {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

Obtenga una regla de evaluación.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
id	ruta	Sí	cuerda / cadena	Identificador único de la regla de evaluación.
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	EvaluationRule

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Reglas de evaluación: eliminar

DELETE {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

Eliminar una regla de evaluación.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
id	ruta	Sí	cuerda / cadena	Identificador único de la regla de evaluación.
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

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	Tipo	Descripción
application/json	Azure.Core.Foundations.ErrorResponse

Reglas de evaluación: crear o actualizar

PUT {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

Cree o actualice una regla de evaluación.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
id	ruta	Sí	cuerda / cadena	Identificador único de la regla de evaluación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
acción	objeto	Modelo de acción de evaluación.	Sí
└─ Tipo	EvaluationRuleActionType	Tipo de acción de evaluación.	No
descripción	cuerda / cadena	Descripción de la regla de evaluación.	No
Nombre para mostrar	cuerda / cadena	Nombre para mostrar de la regla de evaluación.	No
habilitado	booleano	Indica si la regla de evaluación está habilitada. El valor predeterminado es true.	Sí
eventType	objeto	Tipo de evento de regla de evaluación.	Sí
filtro	objeto	Modelo de filtro de evaluación.	No
└] agentName	cuerda / cadena	Filtrar por nombre de agente.	No
id	cuerda / cadena	Identificador único de la regla de evaluación.	Sí
datos del sistema	objeto	Metadatos del sistema para la regla de evaluación.	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	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	Tipo	Descripción
application/json	EvaluationRule

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Taxonomías de evaluación: lista

GET {endpoint}/evaluationtaxonomies?api-version=2025-11-15-preview

Taxonomías de evaluación de listas

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
inputName	query	No	cuerda / cadena	Filtre por el nombre de entrada de evaluación.
inputType	query	No	cuerda / cadena	Filtrar por tipo de entrada de taxonomía.
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	PagedEvaluationTaxonomy

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Taxonomías de evaluación: obtener

GET {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	EvaluationTaxonomy

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Taxonomías de evaluación: eliminar

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

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	Tipo	Descripción
application/json	Azure.Core.Foundations.ErrorResponse

Taxonomías de evaluación: crear

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

Cree una taxonomía de evaluación.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre de la taxonomía de evaluación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Texto de descripción del recurso.	No
Propiedades	objeto	Propiedades adicionales para la taxonomía de evaluación.	No
tags	objeto	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
taxonomyCategories	array	Lista de categorías de taxonomía.	No
taxonomyInput	objeto	Configuración de entrada para la taxonomía de evaluación.	Sí
└─ Tipo	EvaluationTaxonomyInputType	Tipo de entrada de la taxonomía de evaluación.	No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	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	Tipo	Descripción
application/json	EvaluationTaxonomy

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Taxonomías de evaluación: actualización

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

Actualizar una taxonomía de evaluación.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre de la taxonomía de evaluación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Texto de descripción del recurso.	No
Propiedades	objeto	Propiedades adicionales para la taxonomía de evaluación.	No
tags	objeto	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
taxonomyCategories	array	Lista de categorías de taxonomía.	No
taxonomyInput	objeto	Configuración de entrada para la taxonomía de evaluación.	No
└─ Tipo	EvaluationTaxonomyInputType	Tipo de entrada de la taxonomía de evaluación.	No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	EvaluationTaxonomy

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Evaluadores: enumerar las versiones más recientes

GET {endpoint}/evaluators?api-version=2025-11-15-preview

Enumerar la última versión de cada evaluador

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
type	query	No		Filtrar evaluadores por tipo. Valores posibles: 'all', 'custom', 'builtin'.
limit	query	No	entero	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
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	PagedEvaluatorVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Evaluadores: enumerar versiones

GET {endpoint}/evaluators/{name}/versions?api-version=2025-11-15-preview

Enumerar todas las versiones del evaluador dado

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso
type	query	No		Filtrar evaluadores por tipo. Valores posibles: 'all', 'custom', 'builtin'.
limit	query	No	entero	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
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	PagedEvaluatorVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Evaluadores: creación de una versión

POST {endpoint}/evaluators/{name}/versions?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
categories	array	Las categorías del evaluador	Sí
definición	objeto	Configuración del evaluador base con discriminador	Sí
└" data_schema		El esquema JSON (Borrador 2020-12) para los datos de entrada del evaluador. Esto incluye parámetros como tipo, propiedades, obligatorio.	No
└" init_parameters		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 └	objeto	Lista de métricas de salida producidas por este evaluador	No
└─ Tipo	EvaluadorDefinitionType	El tipo de definición del evaluador	No
descripción	cuerda / cadena	Texto de descripción del recurso.	No
display_name	cuerda / cadena	Nombre para mostrar del evaluador. Ayuda a encontrar fácilmente el evaluador en Foundry. No es necesario que sea único.	No
evaluator_type	objeto	El tipo de evaluador	Sí
metadata	objeto	Metadatos sobre el evaluador	No
tags	objeto	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No

Respuestas

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	Tipo	Descripción
application/json	EvaluadorVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Evaluadores: obtener versión

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

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	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso
version	ruta	Sí	cuerda / cadena	Identificador de versión específico de EvaluadorVersion que se va a recuperar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	EvaluadorVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Evaluadores: eliminar versión

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

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	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso
version	ruta	Sí	cuerda / cadena	Versión de EvaluadorVersion que se va a eliminar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

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	Tipo	Descripción
application/json	Azure.Core.Foundations.ErrorResponse

Evaluadores: versión de actualización

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso
version	ruta	Sí	cuerda / cadena	Versión de EvaluadorVersion que se va a actualizar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
categories	array	Las categorías del evaluador	No
descripción	cuerda / cadena	Texto de descripción del recurso.	No
display_name	cuerda / cadena	Nombre para mostrar del evaluador. Ayuda a encontrar fácilmente el evaluador en Foundry. No es necesario que sea único.	No
metadata	objeto	Metadatos sobre el evaluador	No
tags	objeto	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	EvaluadorVersion

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Índices: enumeración más reciente

GET {endpoint}/indexes?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	PagedIndex

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Índices: enumerar versiones

GET {endpoint}/indexes/{name}/versions?api-version=2025-11-15-preview

Enumerar todas las versiones del índice dado

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	PagedIndex

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Índices: obtener versión

GET {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso
version	ruta	Sí	cuerda / cadena	El identificador de versión específico del índice que se va a recuperar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Índices: eliminar versión

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso
version	ruta	Sí	cuerda / cadena	La versión del índice que se va a eliminar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

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	Tipo	Descripción
application/json	Azure.Core.Foundations.ErrorResponse

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

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

Cree un nuevo índice o actualice uno existente con el identificador de versión especificado

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del recurso
version	ruta	Sí	cuerda / cadena	El identificador de versión específico del índice que se va a crear o actualizar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/merge-patch+json

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Texto de descripción del recurso.	No
tags	objeto	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
type	objeto		Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	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	Tipo	Descripción
application/json	Índice

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Conclusiones: generación

POST {endpoint}/insights?api-version=2025-11-15-preview

Generar información

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
Repetibilidad:Request-ID	encabezado	No	cuerda / cadena	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	encabezado	No	cuerda / cadena	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.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
Nombre para mostrar	cuerda / cadena	Nombre para mostrar descriptivo de la información.	Sí
id	cuerda / cadena	El identificador único del informe de estadísticas.	Sí
metadata	objeto	Metadatos sobre la información.	Sí
└— completedAt	cuerda / cadena	La marca de tiempo en la que se completaron las estadísticas.	No
└— createdAt	cuerda / cadena	La marca de tiempo en la que se crearon las estadísticas.	No
request	objeto	La solicitud del informe de información.	Sí
└─ Tipo	InsightType	Tipo de solicitud.	No
resultado	objeto	El resultado de las ideas.	No
└─ Tipo	InsightType	El tipo de resultado de la información.	No
estado	objeto	Enumeración que describe los estados de operación permitidos.	Sí

Respuestas

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	Tipo	Descripción
application/json	Visión

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Conclusiones: lista

GET {endpoint}/insights?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
type	query	No		Filtrar por tipo de análisis.
evalId	query	No	cuerda / cadena	Filtre por el ID de evaluación.
runId	query	No	cuerda / cadena	Filtre por el identificador de ejecución de evaluación.
agentName	query	No	cuerda / cadena	Filtre por el nombre del agente.
includeCoordinates	query	No	booleano	Si se deben incluir coordenadas para la visualización en la respuesta. El valor predeterminado es False.
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	PagedInsight

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Conclusiones: obtener

GET {endpoint}/insights/{id}?api-version=2025-11-15-preview

Obtenga una visión específica por identificación.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
id	ruta	Sí	cuerda / cadena	El identificador único del informe de estadísticas.
includeCoordinates	query	No	booleano	Si se deben incluir coordenadas para la visualización en la respuesta. El valor predeterminado es False.
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	Visión

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Creación de un almacén de memoria

POST {endpoint}/memory_stores?api-version=2025-11-15-preview

Cree un almacén de memoria.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
definición	objeto	Definición base para configuraciones de almacén de memoria.	Sí
└└ kind	MemoryStoreKind	El tipo de almacén de memoria.	No
descripción	cuerda / cadena	Una descripción legible por humanos del almacén de memoria.	No
metadata	objeto	Metadatos de clave-valor arbitrarios para asociar con el almacén de memoria.	No
nombre	cuerda / cadena	El nombre del almacén de memoria.	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	MemoryStoreObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Enumerar almacenes de memoria

GET {endpoint}/memory_stores?api-version=2025-11-15-preview

Enumerar todos los almacenes de memoria.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
limit	query	No	entero	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	cuerda / cadena Valores posibles: `asc`, `desc`	Criterio de ordenación por la `created_at` marca de tiempo de los objetos. `asc` para orden ascendente y`desc` para orden descendente.
after	query	No	cuerda / cadena	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	cuerda / cadena	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.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	objeto	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	Tipo	Descripción
application/json	ApiErrorResponse

Actualizar el almacén de memoria

POST {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

Actualizar un almacén de memoria.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del almacén de memoria que se va a actualizar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
descripción	cuerda / cadena	Una descripción legible por humanos del almacén de memoria.	No
metadata	objeto	Metadatos de clave-valor arbitrarios para asociar con el almacén de memoria.	No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	MemoryStoreObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Obtención del almacén de memoria

GET {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

Recuperar un almacén de memoria.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del almacén de memoria que se va a recuperar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	MemoryStoreObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Eliminación del almacén de memoria

DELETE {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

Eliminar un almacén de memoria.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del almacén de memoria que se va a eliminar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	DeleteMemoryStoreResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Obtención del resultado de la actualización

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	El nombre del almacén de memoria.
update_id	ruta	Sí	cuerda / cadena	Identificador de la operación de actualización de memoria.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	MemoryStoreUpdateResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Eliminar memorias de ámbito

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	El nombre del almacén de memoria.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

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

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	MemoryStoreDeleteScopeResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Memorias de búsqueda

POST {endpoint}/memory_stores/{name}:search_memories?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del almacén de memoria que se va a buscar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
items	array	Elementos para buscar recuerdos relevantes.	No
options	objeto	Opciones de búsqueda de memoria.	No
└" max_memories	entero	Número máximo de elementos de memoria que se van a devolver.	No
previous_search_id	cuerda / cadena	El identificador único de la solicitud de búsqueda anterior, lo que permite la búsqueda de memoria incremental desde donde se detuvo la última operación.	No
scope	cuerda / cadena	El espacio de nombres que agrupa y aísla lógicamente las memorias, como un ID de usuario.	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	MemoryStoreSearchResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Actualizar memorias

POST {endpoint}/memory_stores/{name}:update_memories?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Nombre del almacén de memoria que se va a actualizar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
items	array	Elementos de conversación de los que extraer recuerdos.	No
previous_update_id	cuerda / cadena	El identificador único de la solicitud de actualización anterior, lo que permite actualizaciones de memoria incrementales desde donde se detuvo la última operación.	No
scope	cuerda / cadena	El espacio de nombres que agrupa y aísla lógicamente las memorias, como un ID de usuario.	Sí
update_delay	entero	Período de 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 activar inmediatamente la actualización sin demora. El valor predeterminado es 300 (5 minutos).	No	300

Respuestas

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	Tipo	Descripción
application/json	MemoryStoreUpdateResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Crear conversación

POST {endpoint}/openai/conversations?api-version=2025-11-15-preview

Cree una conversación.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
items	array	Elementos iniciales para incluir el contexto de conversación. Puede agregar hasta 20 elementos a la vez.	No
metadata	objeto	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

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Enumerar conversaciones

GET {endpoint}/openai/conversations?api-version=2025-11-15-preview

Devuelve la lista de todas las conversaciones.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
limit	query	No	entero	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	cuerda / cadena Valores posibles: `asc`, `desc`	Criterio de ordenación por la `created_at` marca de tiempo de los objetos. `asc` para orden ascendente y`desc` para orden descendente.
after	query	No	cuerda / cadena	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	cuerda / cadena	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	cuerda / cadena	Filtrar por nombre de agente. Si se proporciona, solo se devolverán los elementos asociados al agente especificado.
agent_id	query	No	cuerda / cadena	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.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	objeto	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	Tipo	Descripción
application/json	ApiErrorResponse

Actualizar conversación

POST {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

Actualizar una conversación.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
conversation_id	ruta	Sí	cuerda / cadena	Identificador de la conversación que se va a actualizar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadata	objeto	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

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Obtener conversación

GET {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

Recupera una conversación.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
conversation_id	ruta	Sí	cuerda / cadena	Identificador de la conversación que se va a recuperar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Eliminar conversación

DELETE {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

Elimina una conversación.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
conversation_id	ruta	Sí	cuerda / cadena	Identificador de la conversación que se va a eliminar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Crear elementos de conversación

POST {endpoint}/openai/conversations/{conversation_id}/items?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
conversation_id	ruta	Sí	cuerda / cadena	Identificador de la conversación en la que se debe crear el elemento.
incluir	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.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

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

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Enumerar elementos de conversación

GET {endpoint}/openai/conversations/{conversation_id}/items?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
conversation_id	ruta	Sí	cuerda / cadena	Identificador de la conversación en la que deben aparecer los elementos.
limit	query	No	entero	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	cuerda / cadena Valores posibles: `asc`, `desc`	Criterio de ordenación por la `created_at` marca de tiempo de los objetos. `asc` para orden ascendente y`desc` para orden descendente.
after	query	No	cuerda / cadena	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	cuerda / cadena	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		Filtre por tipo de elemento. Si se proporciona, solo se devolverán los elementos del tipo especificado.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	objeto	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	Tipo	Descripción
application/json	ApiErrorResponse

Obtener elemento de conversación

GET {endpoint}/openai/conversations/{conversation_id}/items/{item_id}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
conversation_id	ruta	Sí	cuerda / cadena	Identificador de la conversación que contiene el elemento.
item_id	ruta	Sí	cuerda / cadena	Identificador del elemento de conversación que se va a recuperar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.ItemResource

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Eliminar elemento de conversación

DELETE {endpoint}/openai/conversations/{conversation_id}/items/{item_id}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
conversation_id	ruta	Sí	cuerda / cadena	Identificador de la conversación en la que se debe eliminar el elemento.
item_id	ruta	Sí	cuerda / cadena	Identificador del elemento de conversación que se va a eliminar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Valores de OpenAI: valores de lista

GET {endpoint}/openai/evals?api-version=2025-11-15-preview

Enumera todas las evaluaciones Enumerar las evaluaciones de un proyecto.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
after	query	No	cuerda / cadena	Identificador de la última ejecución de la solicitud de paginación anterior.
limit	query	No		Número de ejecuciones que se van a recuperar.
order	query	No	cuerda / cadena 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	cuerda / cadena 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.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	objeto	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	Tipo	Descripción
application/json	ApiErrorResponse

Valores de OpenAI: creación de eval

POST {endpoint}/openai/evals?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
configuración_de_fuente_de_datos	objeto	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 se requieren al crear una ejecución?	Sí
└─ incluir_esquema_de_muestra	booleano	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
└" item_schema	objeto	Esquema json para cada fila del origen de datos.	No
Metadatos └	objeto	Filtros de metadatos para el origen de datos de finalizaciones almacenadas.	No
Escenario └	enum	Escenario de esquema de datos. Valores posibles: `red_team`, `responses`, `traces`	No
└─ Tipo	enum	Tipo de objeto, que siempre es `label_model`. Valores posibles: `azure_ai_source`	No
metadata	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.	No
nombre	cuerda / cadena	Nombre de la evaluación.	No
Propiedades	objeto	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	array	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, como `{{item.variable_name}}`. Para hacer referencia a la salida del modelo, use el espacio de nombres `sample` (es decir, `{{sample.output_text}}`).	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	Eval

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Valores de OpenAI: eliminación de eval

DELETE {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

Eliminar una evaluación Eliminar una evaluación.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
eval_id	ruta	Sí	cuerda / cadena	Identificador de la evaluación que se va a eliminar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	DeleteEvalResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Evals de OpenAI: obtención de eval

GET {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
eval_id	ruta	Sí	cuerda / cadena	Identificador de la evaluación que se va a recuperar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	Eval

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Valores de OpenAI: actualización de eval

POST {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
eval_id	ruta	Sí	cuerda / cadena	Identificador de la evaluación que se va a actualizar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
metadata	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.	No
nombre	cuerda / cadena		No
Propiedades	objeto	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

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	Eval

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Valores de OpenAI: enumeración de ejecuciones

GET {endpoint}/openai/evals/{eval_id}/runs?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
eval_id	ruta	Sí	cuerda / cadena	Identificador de la evaluación para la que se van a recuperar las ejecuciones.
after	query	No	cuerda / cadena	Identificador de la última ejecución de la solicitud de paginación anterior.
limit	query	No		Número de ejecuciones que se van a recuperar.
order	query	No	cuerda / cadena 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`.
estado	query	No	cuerda / cadena Valores posibles: `queued`, `in_progress`, `completed`, `canceled`, `failed` . Filtrar ejecuciones por estado. Uno de `queued`, `in_progress`, `failed`, `completed`, `canceled`.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	objeto	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	Tipo	Descripción
application/json	ApiErrorResponse

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

POST {endpoint}/openai/evals/{eval_id}/runs?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
eval_id	ruta	Sí	cuerda / cadena	Identificador de la evaluación para la que se va a crear una ejecución.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
fuente_de_datos	objeto	Un objeto JsonlRunDataSource que especifica un archivo JSONL que coincide con la evaluación.	Sí
└─ 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
└" item_generation_params	RedTeamItemGenerationParams	Parámetros para la generación de elementos.	No
└─ modelo	cuerda / cadena	Nombre del modelo que se va a usar para generar finalizaciones (por ejemplo, "o3-mini").	No
└─ parámetros_de_muestreo	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		No
└─ Origen	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.	No
Destino └	Destino	Configuración de destino para la evaluación.	No
└─ Tipo	cuerda / cadena	El discriminador del tipo de origen de datos.	No
metadata	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.	No
nombre	cuerda / cadena	Nombre de la ejecución.	No
Propiedades	objeto	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

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	EvalRun

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Valores de OpenAI: eliminación de la ejecución de eval

DELETE {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
eval_id	ruta	Sí	cuerda / cadena	Identificador de la evaluación de la que se va a eliminar la ejecución.
identificador_de_ejecución	ruta	Sí	cuerda / cadena	Identificador de la ejecución que se va a eliminar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	DeleteEvalRunResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

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

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
eval_id	ruta	Sí	cuerda / cadena	Identificador de la evaluación para la que se van a recuperar las ejecuciones.
identificador_de_ejecución	ruta	Sí	cuerda / cadena	Identificador de la ejecución que se va a recuperar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	EvalRun

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Valores de OpenAI: cancelación de la ejecución de eval

POST {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
eval_id	ruta	Sí	cuerda / cadena	Identificador de la evaluación cuya ejecución desea cancelar.
identificador_de_ejecución	ruta	Sí	cuerda / cadena	Identificador de la ejecución que se va a cancelar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	EvalRun

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Evals de OpenAI: obtención de elementos de salida de ejecución de eval

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}/output_items?api-version=2025-11-15-preview

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	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
eval_id	ruta	Sí	cuerda / cadena
identificador_de_ejecución	ruta	Sí	cuerda / cadena	Identificador de la ejecución para la que se van a recuperar los elementos de salida.
after	query	No	cuerda / cadena	Identificador de la última ejecución de la solicitud de paginación anterior.
limit	query	No		Número de ejecuciones que se van a recuperar.
order	query	No	cuerda / cadena 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`.
estado	query	No	cuerda / cadena 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.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	objeto	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	Tipo	Descripción
application/json	ApiErrorResponse

Valores de OpenAI: obtener el elemento de salida de ejecución de eval

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=2025-11-15-preview

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	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
eval_id	ruta	Sí	cuerda / cadena	Identificador de la evaluación para la que se van a recuperar las ejecuciones.
identificador_de_ejecución	ruta	Sí	cuerda / cadena	Identificador de la ejecución que se va a recuperar.
output_item_id	ruta	Sí	cuerda / cadena	Identificador del elemento de salida que se va a recuperar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	EvalRunOutputItem

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Creación de un trabajo de ajuste preciso

POST {endpoint}/openai/fine-tuning/jobs?api-version=2025-11-15-preview

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.

Más información sobre el ajuste preciso

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
hiperparámetros	objeto	Hiperparámetros usados para el trabajo de ajuste preciso. Este valor ahora está en desuso en favor de `method` y debe pasarse bajo el parámetro `method`.	No
└─ batch_size	enum	Valores posibles: `auto`	No
"└─ learning_rate_multiplier"	enum	Valores posibles: `auto`	No
├─ n_epochs	enum	Valores posibles: `auto`	No
Integraciones	array	Lista de integraciones que se habilitarán para el trabajo de ajuste preciso.	No
metadata	objeto	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
modelo	string (consulte los modelos válidos a continuación)	Nombre del modelo que se va a ajustar. Puede seleccionar uno de los modelos admitidos.	Sí
seed	entero	La semilla controla la reproducibilidad del trabajo. Pasar los mismos parámetros de inicialización y trabajo debe generar los mismos resultados, pero puede diferir en raras ocasiones. Si no se especifica una semilla, se generará una para ti.	No
sufijo	cuerda / cadena	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`.	No	Ninguno
archivo_de_entrenamiento	cuerda / cadena	El Id. de un archivo cargado que contiene datos de entrenamiento. El conjunto de datos debe tener el formato de un archivo JSONL. Además, debe cargar su archivo con el propósito de `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. Consulte la guía de ajuste para obtener más detalles.	Sí
archivo_de_validación	cuerda / cadena	El Id. de un archivo cargado que contenga datos de validación. Si proporciona este archivo, los datos se usan para generar las métricas de validación 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 de un archivo JSONL. Debe cargar el archivo con el propósito `fine-tune`. Consulte la guía de ajuste para obtener más detalles.	No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Enumeración de trabajos de ajuste paginado

GET {endpoint}/openai/fine-tuning/jobs?api-version=2025-11-15-preview

Enumerar los trabajos de ajuste preciso de la organización

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
after	query	No	cuerda / cadena	Identificador del último trabajo de la solicitud de paginación anterior.
limit	query	No	entero	Número de trabajos de ajuste preciso que se van a recuperar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Recuperación del trabajo de ajuste preciso

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}?api-version=2025-11-15-preview

Obtenga información sobre un trabajo de ajuste preciso.

Más información sobre el ajuste preciso

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
fine_tuning_job_id	ruta	Sí	cuerda / cadena	Identificador del trabajo de ajuste.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Cancelación del trabajo de ajuste correcto

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/cancel?api-version=2025-11-15-preview

Cancele inmediatamente un trabajo de ajuste.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
fine_tuning_job_id	ruta	Sí	cuerda / cadena	Identificador del trabajo de ajuste que se va a cancelar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

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

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
fine_tuning_job_id	ruta	Sí	cuerda / cadena	Identificador del trabajo de ajuste preciso para el que se van a obtener puntos de comprobación.
after	query	No	cuerda / cadena	Identificador del último id. de punto de comprobación de la solicitud de paginación anterior.
limit	query	No	entero	Número de puntos de comprobación que se van a recuperar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Enumeración de eventos de trabajo de ajuste correcto

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/events?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
fine_tuning_job_id	ruta	Sí	cuerda / cadena	Identificador del trabajo de ajuste preciso para el que se van a obtener eventos.
after	query	No	cuerda / cadena	Identificador del último evento de la solicitud de paginación anterior.
limit	query	No	entero	Número de eventos que se van a recuperar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Pausar el trabajo de ajuste correcto

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/pause?api-version=2025-11-15-preview

Pausar un trabajo de ajuste correcto en ejecución.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
fine_tuning_job_id	ruta	Sí	cuerda / cadena	Identificador del trabajo de ajuste preciso que se va a pausar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Reanudación del trabajo de ajuste correcto

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/resume?api-version=2025-11-15-preview

Reanude un trabajo de ajuste en pausa.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
fine_tuning_job_id	ruta	Sí	cuerda / cadena	Identificador del trabajo de ajuste preciso que se va a reanudar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

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

POST {endpoint}/openai/responses?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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	No	cuerda / cadena	Versión de API que se usará para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent	AgentReference	Agente que se va a usar para generar la respuesta.	No
background	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano. Obtenga más información sobre las respuestas en segundo plano.	No	Falso
conversación	cadena o objeto		No
incluir	array	Especifique datos de salida adicionales que se incluirán en la respuesta del modelo. Actualmente Los valores admitidos son: - `code_interpreter_call.outputs`: incluye las salidas de la ejecución de código de Python en elementos de llamada de 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 . llamada a la herramienta de búsqueda de archivos. - `message.input_image.image_url`: incluya las URL de las imágenes del mensaje de entrada. - `message.output_text.logprobs`: incluya logprobs con mensajes de asistente. - `reasoning.encrypted_content`: incluye una versión cifrada de razonamiento tokens en salidas de elemento de razonamiento. Esto permite usar elementos de razonamiento en conversaciones multiturno al usar la API de respuestas sin estado (por ejemplo, cuando el `store` parámetro se establece en `false`, o cuando una organización es inscrito en el programa de retención de datos cero).	No
entrada	cadena o matriz	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 - Administración del estado de conversación - Llamada a funciones	No
instructions	cuerda / cadena	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Cuando se usa junto con `previous_response_id`, las instrucciones de un elemento anterior la respuesta no se transferirá a la siguiente respuesta. Esto hace que sea sencillo para intercambiar mensajes del sistema (o desarrollador) en nuevas respuestas.	No
max_output_tokens	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
max_tool_calls	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
metadata	objeto	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	cuerda / cadena	Implementación del modelo que se va a usar para la creación de esta respuesta.	No
parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	No	Cierto
previous_response_id	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno. Más información sobre administrar el estado de la conversación.	No
inmediato	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Más información.	No
reasoning	OpenAI.Reasoning	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
nivel de servicio	OpenAI.ServiceTier	Nota: service_tier no es aplicable a Azure OpenAI.	No
store	booleano	Si se va a almacenar la respuesta del modelo generada para su recuperación posterior a través de API.	No	Cierto
flujo	booleano	Si se establece en true, los datos de respuesta del modelo se transmitirán al cliente. ya que se genera mediante eventos enviados por el servidor. para más información.	No	Falso
structured_inputs	objeto	Entradas estructuradas para la respuesta que pueden participar en enlaces de argumentos de herramienta o sustitución de plantillas de solicitud.	No
temperatura	número	Temperatura de muestreo que se vaya 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, recomendamos modificar esto o `top_p`, pero no ambos.	No	1
texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados. Consulte Entradas y salidas de texto. y salidas estructuradas	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
tool_choice	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda de archivos. - Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, habilitando el modelo para llamar a su propio código.	No
top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	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, recomendamos modificar esto o `temperature`, pero no ambos.	No	1
truncation	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - `auto`: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará el respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en en medio de la conversación. - `disabled` (valor predeterminado): si una respuesta del modelo superará la ventana de contexto el tamaño de un modelo, la solicitud producirá un error 400. Valores posibles: `auto`, `disabled`	No
user	cuerda / cadena	Obtenga más información sobre los procedimientos recomendados de seguridad.	No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Enumerar respuestas

GET {endpoint}/openai/responses?api-version=2025-11-15-preview

Devuelve la lista de todas las respuestas.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
limit	query	No	entero	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	cuerda / cadena Valores posibles: `asc`, `desc`	Criterio de ordenación por la `created_at` marca de tiempo de los objetos. `asc` para orden ascendente y`desc` para orden descendente.
after	query	No	cuerda / cadena	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	cuerda / cadena	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	cuerda / cadena	Filtrar por nombre de agente. Si se proporciona, solo se devolverán los elementos asociados al agente especificado.
agent_id	query	No	cuerda / cadena	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	cuerda / cadena	Filtre por identificador de conversación. Si se proporciona, solo se devolverán las respuestas asociadas a la conversación especificada.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	objeto	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	Tipo	Descripción
application/json	ApiErrorResponse

Obtener respuesta: obtener flujo de respuesta

GET {endpoint}/openai/responses/{response_id}?api-version=2025-11-15-preview

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	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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	No	cuerda / cadena	Versión de API que se usará para esta operación.
response_id	ruta	Sí	cuerda / cadena
include[]	query	No	array
flujo	query	No	booleano
starting_after	query	No	entero
aceptar	encabezado	No	cuerda / cadena Valores posibles: `text/event-stream`

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Eliminar respuesta

DELETE {endpoint}/openai/responses/{response_id}?api-version=2025-11-15-preview

Elimina una respuesta de modelo.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
response_id	ruta	Sí	cuerda / cadena	Identificador de la respuesta que se va a eliminar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	DeleteResponseResult

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Cancelar respuesta

POST {endpoint}/openai/responses/{response_id}/cancel?api-version=2025-11-15-preview

Cancela una respuesta de modelo.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
response_id	ruta	Sí	cuerda / cadena	Identificador de la respuesta que se va a cancelar.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

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

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	ApiErrorResponse

Enumerar elementos de entrada

GET {endpoint}/openai/responses/{response_id}/input_items?api-version=2025-11-15-preview

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
response_id	ruta	Sí	cuerda / cadena
limit	query	No	entero	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	cuerda / cadena Valores posibles: `asc`, `desc`	Criterio de ordenación por la `created_at` marca de tiempo de los objetos. `asc` para orden ascendente y`desc` para orden descendente.
after	query	No	cuerda / cadena	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	cuerda / cadena	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.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	objeto	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	Tipo	Descripción
application/json	ApiErrorResponse

Redteams: lista

GET {endpoint}/redTeams/runs?api-version=2025-11-15-preview

Enumera un equipo rojo por su nombre.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	PagedRedTeam

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Redteams - get

GET {endpoint}/redTeams/runs/{name}?api-version=2025-11-15-preview

Consigue un redteam por su nombre.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
nombre	ruta	Sí	cuerda / cadena	Identificador de la carrera del equipo rojo.
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	RedTeam

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Redteams: creación

POST {endpoint}/redTeams/runs:run?api-version=2025-11-15-preview

Crea una carrera de redteam.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
applicationScenario	cuerda / cadena	Escenario de aplicación para la operación del equipo rojo, para generar ataques específicos del escenario.	No
attackStrategies	array	Lista de estrategias de ataque o listas anidadas de estrategias de ataque.	No
Nombre para mostrar	cuerda / cadena	Nombre de la carrera del equipo rojo.	No
id	cuerda / cadena	Identificador de la carrera del equipo rojo.	Sí
numTurns	entero	Número de rondas de simulación.	No
Propiedades	objeto	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	array	Lista de categorías de riesgo para las que generar objetivos de ataque.	No
simulationOnly	booleano	Solo Simulación o Simulación + Evaluación. Predeterminado false, si es true, el escaneo genera una conversación, no el resultado de la evaluación.	No	Falso
estado	cuerda / cadena	Estatus del equipo rojo. Lo establece el servicio y es de solo lectura.	No
tags	objeto	Etiquetas del equipo rojo. A diferencia de las propiedades, las etiquetas son completamente mutables.	No
target	objeto	Clase abstracta para la configuración de destino.	Sí
└─ Tipo	cuerda / cadena	Tipo de configuración del modelo.	No

Respuestas

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	Tipo	Descripción
application/json	RedTeam

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Programaciones: lista

GET {endpoint}/schedules?api-version=2025-11-15-preview

Enumere todos los horarios.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	PagedSchedule

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Programaciones: eliminar

DELETE {endpoint}/schedules/{id}?api-version=2025-11-15-preview

Permite eliminar una programación.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
id	ruta	Sí	cuerda / cadena	Identificador del horario.
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

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	Tipo	Descripción
application/json	Azure.Core.Foundations.ErrorResponse

Programaciones: obtener

GET {endpoint}/schedules/{id}?api-version=2025-11-15-preview

Obtener un horario por identificación.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
id	ruta	Sí	cuerda / cadena	Identificador del horario.
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	Schedule

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Programaciones: creación o actualización

PUT {endpoint}/schedules/{id}?api-version=2025-11-15-preview

Crear o actualizar una programación por id.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
id	ruta	Sí	cuerda / cadena	Identificador del horario.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Descripción de la programación.	No
Nombre para mostrar	cuerda / cadena	Nombre de la programación.	No
habilitado	booleano	Estado habilitado del horario.	Sí
id	cuerda / cadena	Identificador del horario.	Sí
Propiedades	objeto	Schedule. A diferencia de las etiquetas, las propiedades son de solo complemento. Una vez agregado, no se puede quitar una propiedad.	No
provisioningStatus	objeto	Programar el estado de aprovisionamiento.	No
datos del sistema	objeto	Metadatos del sistema para el recurso.	Sí
tags	objeto	Etiquetas de programación. A diferencia de las propiedades, las etiquetas son completamente mutables.	No
task	objeto	Modelo de tareas de programación.	Sí
Configuración de └	objeto	Configuración de la tarea.	No
└─ Tipo	ScheduleTaskType	Tipo de la tarea.	No
trigger	objeto	Modelo base para el Disparador del horario.	Sí
└─ Tipo	Tipo de desencadenante	Tipo de desencadenante.	No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	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	Tipo	Descripción
application/json	Schedule

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Programaciones: enumeración de ejecuciones

GET {endpoint}/schedules/{id}/runs?api-version=2025-11-15-preview

Enumere todas las ejecuciones programadas.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
id	ruta	Sí	cuerda / cadena	Identificador del horario.
x-ms-client-request-id	encabezado	No		Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	PagedScheduleRun

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Programaciones: obtener ejecución

GET {endpoint}/schedules/{scheduleId}/runs/{runId}?api-version=2025-11-15-preview

Obtener un cronograma ejecutado por id.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Punto de conexión de Proyecto de foundry con el formato `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`. Si solo tiene un proyecto en foundry Hub o para tener como destino el proyecto 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í	cuerda / cadena	Versión de API que se usará para esta operación.
scheduleId	ruta	Sí	cuerda / cadena	Identificador del horario.
runId	ruta	Sí	cuerda / cadena	Identificador de la ejecución programada.

Encabezado de solicitud

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` Para generar un token de autenticación mediante la CLI de Azure: `az account get-access-token --resource https://ai.azure.com/` Tipo: oauth2 Dirección URL de autorización: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` ámbito: `https://ai.azure.com/.default`

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	ScheduleRun

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

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

Componentes

A2ATool

Un agente que implementa el protocolo A2A.

Nombre	Tipo	Description	Obligatorio
agent_card_path	cuerda / cadena	La ruta a la tarjeta de agente en relación con el `base_url`archivo . Si no se proporciona, el valor predeterminado es `/.well-known/agent-card.json`	No
base_url	cuerda / cadena	URL base del agente.	No
project_connection_id	cuerda / cadena	El ID de conexión en el proyecto para el 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`. Valores posibles: `a2a_preview`	Sí

AISearchIndexResource

Un recurso de AI Search Index.

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

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	El tipo de resultado de la información. Valores posibles: `AgentClusterInsight`	Sí

AgentClusterInsightsRequest

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

Nombre	Tipo	Description	Obligatorio
agentName	cuerda / cadena	Identificador del agente.	Sí
modelConfiguration	objeto	Configuración del modelo utilizado en la generación de información.	No
└] modelDeploymentName	cuerda / cadena	La 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>`.	No
type	enum	Tipo de solicitud. Valores posibles: `AgentClusterInsight`	Sí

AgentContainerObject

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

Nombre	Tipo	Description	Obligatorio
fecha_de_creación	cuerda / cadena	Hora de creación del contenedor.	Sí
error_message	cuerda / cadena	Mensaje de error si el contenedor no pudo funcionar, si existe.	No
max_replicas	entero	Número máximo de réplicas para el contenedor. El valor predeterminado es 1.	No
min_replicas	entero	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	objeto	Estado del contenedor de una versión específica de un agente.	Sí
updated_at	cuerda / cadena	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
código	cuerda / cadena	Código de error de la operación de contenedor, si existe.	Sí
Mensaje	cuerda / cadena	Mensaje de error de la operación de contenedor, si existe.	Sí
type	cuerda / cadena	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
agent_id	cuerda / cadena	Id. del agente.	Sí
agent_version_id	cuerda / cadena	Identificador de la versión del agente.	Sí
container	objeto	Detalles del contenedor de una versión específica de un agente.	No
└─ created_at	cuerda / cadena	Hora de creación del contenedor.	No
└" error_message	cuerda / cadena	Mensaje de error si el contenedor no pudo funcionar, si existe.	No
└" max_replicas	entero	Número máximo de réplicas para el contenedor. El valor predeterminado es 1.	No
└" min_replicas	entero	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`	No
└─ estado	AgentContainerStatus	Estado del contenedor de una versión específica de un agente.	No
└" updated_at	cuerda / cadena	Hora de la última actualización del contenedor.	No
error	objeto	Detalles del error de la operación de contenedor, si existe.	No
└─ código	cuerda / cadena	Código de error de la operación de contenedor, si existe.	No
└─ Mensaje	cuerda / cadena	Mensaje de error de la operación de contenedor, si existe.	No
└─ Tipo	cuerda / cadena	Tipo de error de la operación de contenedor, si existe.	No
id	cuerda / cadena	Identificador de la operación de contenedor. Este identificador es un identificador único en todo el sistema.	Sí
estado	objeto	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	Importancia
Descripción	Estado de la operación de contenedor para una versión específica de un agente.
Tipo	cuerda / cadena
Valores	`NotStarted` `InProgress` `Succeeded` `Failed`

AgentContainerStatus

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

Propiedad	Importancia
Descripción	Estado del contenedor de una versión específica de un agente.
Tipo	cuerda / cadena
Valores	`Starting` `Running` `Stopping` `Stopped` `Failed` `Deleting` `Deleted` `Updating`

AgentDefinition

Discriminador para AgentDefinition

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

Valor del tipo	Schema
`workflow`	WorkflowAgentDefinition
`hosted`	HostedAgentDefinition
`container_app`	ContainerAppAgentDefinition
`prompt`	PromptAgentDefinition

Nombre	Tipo	Description	Obligatorio
amable	AgentKind		Sí
rai_config	objeto	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
└" rai_policy_name	cuerda / cadena	El nombre de la política de RAI que se va a aplicar.	No

AgentId

Nombre	Tipo	Description	Obligatorio
nombre	cuerda / cadena	Nombre del agente.	Sí
type	enum	Valores posibles: `agent_id`	Sí
version	cuerda / cadena	Identificador de versión del agente.	Sí

AgentKind

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	`prompt` `hosted` `container_app` `workflow`

AgentObject

Nombre	Tipo	Description	Obligatorio
id	cuerda / cadena	Identificador único del agente.	Sí
nombre	cuerda / cadena	Nombre del agente.	Sí
objeto	enum	El tipo de objeto, que siempre es 'agente'. Valores posibles: `agent`	Sí
versions	objeto	La versión más reciente del agente.	Sí
└— más reciente	AgentVersionObject		No

AgentProtocol

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	`activity_protocol` `responses`

Referencia del agente

Nombre	Tipo	Description	Obligatorio
nombre	cuerda / cadena	Nombre del agente.	Sí
type	enum	Valores posibles: `agent_reference`	Sí
version	cuerda / cadena	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
riskCategories	array	Lista de categorías de riesgo para evaluar.	Sí
target	objeto	Representa un destino que especifica un agente de Azure AI.	Sí
└─ Nombre	cuerda / cadena	Identificador único del agente de Azure AI.	No
└" tool_descriptions	array	Los parámetros utilizados para controlar el comportamiento de muestreo del agente durante la generación de texto.	No
└─ Tipo	enum	El tipo de objetivo, siempre `azure_ai_agent`. Valores posibles: `azure_ai_agent`	No
└─ versión	cuerda / cadena	La versión del agente de Azure AI.	No
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
riskCategories	array	Lista de categorías de riesgo para evaluar.	No
target	objeto	Representa un destino que especifica un agente de Azure AI.	No
└─ Nombre	cuerda / cadena	Identificador único del agente de Azure AI.	No
└" tool_descriptions	array	Los parámetros utilizados para controlar el comportamiento de muestreo del agente durante la generación de texto.	No
└─ Tipo	enum	El tipo de objetivo, siempre `azure_ai_agent`. Valores posibles: `azure_ai_agent`	No
└─ versión	cuerda / cadena	La versión del agente de Azure AI.	No
type	enum	Tipo de entrada de la taxonomía de evaluación. Valores posibles: `agent`	No

AgentVersionObject

Nombre	Tipo	Description	Obligatorio
fecha_de_creación	entero	La marca de tiempo de Unix (segundos) cuando se creó el agente.	Sí
definición	AgentDefinition		Sí
descripción	cuerda / cadena	Descripción legible del agente.	No
id	cuerda / cadena	Identificador único de la versión del agente.	Sí
metadata	objeto	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	cuerda / cadena	Nombre del agente. Name se puede usar para recuperar/actualizar/eliminar el agente.	Sí
objeto	enum	El tipo de objeto, que siempre es 'agent.version'. Valores posibles: `agent.version`	Sí
version	cuerda / cadena	Identificador de versión del agente. Los agentes son inmutables y cada actualización crea una nueva versión manteniendo el mismo nombre.	Sí

AgenticIdentityCredentials

Definición de credenciales de identidad agencial

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de credencial Valores posibles: `AgenticIdentityToken`	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	cuerda / cadena	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
blobReference	objeto	Detalles de referencia de blobs.	Sí
└— blobUri	cuerda / cadena	Ruta de acceso del URI del blob para que el cliente cargue datos. Ejemplo: `https://blob.windows.core.net/Container/Path`	No
Credencial de └	SasCredential	Información de credenciales para acceder a la cuenta de almacenamiento.	No
└] storageAccountArmId	cuerda / cadena	Id. de ARM de la cuenta de almacenamiento que se va a usar.	No

Identificador de activo

Identificador de un recurso guardado.

Tipo: string

AttackStrategy

Estrategias para los ataques.

Propiedad	Importancia
Descripción	Estrategias para los ataques.
Tipo	cuerda / cadena
Valores	`easy` `moderate` `difficult` `ascii_art` `ascii_smuggler` `atbash` `base64` `binary` `caesar` `character_space` `jailbreak` `ansii_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
código	cuerda / cadena	Uno de un conjunto definido por el servidor de códigos de error.	Sí
details	array	Matriz de detalles sobre errores específicos que llevaron a este error notificado.	No
innererror	objeto	Objeto que contiene información más específica sobre el error. Según las directrices de la API de REST de Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.	No
└─ código	cuerda / cadena	Uno de un conjunto definido por el servidor de códigos de error.	No
└] innererror	Azure.Core.Foundations.InnerError	Error interno.	No
Mensaje	cuerda / cadena	Una representación en lenguaje natural del error.	Sí
target	cuerda / cadena	Destino del error.	No

Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description	Obligatorio
error	objeto	Objeto de error.	Sí
└─ código	cuerda / cadena	Uno de un conjunto definido por el servidor de códigos de error.	No
└─ detalles	array	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	cuerda / cadena	Una representación en lenguaje natural del error.	No
Destino └	cuerda / cadena	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 la API de REST de Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nombre	Tipo	Description	Obligatorio
código	cuerda / cadena	Uno de un conjunto definido por el servidor de códigos de error.	No
innererror	objeto	Objeto que contiene información más específica sobre el error. Según las directrices de la API de REST de Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.	No
└─ código	cuerda / cadena	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	Importancia
Tipo	cuerda / cadena
Valores	`NotStarted` `Running` `Succeeded` `Failed` `Canceled`

Azure.Core.uuid

Identificador único universal

Tipo: string

Formato: uuid

AzureAIAgentTarget

Representa un destino que especifica un agente de Azure AI.

Nombre	Tipo	Description	Obligatorio
nombre	cuerda / cadena	Identificador único del agente de Azure AI.	Sí
tool_descriptions	array	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	cuerda / cadena	La versión del agente de Azure AI.	No

AzureAIAgentTargetUpdate

Representa un destino que especifica un agente de Azure AI.

Nombre	Tipo	Description	Obligatorio
nombre	cuerda / cadena	Identificador único del agente de Azure AI.	No
tool_descriptions	array	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`	No
version	cuerda / cadena	La versión del agente de Azure AI.	No

AzureAIAssistantTarget

Representa un destino que especifica un punto de conexión de Azure AI Assistant (Agente V1), incluido su identificador.

Nombre	Tipo	Description	Obligatorio
id	cuerda / cadena	Identificador único de Azure AI Assistant.	No
tool_descriptions	array	Descripciones de las herramientas disponibles para el asistente.	Sí
type	enum	El tipo de objetivo, siempre `azure_ai_assistant`. Valores posibles: `azure_ai_assistant`	Sí

AzureAIAssistantTargetUpdate

Representa un destino que especifica un punto de conexión de Azure AI Assistant (Agente V1), incluido su identificador.

Nombre	Tipo	Description	Obligatorio
id	cuerda / cadena	Identificador único de Azure AI Assistant.	No
tool_descriptions	array	Descripciones de las herramientas disponibles para el asistente.	No
type	enum	El tipo de objetivo, siempre `azure_ai_assistant`. Valores posibles: `azure_ai_assistant`	No

AzureAIEvaluator

Definición del evaluador de Azure AI para evaluadores de foundry.

Nombre	Tipo	Description	Obligatorio
data_mapping	objeto	Modelo que se va a usar para la evaluación. Debe admitir salidas estructuradas.	No
evaluator_name	cuerda / cadena	Nombre del evaluador.	Sí
evaluator_version	cuerda / cadena	Versión del evaluador.	No
initialization_parameters	objeto	Parámetros de inicialización para la evaluación. Debe admitir salidas estructuradas.	No
nombre	cuerda / cadena	Nombre del calificador.	Sí
type	enum	Tipo de objeto, que siempre es `label_model`. Valores posibles: `azure_ai_evaluator`	Sí

AzureAIModelTarget

Representa un destino que especifica un modelo de Azure AI para las operaciones que requieren selección de modelos.

Nombre	Tipo	Description	Obligatorio
modelo	cuerda / cadena	Identificador único del modelo de Azure AI.	No
parámetros_de_muestreo	objeto	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	entero	Número máximo de tokens permitidos en la finalización.	No
└— semilla	entero	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í

AzureAIModelTargetUpdate

Representa un destino que especifica un modelo de Azure AI para las operaciones que requieren selección de modelos.

Nombre	Tipo	Description	Obligatorio
modelo	cuerda / cadena	Identificador único del modelo de Azure AI.	No
parámetros_de_muestreo	objeto	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	entero	Número máximo de tokens permitidos en la finalización.	No
└— semilla	entero	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`	No

AzureAIRedTeam

Nombre	Tipo	Description	Obligatorio
item_generation_params	objeto	Representa los parámetros para la generación de elementos de equipo rojo.	Sí
└" attack_strategies	array	Colección de estrategias de ataque que se van a usar.	No
└" num_turns	entero	Número de turnos permitidos en el juego.	No
└─ Tipo	enum	Tipo de parámetros de generación de elementos, siempre `red_team`. Valores posibles: `red_team`	No
target	objeto	Clase base para destinos con compatibilidad con discriminadores.	Sí
└─ Tipo	cuerda / cadena	Tipo de destino.	No
type	enum	Tipo de origen de datos. Siempre `azure_ai_red_team`. Valores posibles: `azure_ai_red_team`	Sí

AzureAIResponses

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

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

AzureAISearchAgentTool

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

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

AzureAISearchIndex

Definición de índice de búsqueda de Azure AI

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de índice Valores posibles: `AzureSearch`	Sí

AzureAISearchIndexUpdate

Definición de índice de búsqueda de Azure AI

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de índice Valores posibles: `AzureSearch`	Sí

AzureAISearchQueryType

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

Propiedad	Importancia
Descripción	Tipos de consulta disponibles para la herramienta de búsqueda de Azure AI.
Tipo	cuerda / cadena
Valores	`simple` `semantic` `vector` `vector_simple_hybrid` `vector_semantic_hybrid`

AzureAISearchToolResource

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

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

AzureAISource

Nombre	Tipo	Description	Obligatorio	Predeterminado
escenario	enum	Escenario de esquema de datos. Valores posibles: `red_team`, `responses`, `traces`	Sí
type	enum	Tipo de objeto, que siempre es `label_model`. Valores posibles: `azure_ai_source`	Sí

AzureFunctionAgentTool

La información de definición de entrada para una herramienta de funciones de Azure, tal como se usa para configurar un agente.

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

AzureFunctionBinding

Estructura para mantener el nombre y el URI de la cola de almacenamiento.

Nombre	Tipo	Description	Obligatorio
storage_queue	objeto	Estructura para mantener el nombre y el URI de la cola de almacenamiento.	Sí
└" queue_name	cuerda / cadena	Nombre de una cola de Azure Functions Storage.	No
└" queue_service_endpoint	cuerda / cadena	URI al servicio de colas de Azure Storage que le permite manipular una cola.	No
type	enum	Tipo de enlace, que siempre es "storage_queue". Valores posibles: `storage_queue`	Sí

AzureFunctionDefinition

Definición de la función de Azure.

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

AzureFunctionStorageQueue

Estructura para mantener el nombre y el URI de la cola de almacenamiento.

Nombre	Tipo	Description	Obligatorio	Predeterminado
queue_name	cuerda / cadena	Nombre de una cola de Azure Functions Storage.	Sí
queue_service_endpoint	cuerda / cadena	URI al servicio de colas de Azure Storage que le permite manipular una cola.	Sí

AzureOpenAIModelConfiguration

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
modelDeploymentName	cuerda / cadena	Nombre de implementación para el modelo AOAI. Ejemplo: gpt-4o si está en AIServices o basado `connection_name/deployment_name` en conexiones (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:

Valor del tipo	Schema
`ApiKey`	ApiKeyCredentials
`AAD`	EntraIDCredentials
`CustomKeys`	CustomCredential
`SAS`	SASCredentials
`None`	NoAuthenticationCredentials
`AgenticIdentityToken`	AgenticIdentityCredentials

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	objeto	El tipo de credencial utilizado por la conexión	Sí

BingCustomSearchAgentTool

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

Nombre	Tipo	Description	Obligatorio
bing_custom_search_preview	objeto	Los parámetros de la herramienta de búsqueda personalizada de Bing.	Sí
└" search_configurations	array	Las conexiones del proyecto asociadas a esta herramienta. Puede haber un máximo de 1 conexión. recurso asociado a la herramienta.	No
type	enum	El tipo de objeto, que siempre es 'bing_custom_search'. Valores posibles: `bing_custom_search_preview`	Sí

BingCustomSearchConfiguration

Una configuración de búsqueda personalizada de Bing.

Nombre	Tipo	Description	Obligatorio
conteo	entero	El número de resultados de búsqueda que se van a devolver en la respuesta de la API de Bing	No
freshness	cuerda / cadena	Filtre los resultados de búsqueda por un intervalo de tiempo específico. Vea los valores aceptados aquí.	No
nombre_instancia	cuerda / cadena	Nombre de la instancia de configuración personalizada dada a config.	Sí
mercado	cuerda / cadena	El mercado del que proceden los resultados.	No
project_connection_id	cuerda / cadena	Identificador de conexión del proyecto para conexión a tierra con bing search	Sí
set_lang	cuerda / cadena	Idioma que se va a usar para las cadenas de la interfaz de usuario al llamar a la API de Bing.	No

BingCustomSearchToolParameters

Los parámetros de la herramienta de búsqueda personalizada de Bing.

Nombre	Tipo	Description	Obligatorio	Predeterminado
search_configurations	array	Las conexiones del proyecto asociadas a esta herramienta. Puede haber un máximo de 1 conexión. recurso asociado a la herramienta.	Sí

BingGroundingAgentTool

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

Nombre	Tipo	Description	Obligatorio
bing_grounding	objeto	Los parámetros de la herramienta de búsqueda de conexión a tierra de Bing.	Sí
└" search_configurations	array	Las configuraciones de búsqueda adjuntas a esta herramienta. Puede haber un máximo de 1 recurso de configuración de búsqueda asociado a la herramienta.	No
type	enum	Tipo de objeto, que siempre es "bing_grounding". Valores posibles: `bing_grounding`	Sí

BingGroundingSearchConfiguration

Configuración de búsqueda para Bing Grounding

Nombre	Tipo	Description	Obligatorio
conteo	entero	El número de resultados de búsqueda que se van a devolver en la respuesta de la API de Bing	No
freshness	cuerda / cadena	Filtre los resultados de búsqueda por un intervalo de tiempo específico. Vea los valores aceptados aquí.	No
mercado	cuerda / cadena	El mercado del que proceden los resultados.	No
project_connection_id	cuerda / cadena	Identificador de conexión del proyecto para conexión a tierra con bing search	Sí
set_lang	cuerda / cadena	Idioma que se va a usar para las cadenas de la interfaz de usuario al llamar a la API de Bing.	No

BingGroundingSearchToolParameters

Los parámetros de la herramienta de búsqueda de conexión a tierra de Bing.

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

BlobReference

Detalles de referencia de blobs.

Nombre	Tipo	Description	Obligatorio
blobUri	cuerda / cadena	Ruta de acceso del URI del blob para que el cliente cargue datos. Ejemplo: `https://blob.windows.core.net/Container/Path`	Sí
credential	objeto	Definición de credenciales de SAS	Sí
└— sasUri	cuerda / cadena	Uri de SAS	No
└─ Tipo	enum	Tipo de credencial Valores posibles: `SAS`	No
storageAccountArmId	cuerda / cadena	Id. de ARM de la cuenta de almacenamiento que se va a usar.	Sí

BrowserAutomationAgentTool

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
browser_automation_preview	objeto	Definición de parámetros de entrada para la herramienta de automatización del navegador.	Sí
Conexión └	BrowserAutomationToolConnectionParameters	Los parámetros de conexión del proyecto asociados con la herramienta de automatización del navegador.	No
type	enum	El tipo de objeto, que siempre es 'browser_automation'. 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	cuerda / cadena	Identificador de la conexión del proyecto al recurso de Azure Playwright.	Sí

BrowserAutomationToolParameters

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

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

CaptureStructuredOutputsTool

Una herramienta para capturar resultados estructurados

Nombre	Tipo	Description	Obligatorio
outputs	objeto	Salida estructurada que el agente puede generar.	Sí
└─ Descripción	cuerda / cadena	Una descripción de la salida que se va a emitir. Utilizado por el modelo para determinar cuándo emitir la salida.	No
└─ Nombre	cuerda / cadena	El nombre de la salida estructurada.	No
└─ Esquema		El esquema JSON para la salida estructurada.	No
└─ estricto	booleano	Si se debe aplicar una validación estricta. El valor predeterminado es `true`.	No
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
tamaño	entero	Tamaño del elemento del gráfico.	Sí
x	entero	Coordenada del eje X.	Sí
y	entero	Coordenada del eje Y.	Sí

ChatSummaryMemoryItem

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
amable	enum	El tipo de elemento de memoria. Valores posibles: `chat_summary`	Sí

ClusterInsightResult

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

Nombre	Tipo	Description	Obligatorio
clusters	array	Lista de clústeres identificados en la información.	Sí
coordenadas	objeto	Asignación opcional de ID a coordenadas 2D utilizadas 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	objeto	Resumen del análisis de conglomerados de errores.	Sí
Método └	cuerda / cadena	Método utilizado para la agrupación en clústeres.	No
└— sampleCount	entero	Número total de muestras analizadas.	No
└— uniqueClusterCount	entero	Número total de clústeres únicos.	No
└— uniqueSubclusterCount	entero	Número total de etiquetas de subclúster únicas.	No
└─ uso	ClusterTokenUsage	Uso de tokens al realizar análisis de clústeres	No

ClusterTokenUsage

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

Nombre	Tipo	Description	Obligatorio
inputTokenUsage	entero	Uso de tokens de entrada	Sí
outputTokenUsage	entero	Uso de tokens de salida	Sí
totalTokenUsage	entero	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	cuerda / cadena	Texto de código en línea para el evaluador	Sí
type	enum	Valores posibles: `code`	Sí

Conexión

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

Nombre	Tipo	Description	Obligatorio
credentials	objeto	Una clase base para las credenciales de conexión	Sí
└─ Tipo	CredentialType	El tipo de credencial utilizada por la conexión	No
id	cuerda / cadena	Un identificador único para la conexión, generado por el servicio	Sí
isDefault	booleano	Si la conexión está etiquetada como la conexión predeterminada de su tipo	Sí
metadata	objeto	Metadatos de la conexión	Sí
nombre	cuerda / cadena	El nombre descriptivo de la conexión, proporcionado por el usuario.	Sí
target	cuerda / cadena	Dirección URL de conexión que se va a usar para este servicio	Sí
type	objeto	Tipo (o categoría) de la conexión	Sí

Tipo de conexión

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

Propiedad	Importancia
Descripción	Tipo (o categoría) de la conexión
Tipo	cuerda / cadena
Valores	`AzureOpenAI` `AzureBlob` `AzureStorageAccount` `CognitiveSearch` `CosmosDB` `ApiKey` `AppConfig` `AppInsights` `CustomKeys` `RemoteTool`

ContainerAppAgentDefinition

La definición del agente de la aplicación contenedora.

Nombre	Tipo	Description	Obligatorio
container_app_resource_id	cuerda / cadena	Identificador de recurso de Azure Container App que hospeda este agente. No mutable entre versiones.	Sí
container_protocol_versions	array	Los protocolos que admite el agente para la comunicación de entrada de los contenedores.	Sí
ingress_subdomain_suffix	cuerda / cadena	El sufijo que se aplicará al subdominio de la aplicación al enviar la entrada al agente. Puede ser una etiqueta (por ejemplo, "---actual"), una revisión específica (por ejemplo, "--0000001") o vacío para usar el punto de conexión predeterminado para la aplicación contenedora.	Sí
amable	enum	Valores posibles: `container_app`	Sí

ContinuousEvalItemGenerationParams

Representa los parámetros para la generación de elementos de evaluación continua.

Nombre	Tipo	Description	Obligatorio
data_mapping	objeto	Asignación de campos de origen a response_id campo, necesario para recuperar el historial de chats.	Sí
max_num_turns	entero	Número máximo de turnos del historial de chat que se va a evaluar.	Sí
source	objeto		Sí
└─ Contenido	array	Contenido del archivo jsonl.	No
└─ id.	cuerda / cadena	Identificador del archivo.	No
└─ Tipo	enum	Tipo de origen jsonl. Siempre `file_id`. Valores posibles: `file_id`	No
type	enum	Tipo de parámetros de generación de elementos, siempre `ResponseRetrieval`. Valores posibles: `response_retrieval`	Sí

ContinuousEvaluationRuleAction

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

Nombre	Tipo	Description	Obligatorio
evalId	cuerda / cadena	Eval Id al que agregar ejecuciones de evaluación continua.	Sí
maxHourlyRuns	entero	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
type	enum	Tipo de índice Valores posibles: `CosmosDBNoSqlVectorStore`	Sí

CosmosDBIndexUpdate

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de índice Valores posibles: `CosmosDBNoSqlVectorStore`	Sí

CreateAgentFromManifestRequest

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Descripción legible del agente.	No
manifest_id	cuerda / cadena	Identificador de manifiesto desde el que se va a importar la versión del agente.	Sí
metadata	objeto	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	cuerda / cadena	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.	Sí
parameter_values	objeto	Las entradas del manifiesto que darán lugar a un agente totalmente materializado.	Sí

CreateAgentRequest

Nombre	Tipo	Description	Obligatorio
definición	objeto		Sí
└└ kind	AgentKind		No
└" rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
descripción	cuerda / cadena	Descripción legible del agente.	No
metadata	objeto	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	cuerda / cadena	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.	Sí

CreateAgentVersionFromManifestRequest

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Descripción legible del agente.	No
manifest_id	cuerda / cadena	Identificador de manifiesto desde el que se va a importar la versión del agente.	Sí
metadata	objeto	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	objeto	Las entradas del manifiesto que darán lugar a un agente totalmente materializado.	Sí

CreateAgentVersionRequest

Nombre	Tipo	Description	Obligatorio
definición	objeto		Sí
└└ kind	AgentKind		No
└" rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
descripción	cuerda / cadena	Descripción legible del agente.	No
metadata	objeto	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
configuración_de_fuente_de_datos	objeto	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 se requieren al crear una ejecución?	Sí
└─ incluir_esquema_de_muestra	booleano	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
└" item_schema	objeto	Esquema json para cada fila del origen de datos.	No
Metadatos └	objeto	Filtros de metadatos para el origen de datos de finalizaciones almacenadas.	No
Escenario └	enum	Escenario de esquema de datos. Valores posibles: `red_team`, `responses`, `traces`	No
└─ Tipo	enum	Tipo de objeto, que siempre es `label_model`. Valores posibles: `azure_ai_source`	No
metadata	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.	No
nombre	cuerda / cadena	Nombre de la evaluación.	No
Propiedades	objeto	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	array	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, como `{{item.variable_name}}`. Para hacer referencia a la salida del modelo, use el espacio de nombres `sample` (es decir, `{{sample.output_text}}`).	Sí

CreateEvalRunRequest

Nombre	Tipo	Description	Obligatorio
fuente_de_datos	objeto	Un objeto JsonlRunDataSource que especifica un archivo JSONL que coincide con la evaluación.	Sí
└─ 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
└" item_generation_params	RedTeamItemGenerationParams	Parámetros para la generación de elementos.	No
└─ modelo	cuerda / cadena	Nombre del modelo que se va a usar para generar finalizaciones (por ejemplo, "o3-mini").	No
└─ parámetros_de_muestreo	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		No
└─ Origen	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.	No
Destino └	Destino	Configuración de destino para la evaluación.	No
└─ Tipo	cuerda / cadena	El discriminador del tipo de origen de datos.	No
metadata	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.	No
nombre	cuerda / cadena	Nombre de la ejecución.	No
Propiedades	objeto	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

CreatedBy

Nombre	Tipo	Description	Obligatorio
agent	objeto		No
└─ Nombre	cuerda / cadena	Nombre del agente.	No
└─ Tipo	enum	Valores posibles: `agent_id`	No
└─ versión	cuerda / cadena	Identificador de versión del agente.	No
response_id	cuerda / cadena	Respuesta en la que se crea el elemento.	No

CredentialType

El tipo de credencial utilizado por la conexión

Propiedad	Importancia
Descripción	El tipo de credencial utilizado por la conexión
Tipo	cuerda / cadena
Valores	`ApiKey` `AAD` `SAS` `CustomKeys` `None` `AgenticIdentityToken`

CronTrigger

Disparador basado en cron.

Nombre	Tipo	Description	Obligatorio	Predeterminado
endTime	cuerda / cadena	Hora de finalización de la programación cron en formato ISO 8601.	No
expression	cuerda / cadena	Expresión cron que define la frecuencia de programación.	Sí
startTime	cuerda / cadena	Hora de inicio de la programación cron en formato ISO 8601.	No
timeZone	cuerda / cadena	Zona horaria para el cron schedule.	No	Tiempo Universal Coordinado (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í

DailyRecurrenceSchedule

Calendario diario de recurrencia.

Nombre	Tipo	Description	Obligatorio	Predeterminado
horas	array	Horas para el programa de periodicidad.	Sí
type	enum	Tipo de recurrencia diaria. Valores posibles: `Daily`	Sí

DatasetType

Enumeración para determinar el tipo de datos.

Propiedad	Importancia
Descripción	Enumeración para determinar el tipo de datos.
Tipo	cuerda / cadena
Valores	`uri_file` `uri_folder`

DatasetVersion

Definición de DatasetVersion

Discriminador para DatasetVersion

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

Valor del tipo	Schema
`uri_file`	FileDatasetVersion
`uri_folder`	FolderDatasetVersion

Nombre	Tipo	Description	Obligatorio
connectionName	cuerda / cadena	El nombre de conexión de la cuenta de almacenamiento de Azure. Obligatorio si no se llamó a startPendingUploadVersion antes de crear el conjunto de datos	No
dataUri	cuerda / cadena	URI de los datos (ejemplo)	Sí
id	cuerda / cadena	ID de activo, un identificador único para el activo	No
isReference	booleano	Indica si el conjunto de datos contiene una referencia al almacenamiento o si el conjunto de datos administra el almacenamiento por sí mismo. Si es true, los datos subyacentes no se eliminarán cuando se elimine la versión del conjunto de datos	No
nombre	cuerda / cadena	Nombre del recurso	Sí
type	objeto	Enumeración para determinar el tipo de datos.	Sí
version	cuerda / cadena	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:

Valor del tipo	Schema
`uri_file`	FileDatasetVersionUpdate
`uri_folder`	FolderDatasetVersionUpdate

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Texto de descripción del recurso.	No
tags	objeto	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
type	objeto	Enumeración para determinar el tipo de datos.	Sí

DíaDeLaSemana

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

Propiedad	Importancia
Descripción	Días de la semana para el programa de recurrencia.
Tipo	cuerda / cadena
Valores	`Sunday` `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday`

DeleteAgentResponse

Un objeto de agente eliminado

Nombre	Tipo	Description	Obligatorio
eliminado	booleano	Si el agente se eliminó correctamente.	Sí
nombre	cuerda / cadena	Nombre del agente.	Sí
objeto	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
eliminado	booleano	Si el agente se eliminó correctamente.	Sí
nombre	cuerda / cadena	Nombre del agente.	Sí
objeto	enum	Tipo de objeto. Siempre 'agent.deleted'. Valores posibles: `agent.version.deleted`	Sí
version	cuerda / cadena	Identificador de versión del agente.	Sí

DeleteEvalResponse

Objeto de evaluación eliminado

Nombre	Tipo	Description	Obligatorio
eliminado	booleano	Si la evaluación se eliminó correctamente.	Sí
eval_id	cuerda / cadena	id de la eval.	Sí
objeto	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
eliminado	booleano	Si la evaluación se eliminó correctamente.	No
objeto	enum	Tipo de objeto. Siempre 'eval.deleted'. Valores posibles: `eval.deleted`	No
identificador_de_ejecución	cuerda / cadena	id de la eval.	No

DeleteMemoryStoreResponse

Nombre	Tipo	Description	Obligatorio
eliminado	booleano	Si el almacén de memoria se eliminó correctamente.	Sí
nombre	cuerda / cadena	El nombre del almacén de memoria.	Sí
objeto	enum	Tipo de objeto. Siempre 'memory_store.eliminado'. Valores posibles: `memory_store.deleted`	Sí

DeleteResponseResult

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

Nombre	Tipo	Description	Obligatorio
eliminado	enum	Devolver siempre true Valores posibles: `True`	Sí
id	cuerda / cadena	Identificador de la operación.	Sí
objeto	enum	Devuelve siempre "response". Valores posibles: `response`	Sí

Despliegue

Definición de implementación de modelo

Discriminador para la implementación

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

Valor del tipo	Schema
`ModelDeployment`	ModelDeployment

Nombre	Tipo	Description	Obligatorio	Predeterminado
nombre	cuerda / cadena	Nombre de la implementación	Sí
type	objeto		Sí

TipoDeDespliegue

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	`ModelDeployment`

EntraIDCredentials

Definición de credencial de 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, por ejemplo:

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
fecha_de_creación	objeto		Sí
created_by	cuerda / cadena	el nombre de la persona que creó la ejecución.	No
configuración_de_fuente_de_datos	objeto	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 se requieren al crear una ejecución?	Sí
└─ incluir_esquema_de_muestra	booleano	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
└" item_schema	objeto	Esquema json para cada fila del origen de datos.	No
Metadatos └	objeto	Filtros de metadatos para el origen de datos de finalizaciones almacenadas.	No
Escenario └	enum	Escenario de esquema de datos. Valores posibles: `red_team`, `responses`, `traces`	No
└─ Tipo	enum	Tipo de objeto, que siempre es `label_model`. Valores posibles: `azure_ai_source`	No
id	cuerda / cadena	Identificador único de la evaluación.	Sí
metadata	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í
modified_at	objeto		No
nombre	cuerda / cadena	Nombre de la evaluación.	Sí
objeto	enum	Tipo de objeto. Valores posibles: `eval`	Sí
Propiedades	objeto	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	array	Lista de criterios de prueba.	Sí

EvalCompareReport

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

Nombre	Tipo	Description	Obligatorio
Comparaciones	array	Los resultados de la comparación para cada tratamiento se comparan con la línea de base.	Sí
method	cuerda / cadena	El método estadístico utilizado para la comparación.	Sí
type	enum	El tipo de resultado de la información. Valores posibles: `EvaluationComparison`	Sí

EvalResult

Resultado de la evaluación.

Nombre	Tipo	Description	Obligatorio
nombre	cuerda / cadena	Nombre del cheque	Sí
Pasado	booleano	indica si la comprobación se ha superado o no	Sí
puntuación	número	puntuación	Sí
type	cuerda / cadena	Tipo de cheque	Sí

EvalRun

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

Nombre	Tipo	Description	Obligatorio
fecha_de_creación	objeto		Sí
created_by	cuerda / cadena	el nombre de la persona que creó la ejecución.	No
fuente_de_datos	objeto	Un objeto JsonlRunDataSource que especifica un archivo JSONL que coincide con la evaluación.	Sí
└─ 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
└" item_generation_params	RedTeamItemGenerationParams	Parámetros para la generación de elementos.	No
└─ modelo	cuerda / cadena	Nombre del modelo que se va a usar para generar finalizaciones (por ejemplo, "o3-mini").	No
└─ parámetros_de_muestreo	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		No
└─ Origen	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.	No
Destino └	Destino	Configuración de destino para la evaluación.	No
└─ Tipo	cuerda / cadena	El discriminador del tipo de origen de datos.	No
error	OpenAI.EvalApiError	Objeto que representa una respuesta de error de la API de Eval.	Sí
eval_id	cuerda / cadena	Identificador de la evaluación asociada.	Sí
id	cuerda / cadena	Identificador único de la ejecución de la evaluación.	Sí
metadata	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í
modelo	cuerda / cadena	Modelo que se evalúa, si procede.	Sí
modified_at	objeto		No
nombre	cuerda / cadena	Nombre de la ejecución de evaluación.	Sí
objeto	enum	Tipo del objeto. Siempre "eval.run". Valores posibles: `eval.run`	Sí
per_model_usage	array	Estadísticas de uso de cada modelo durante la ejecución de evaluación.	Sí
resultados_por_criterios_de_pruebas	array	Resultados por criterios de prueba aplicados durante la ejecución de la evaluación.	Sí
Propiedades	objeto	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	cuerda / cadena	Dirección URL del informe de ejecución de evaluación representado en el panel de la interfaz de usuario.	Sí
conteo_de_resultados	objeto		Sí
Errores └	OpenAI.integer		No
└─ fallido	OpenAI.integer		No
└─ aprobado	OpenAI.integer		No
└─ total	OpenAI.integer		No
estado	cuerda / cadena	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:

Valor del tipo	Schema
`azure_ai_traces`	TracesEvalRunDataSource
`azure_ai_responses`	AzureAIResponses
`azure_ai_target_completions`	TargetCompletions

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	cuerda / cadena	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
fecha_de_creación	objeto		Sí
elemento_fuente_de_datos	objeto	Detalles del elemento de origen de datos de entrada.	Sí
id_del_elemento_fuente_de_datos	objeto		Sí
eval_id	cuerda / cadena	Identificador del grupo de evaluación.	Sí
id	cuerda / cadena	Identificador único del elemento de salida del proceso de evaluación.	Sí
objeto	enum	Tipo del objeto. Siempre "eval.run.output_item". Valores posibles: `eval.run.output_item`	Sí
results	array	Lista de resultados del calificador para este elemento de salida.	Sí
identificador_de_ejecución	cuerda / cadena	Identificador de la ejecución de evaluación asociada a este elemento de salida.	Sí
muestra	objeto		Sí
└─ Error	OpenAI.EvalApiError	Objeto que representa una respuesta de error de la API de Eval.	No
└─ razón_de_finalización	cuerda / cadena		No
└─ Entrada	array		No
└" max_completion_tokens	OpenAI.integer		No
└─ modelo	cuerda / cadena		No
└─ salida	array		No
└— semilla	OpenAI.integer		No
└─ Temperatura	OpenAI.numeric		No
└─ top_p	OpenAI.numeric		No
└─ uso	OpenAI.EvalRunOutputItemSampleUsage		No
estado	cuerda / cadena	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
label	cuerda / cadena	Etiqueta asociada a la métrica de criterios de prueba (por ejemplo, "pass", "fail", "good", "bad").	No
metric	cuerda / cadena	Nombre de la métrica (por ejemplo, "fluency", "f1_score").	No
nombre	cuerda / cadena	Nombre del calificador.	Sí
Pasado	booleano	Si el calificador consideró la salida de un pase.	Sí
Propiedades	objeto	Detalles adicionales sobre la métrica de criterios de prueba.	No
reason	cuerda / cadena	Motivo de la métrica de criterios de prueba.	No
muestra	objeto	Muestra opcional o datos intermedios generados por el calificador.	No
puntuación	objeto		Sí
threshold	número	Umbral usado para determinar el paso o error de estos criterios de prueba, si es numérico.	No
type	cuerda / cadena	Tipo de calificador (por ejemplo, "string-check-grader").	No

EvalRunResultCompareItem

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

Nombre	Tipo	Description	Obligatorio
deltaEstimate	número	Diferencia estimada entre el tratamiento y el valor inicial.	Sí
pValue	número	Valor p para el efecto del tratamiento.	Sí
treatmentEffect	objeto	Tipo de efecto del tratamiento.	Sí
treatmentRunId	cuerda / cadena	El ID de ejecución del tratamiento.	Sí
treatmentRunSummary	objeto	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.	No
└] runId	cuerda / cadena	El ID de ejecución de evaluación.	No
└— sampleCount	entero	Número de muestras en la ejecución de evaluación.	No
└— standardDeviation	número	Desviación estándar de la métrica en la ejecución de evaluación.	No

EvalRunResultComparison

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

Nombre	Tipo	Description	Obligatorio
baselineRunSummary	objeto	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.	No
└] runId	cuerda / cadena	El ID de ejecución de evaluación.	No
└— sampleCount	entero	Número de muestras en la ejecución de evaluación.	No
└— standardDeviation	número	Desviación estándar de la métrica en la ejecución de evaluación.	No
compareItems	array	Lista de resultados de comparación para cada ejecución de tratamiento.	Sí
evaluador	cuerda / cadena	Nombre del evaluador para estos criterios de prueba.	Sí
metric	cuerda / cadena	Métrica que se está evaluando.	Sí
testingCriteria	cuerda / cadena	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
promedio	número	Valor medio de la métrica en la ejecución de evaluación.	Sí
runId	cuerda / cadena	El ID de ejecución de evaluación.	Sí
sampleCount	entero	Número de muestras en 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í

EvaluationComparisonRequest

Solicitud de comparación de evaluación

Nombre	Tipo	Description	Obligatorio
baselineRunId	cuerda / cadena	El identificador de ejecución de línea base para la comparación.	Sí
evalId	cuerda / cadena	Identificador de la evaluación.	Sí
treatmentRunIds	array	Lista de identificadores de ejecución de tratamiento para comparar.	Sí
type	enum	Tipo de solicitud. Valores posibles: `EvaluationComparison`	Sí

EvaluationResultSample

Una muestra del resultado de la evaluación.

Nombre	Tipo	Description	Obligatorio
evaluationResult	objeto	Resultado de la evaluación.	Sí
└─ Nombre	cuerda / cadena	Nombre del cheque	No
└─ aprobado	booleano	indica si la comprobación se ha superado o no	No
└~ puntuación	número	puntuación	No
└─ Tipo	cuerda / cadena	Tipo de cheque	No
type	enum	Tipo de muestra de resultado de evaluación Valores posibles: `EvaluationResultSample`	Sí

EvaluationRule

Modelo de regla de evaluación.

Nombre	Tipo	Description	Obligatorio
acción	objeto	Modelo de acción de evaluación.	Sí
└─ Tipo	EvaluationRuleActionType	Tipo de acción de evaluación.	No
descripción	cuerda / cadena	Descripción de la regla de evaluación.	No
Nombre para mostrar	cuerda / cadena	Nombre para mostrar de la regla de evaluación.	No
habilitado	booleano	Indica si la regla de evaluación está habilitada. El valor predeterminado es true.	Sí
eventType	objeto	Tipo de evento de regla de evaluación.	Sí
filtro	objeto	Modelo de filtro de evaluación.	No
└] agentName	cuerda / cadena	Filtrar por nombre de agente.	No
id	cuerda / cadena	Identificador único de la regla de evaluación.	Sí
datos del sistema	objeto	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:

Valor del tipo	Schema
`continuousEvaluation`	ContinuousEvaluationRuleAction
`humanEvaluation`	HumanEvaluationRuleAction

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

EvaluationRuleActionType

Tipo de acción de evaluación.

Propiedad	Importancia
Descripción	Tipo de acción de evaluación.
Tipo	cuerda / cadena
Valores	`continuousEvaluation` `humanEvaluation`

EvaluationRuleEventType

Tipo de evento de regla de evaluación.

Propiedad	Importancia
Descripción	Tipo de evento de regla de evaluación.
Tipo	cuerda / cadena
Valores	`responseCompleted` `manual`

EvaluationRuleFilter

Modelo de filtro de evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
agentName	cuerda / cadena	Filtrar por nombre de agente.	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	El tipo de resultado de la información. Valores posibles: `EvaluationRunClusterInsight`	Sí

EvaluationRunClusterInsightsRequest

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

Nombre	Tipo	Description	Obligatorio
evalId	cuerda / cadena	Identificador de evaluación para la información.	Sí
modelConfiguration	objeto	Configuración del modelo utilizado en la generación de información.	No
└] modelDeploymentName	cuerda / cadena	La 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>`.	No
runIds	array	Lista de identificadores de ejecución de evaluación para la información.	Sí
type	enum	El tipo de solicitud de información. Valores posibles: `EvaluationRunClusterInsight`	Sí

EvaluationScheduleTask

Tarea de evaluación para el horario.

Nombre	Tipo	Description	Obligatorio
evalId	cuerda / cadena	Identificador del grupo de evaluación.	Sí
evalRun	objeto	La carga útil 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
id	cuerda / cadena	ID de activo, un identificador único para el activo	No
nombre	cuerda / cadena	Nombre del recurso	Sí
Propiedades	objeto	Propiedades adicionales para la taxonomía de evaluación.	No
taxonomyCategories	array	Lista de categorías de taxonomía.	No
taxonomyInput	objeto	Configuración de entrada para la taxonomía de evaluación.	Sí
└─ Tipo	EvaluationTaxonomyInputType	Tipo de entrada de la taxonomía de evaluación.	No
version	cuerda / cadena	La versión del recurso	Sí

EvaluationTaxonomyCreateOrUpdate

Definición de taxonomía de evaluación

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Texto de descripción del recurso.	No
Propiedades	objeto	Propiedades adicionales para la taxonomía de evaluación.	No
tags	objeto	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
taxonomyCategories	array	Lista de categorías de taxonomía.	No
taxonomyInput	objeto	Configuración de entrada para la taxonomía de evaluación.	Sí
└─ Tipo	EvaluationTaxonomyInputType	Tipo de entrada de la taxonomía de evaluación.	No

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:

Valor del tipo	Schema
`agent`	AgentTaxonomyInput

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

EvaluationTaxonomyInputType

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

Propiedad	Importancia
Descripción	Tipo de entrada de la taxonomía de evaluación.
Tipo	cuerda / cadena
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:

Valor del tipo	Schema
`agent`	AgentTaxonomyInputUpdate

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

EvaluationTaxonomyUpdate

Definición de taxonomía de evaluación

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Texto de descripción del recurso.	No
Propiedades	objeto	Propiedades adicionales para la taxonomía de evaluación.	No
tags	objeto	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
taxonomyCategories	array	Lista de categorías de taxonomía.	No
taxonomyInput	objeto	Configuración de entrada para la taxonomía de evaluación.	No
└─ Tipo	EvaluationTaxonomyInputType	Tipo de entrada de la taxonomía de evaluación.	No

EvaluadorCategory

La categoría del evaluador

Propiedad	Importancia
Descripción	La categoría del evaluador
Tipo	cuerda / cadena
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:

Valor del tipo	Schema
`code`	CodeBasedEvaluatorDefinition
`prompt`	PromptBasedEvaluatorDefinition

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

EvaluadorDefinitionType

El tipo de definición del evaluador

Propiedad	Importancia
Descripción	El tipo de definición del evaluador
Tipo	cuerda / cadena
Valores	`prompt` `code` `prompt_and_code` `service` `openai_graders`

EvaluadorMetric

Métrica del evaluador

Nombre	Tipo	Description	Obligatorio
desirable_direction	objeto	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	booleano	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	objeto	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	Importancia
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
Tipo	cuerda / cadena
Valores	`increase` `decrease` `neutral`

EvaluadorMetricType

El tipo de evaluador

Propiedad	Importancia
Descripción	El tipo de evaluador
Tipo	cuerda / cadena
Valores	`ordinal` `continuous` `boolean`

EvaluadorType

El tipo de evaluador

Propiedad	Importancia
Descripción	El tipo de evaluador
Tipo	cuerda / cadena
Valores	`builtin` `custom`

EvaluadorVersion

Definición del evaluador

Nombre	Tipo	Description	Obligatorio
categories	array	Las categorías del evaluador	Sí
fecha_de_creación	entero	Fecha/hora de creación del evaluador	Sí
created_by	cuerda / cadena	Creador del evaluador	Sí
definición	objeto	Configuración del evaluador base con discriminador	Sí
└" data_schema		El esquema JSON (Borrador 2020-12) para los datos de entrada del evaluador. Esto incluye parámetros como tipo, propiedades, obligatorio.	No
└" init_parameters		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 └	objeto	Lista de métricas de salida producidas por este evaluador	No
└─ Tipo	EvaluadorDefinitionType	El tipo de definición del evaluador	No
display_name	cuerda / cadena	Nombre para mostrar del evaluador. Ayuda a encontrar fácilmente el evaluador en Foundry. No es necesario que sea único.	No
evaluator_type	objeto	El tipo de evaluador	Sí
id	cuerda / cadena	ID de activo, un identificador único para el activo	No
metadata	objeto	Metadatos sobre el evaluador	No
modified_at	entero	Fecha/hora de la última modificación del evaluador	Sí
nombre	cuerda / cadena	Nombre del recurso	Sí
version	cuerda / cadena	La versión del recurso	Sí

EvaluadorVersionCreate

Definición del evaluador

Nombre	Tipo	Description	Obligatorio
categories	array	Las categorías del evaluador	Sí
definición	objeto	Configuración del evaluador base con discriminador	Sí
└" data_schema		El esquema JSON (Borrador 2020-12) para los datos de entrada del evaluador. Esto incluye parámetros como tipo, propiedades, obligatorio.	No
└" init_parameters		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 └	objeto	Lista de métricas de salida producidas por este evaluador	No
└─ Tipo	EvaluadorDefinitionType	El tipo de definición del evaluador	No
descripción	cuerda / cadena	Texto de descripción del recurso.	No
display_name	cuerda / cadena	Nombre para mostrar del evaluador. Ayuda a encontrar fácilmente el evaluador en Foundry. No es necesario que sea único.	No
evaluator_type	objeto	El tipo de evaluador	Sí
metadata	objeto	Metadatos sobre el evaluador	No
tags	objeto	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No

EvaluadorVersionUpdate

Definición del evaluador

Nombre	Tipo	Description	Obligatorio
categories	array	Las categorías del evaluador	No
descripción	cuerda / cadena	Texto de descripción del recurso.	No
display_name	cuerda / cadena	Nombre para mostrar del evaluador. Ayuda a encontrar fácilmente el evaluador en Foundry. No es necesario que sea único.	No
metadata	objeto	Metadatos sobre el evaluador	No
tags	objeto	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	array	Las conexiones del proyecto asociadas 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
type	enum	Tipo de conjunto de datos Valores posibles: `uri_file`	Sí

FileDatasetVersionUpdate

FileDatasetVersion (Definición)

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de conjunto de datos Valores posibles: `uri_file`	Sí

FolderDatasetVersion

FileDatasetVersion (Definición)

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de conjunto de datos Valores posibles: `uri_folder`	Sí

FolderDatasetVersionUpdate

FileDatasetVersion (Definición)

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de conjunto de datos Valores posibles: `uri_folder`	Sí

HostedAgentDefinition

La definición del agente hospedado.

Discriminador para HostedAgentDefinition

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

Valor del tipo	Schema
`hosted`	ImageBasedHostedAgentDefinition

Nombre	Tipo	Description	Obligatorio
container_protocol_versions	array	Los protocolos que admite el agente para la comunicación de entrada de los contenedores.	Sí
CPU	cuerda / cadena	La configuración de la CPU para el agente hospedado.	Sí
environment_variables	objeto	Variables de entorno que se van a establecer en el contenedor del agente hospedado.	No
amable	enum	Valores posibles: `hosted`	Sí
memoria	cuerda / cadena	La configuración de memoria para el agente hospedado.	Sí
herramientas	array	Una matriz de herramientas que el modelo del agente hospedado puede llamar mientras genera una respuesta. Tú / Usted 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í

HumanEvaluationRuleAction

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
ID de plantilla	objeto	Identificador de un recurso guardado.	Sí
type	enum	Valores posibles: `humanEvaluation`	Sí

ImageBasedHostedAgentDefinition

Definición de implementación basada en imágenes para un agente hospedado.

Nombre	Tipo	Description	Obligatorio	Predeterminado
imagen	cuerda / cadena	La imagen del agente hospedado.	Sí
amable	enum	Valores posibles: `hosted`	Sí

Index

Definición de recursos de índice

Discriminador para índice

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

Valor del tipo	Schema
`AzureSearch`	AzureAISearchIndex
`ManagedAzureSearch`	ManagedAzureAISearchIndex
`CosmosDBNoSqlVectorStore`	CosmosDBIndex

Nombre	Tipo	Description	Obligatorio
id	cuerda / cadena	ID de activo, un identificador único para el activo	No
nombre	cuerda / cadena	Nombre del recurso	Sí
type	objeto		Sí
version	cuerda / cadena	La versión del recurso	Sí

IndexType

Propiedad	Importancia
Tipo	cuerda / cadena
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:

Valor del tipo	Schema
`AzureSearch`	AzureAISearchIndexUpdate
`ManagedAzureSearch`	ManagedAzureAISearchIndexUpdate
`CosmosDBNoSqlVectorStore`	CosmosDBIndexUpdate

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Texto de descripción del recurso.	No
tags	objeto	Diccionario de etiquetas. Las etiquetas se pueden agregar, quitar y actualizar.	No
type	objeto		Sí

Conclusión

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

Nombre	Tipo	Description	Obligatorio
Nombre para mostrar	cuerda / cadena	Nombre para mostrar descriptivo de la información.	Sí
id	cuerda / cadena	El identificador único del informe de estadísticas.	Sí
metadata	objeto	Metadatos sobre la información.	Sí
└— completedAt	cuerda / cadena	La marca de tiempo en la que se completaron las estadísticas.	No
└— createdAt	cuerda / cadena	La marca de tiempo en la que se crearon las estadísticas.	No
request	objeto	La solicitud del informe de información.	Sí
└─ Tipo	InsightType	Tipo de solicitud.	No
resultado	objeto	El resultado de las ideas.	No
└─ Tipo	InsightType	El tipo de resultado de la información.	No
estado	objeto	Enumeración que describe los estados de operación permitidos.	Sí

InsightCluster

Un grupo de muestras de análisis.

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Descripción del grupo de análisis.	Sí
id	cuerda / cadena	El identificador del clúster de análisis.	Sí
label	cuerda / cadena	Etiqueta para el clúster	Sí
Muestras	array	Lista de muestras que pertenecen a este clúster. Vacío si las muestras forman parte de subgrupos.	No
subClusters	array	Lista de subclústeres dentro de este clúster. Vacío si no existen subclústeres.	No
sugerencia	cuerda / cadena	Sugerencia para el clúster	Sí
suggestionTitle	cuerda / cadena	El título de la sugerencia para el grupo	Sí
weight	entero	Peso del clúster de análisis. Esto indica el número de muestras en el clúster.	Sí

InsightModelConfiguration

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
modelDeploymentName	cuerda / cadena	La 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:

Valor del tipo	Schema
`EvaluationRunClusterInsight`	EvaluationRunClusterInsightsRequest
`AgentClusterInsight`	AgentClusterInsightsRequest
`EvaluationComparison`	EvaluationComparisonRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	objeto	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:

Valor del tipo	Schema
`EvaluationComparison`	EvalCompareReport
`EvaluationRunClusterInsight`	EvaluationRunClusterInsightResult
`AgentClusterInsight`	AgentClusterInsightResult

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	objeto	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:

Valor del tipo	Schema
`EvaluationResultSample`	EvaluationResultSample

Nombre	Tipo	Description	Obligatorio
correlationInfo	objeto	Información sobre la correlación de la muestra de análisis.	Sí
features	objeto	Funciones para ayudar con el filtrado adicional de datos en UX.	Sí
id	cuerda / cadena	El identificador único de la muestra de análisis.	Sí
type	objeto	El tipo de muestra utilizada en el análisis.	Sí

InsightScheduleTask

Tarea de información para la programación.

Nombre	Tipo	Description	Obligatorio
visión	objeto	El cuerpo de respuesta para la información del clúster.	Sí
└] displayName	cuerda / cadena	Nombre para mostrar descriptivo de la información.	No
└─ id.	cuerda / cadena	El identificador único del informe de estadísticas.	No
Metadatos └	InsightsMetadata	Metadatos sobre el informe de estadísticas.	No
Solicitud └	InsightRequest	Solicitud del análisis de perspectivas.	No
Resultado └	InsightResult	El resultado del informe de estadísticas.	No
Estado └	Azure.Core.Foundations.OperationState	El estado actual de las perspectivas.	No
type	enum	Valores posibles: `Insight`	Sí

InsightSummary

Resumen del análisis de conglomerados de errores.

Nombre	Tipo	Description	Obligatorio
method	cuerda / cadena	Método utilizado para la agrupación en clústeres.	Sí
sampleCount	entero	Número total de muestras analizadas.	Sí
uniqueClusterCount	entero	Número total de clústeres únicos.	Sí
uniqueSubclusterCount	entero	Número total de etiquetas de subclúster únicas.	Sí
usage	objeto	Uso de tokens para el análisis de clústeres	Sí
└— inputTokenUsage	entero	Uso de tokens de entrada	No
└— outputTokenUsage	entero	Uso de tokens de salida	No
└— totalTokenUsage	entero	Uso total de tokens	No

InsightType

La solicitud de las ideas.

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	`EvaluationRunClusterInsight` `AgentClusterInsight` `EvaluationComparison`

InsightsMetadata

Metadatos sobre la información.

Nombre	Tipo	Description	Obligatorio	Predeterminado
completedAt	cuerda / cadena	La marca de tiempo en la que se completaron las estadísticas.	No
createdAt	cuerda / cadena	La marca de tiempo en la que se crearon las estadísticas.	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:

Valor del tipo	Schema

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	cuerda / cadena	Tipo de parámetros de generación de elementos que se van a usar.	Sí

ManagedAzureAISearchIndex

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de índice Valores posibles: `ManagedAzureSearch`	Sí

ManagedAzureAISearchIndexUpdate

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
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:

Valor del tipo	Schema
`user_profile`	UserProfileMemoryItem
`chat_summary`	ChatSummaryMemoryItem

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

MemoryItemKind

Tipo de elemento de memoria.

Propiedad	Importancia
Descripción	Tipo de elemento de memoria.
Tipo	cuerda / cadena
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
amable	objeto	Tipo de operación de memoria.	Sí
memory_item	objeto	Un único elemento de memoria almacenado en el almacén de memoria, que contiene contenido y metadatos.	Sí
└─ Contenido	cuerda / cadena	El contenido de la memoria.	No
└└ kind	MemoryItemKind	El tipo de elemento de memoria.	No
└" memory_id	cuerda / cadena	El identificador único del elemento de memoria.	No
Ámbito └	cuerda / cadena	El espacio de nombres que agrupa y aísla lógicamente las memorias, como un ID de usuario.	No
└" updated_at	entero	La hora de la última actualización del elemento de memoria.	No

MemoryOperationKind

Tipo de operación de memoria.

Propiedad	Importancia
Descripción	Tipo de operación de memoria.
Tipo	cuerda / cadena
Valores	`create` `update` `delete`

MemorySearchItem

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

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

MemorySearchOptions

Opciones de búsqueda de memoria.

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

MemorySearchTool

Una herramienta para integrar los recuerdos en el agente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
memory_store_name	cuerda / cadena	El nombre del almacén de memoria que se va a usar.	Sí
scope	cuerda / cadena	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	objeto	Opciones de búsqueda de memoria.	No
└" max_memories	entero	Número máximo de elementos de memoria que se van a devolver.	No
type	enum	Tipo de la herramienta. Siempre `memory_search`. Valores posibles: `memory_search`	Sí
update_delay	entero	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	array	Los resultados devueltos por la búsqueda en memoria.	No
type	enum	Valores posibles: `memory_search_call`	Sí

MemorySearchToolCallItemResource

Nombre	Tipo	Description	Obligatorio
results	array	Los resultados devueltos por la búsqueda en memoria.	No
estado	enum	Estado de la llamada a la herramienta de búsqueda de memoria. Uno de `in_progress`, `searching` `completed`, `incomplete`o `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	cuerda / cadena	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	cuerda / cadena	El nombre o identificador de la implementación del modelo de incrustación que se usa para el procesamiento de memoria.	Sí
amable	enum	El tipo de almacén de memoria. Valores posibles: `default`	Sí
options	objeto	Configuraciones predeterminadas del almacén de memoria.	No
└" chat_summary_enabled	booleano	Si se debe habilitar la extracción y el almacenamiento de resúmenes de chat. El valor predeterminado es true.	No	Cierto
└" user_profile_details	cuerda / cadena	Categorías o tipos específicos de información de perfil de usuario para extraer y almacenar.	No
└" user_profile_enabled	booleano	Si se debe habilitar la extracción y el almacenamiento de perfiles de usuario. El valor predeterminado es true.	No	Cierto

MemoryStoreDefaultOptions

Configuraciones predeterminadas del almacén de memoria.

Nombre	Tipo	Description	Obligatorio	Predeterminado
chat_summary_enabled	booleano	Si se debe habilitar la extracción y el almacenamiento de resúmenes de chat. El valor predeterminado es true.	Sí	Cierto
user_profile_details	cuerda / cadena	Categorías o tipos específicos de información de perfil de usuario para extraer y almacenar.	No
user_profile_enabled	booleano	Si se debe habilitar la extracción y el almacenamiento de perfiles de usuario. El valor predeterminado es true.	Sí	Cierto

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:

Valor del tipo	Schema
`default`	MemoryStoreDefaultDefinition

Nombre	Tipo	Description	Obligatorio	Predeterminado
amable	objeto	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
eliminado	booleano	Si la operación de eliminación se realizó correctamente.	Sí
nombre	cuerda / cadena	El nombre del almacén de memoria.	Sí
objeto	enum	Tipo de objeto. Siempre 'memory_store.scope.deleted'. Valores posibles: `memory_store.scope.deleted`	Sí
scope	cuerda / cadena	El á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	Importancia
Descripción	El tipo de implementación del almacén de memoria que se va a usar.
Tipo	cuerda / cadena
Valores	`default`

MemoryStoreObject

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

Nombre	Tipo	Description	Obligatorio
fecha_de_creación	entero	La marca de tiempo de Unix (segundos) cuando se creó el almacén de memoria.	Sí
definición	objeto	Definición base para configuraciones de almacén de memoria.	Sí
└└ kind	MemoryStoreKind	El tipo de almacén de memoria.	No
descripción	cuerda / cadena	Una descripción legible por humanos del almacén de memoria.	No
id	cuerda / cadena	Identificador único del almacén de memoria.	Sí
metadata	objeto	Metadatos de clave-valor arbitrarios para asociar con el almacén de memoria.	No
nombre	cuerda / cadena	El nombre del almacén de memoria.	Sí
objeto	enum	El tipo de objeto, que siempre es 'memory_store'. Valores posibles: `memory_store`	Sí
updated_at	entero	La marca de tiempo de Unix (segundos) cuando se actualizó por última vez el almacén de memoria.	Sí

MemoryStoreOperationUsage

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

Nombre	Tipo	Description	Obligatorio
embedding_tokens	entero	El número de tokens de incrustación.	Sí
input_tokens	entero	Número de tokens de entrada.	Sí
input_tokens_details	objeto	Desglose detallado de los tokens de entrada.	Sí
└─ cached_tokens	entero	Número de tokens que se recuperaron de la memoria caché. Más información sobre el almacenamiento en caché de solicitudes.	No
output_tokens	entero	Número de tokens de salida.	Sí
output_tokens_details	objeto	Desglose detallado de los tokens de salida.	Sí
─ reasoning_tokens	entero	Número de elementos de razonamiento.	No
total_tokens	entero	Número total de tokens usados.	Sí

MemoryStoreSearchResponse

Respuesta de búsqueda de memoria.

Nombre	Tipo	Description	Obligatorio
Recuerdos	array	Elementos de memoria relacionados encontrados durante la operación de búsqueda.	Sí
search_id	cuerda / cadena	El identificador único de esta solicitud de búsqueda. Use este valor como previous_search_id en solicitudes posteriores para realizar búsquedas incrementales.	Sí
usage	objeto	Estadísticas de uso de una operación de almacén de memoria.	Sí
└" embedding_tokens	entero	El número de tokens de incrustación.	No
└─ input_tokens	entero	Número de tokens de entrada.	No
└─ detalles_de_tokens_de_entrada	objeto	Desglose detallado de los tokens de entrada.	No
└─ cached_tokens	entero	Número de tokens que se recuperaron de la memoria caché. Más información sobre el almacenamiento en caché de solicitudes.	No
└─ output_tokens	entero	Número de tokens de salida.	No
└" output_tokens_details	objeto	Desglose detallado de los tokens de salida.	No
─ reasoning_tokens	entero	Número de elementos de razonamiento.	No
└" total_tokens	entero	Número total de tokens usados.	No

MemoryStoreUpdateCompletedResult

Resultado de la actualización de memoria.

Nombre	Tipo	Description	Obligatorio
memory_operations	array	Una lista de operaciones de memoria individuales que se realizaron durante la actualización.	Sí
usage	objeto	Estadísticas de uso de una operación de almacén de memoria.	Sí
└" embedding_tokens	entero	El número de tokens de incrustación.	No
└─ input_tokens	entero	Número de tokens de entrada.	No
└─ detalles_de_tokens_de_entrada	objeto	Desglose detallado de los tokens de entrada.	No
└─ cached_tokens	entero	Número de tokens que se recuperaron de la memoria caché. Más información sobre el almacenamiento en caché de solicitudes.	No
└─ output_tokens	entero	Número de tokens de salida.	No
└" output_tokens_details	objeto	Desglose detallado de los tokens de salida.	No
─ reasoning_tokens	entero	Número de elementos de razonamiento.	No
└" total_tokens	entero	Número total de tokens usados.	No

MemoryStoreUpdateResponse

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

Nombre	Tipo	Description	Obligatorio
error	objeto		No
└] additionalInfo	objeto		No
└─ código	cuerda / cadena		No
└] debugInfo	objeto		No
└─ detalles	array		No
└─ Mensaje	cuerda / cadena		No
└— param	cuerda / cadena		No
└─ Tipo	cuerda / cadena		No
resultado	objeto	Resultado de la actualización de memoria.	No
└" memory_operations	array	Una lista de operaciones de memoria individuales que se realizaron durante la actualización.	No
└─ uso	MemoryStoreOperationUsage	Estadísticas de uso asociadas a la operación de actualización de memoria.	No
estado	objeto	Estado de una operación de actualización del almacén de memoria.	Sí
superseded_by	cuerda / cadena	El update_id en que la operación fue reemplazada por cuando el estado es "reemplazado".	No
update_id	cuerda / cadena	El identificador único de esta solicitud de actualización. Use este valor como previous_update_id en solicitudes posteriores para realizar actualizaciones incrementales.	Sí

MemoryStoreUpdateStatus

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

Propiedad	Importancia
Descripción	Estado de una operación de actualización del almacén de memoria.
Tipo	cuerda / cadena
Valores	`queued` `in_progress` `completed` `failed` `superseded`

MicrosoftFabricAgentTool

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

Nombre	Tipo	Description	Obligatorio
fabric_dataagent_preview	objeto	Los parámetros de la herramienta Fabric Data Agent.	Sí
└" project_connections	array	Las conexiones del proyecto asociadas a esta herramienta. Puede haber un máximo de 1 conexión. recurso asociado a la herramienta.	No
type	enum	Tipo de objeto, que siempre es "fabric_dataagent". Valores posibles: `fabric_dataagent_preview`	Sí

ModelDeployment

Definición de implementación de modelo

Nombre	Tipo	Description	Obligatorio
capabilities	objeto	Capacidades del modelo implementado	Sí
connectionName	cuerda / cadena	Nombre de la conexión de la que procede la implementación	No
modelName	cuerda / cadena	Nombre específico del editor del modelo implementado	Sí
modelPublisher	cuerda / cadena	Nombre del publicador del modelo implementado	Sí
modelVersion	cuerda / cadena	Versión específica del editor del modelo implementado	Sí
sku	objeto	Información de SKU	Sí
Capacidad └	entero	Capacidad de SKU	No
Familia └	cuerda / cadena	Familia de SKU	No
└─ Nombre	cuerda / cadena	Nombre de SKU	No
Tamaño └	cuerda / cadena	Tamaño de SKU	No
Nivel └	cuerda / cadena	Nivel de SKU	No
type	enum	El tipo de 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
max_completion_tokens	entero	Número máximo de tokens permitidos en la finalización.	Sí
seed	entero	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
max_completion_tokens	entero	Número máximo de tokens permitidos en la finalización.	No
seed	entero	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	array	Días del mes para el programa de periodicidad.	Sí
type	enum	Tipo de recurrencia 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í

OAuthConsentRequestItemResource

Solicite al usuario que realice el consentimiento de OAuth desde el servicio.

Nombre	Tipo	Description	Obligatorio
consent_link	cuerda / cadena	Vínculo que el usuario puede usar para realizar el consentimiento de OAuth.	Sí
id	cuerda / cadena		Sí
etiqueta del servidor	cuerda / cadena	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	cuerda / cadena	Zona horaria para el desencadenador único.	No	Tiempo Universal Coordinado (UTC)
triggerAt	cuerda / cadena	Fecha y hora del disparador único en formato ISO 8601.	Sí
type	enum	Valores posibles: `OneTime`	Sí

OpenAI.Annotation

Discriminador para OpenAI.Annotation

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

Valor del tipo	Schema
`file_citation`	OpenAI.AnnotationFileCitation
`url_citation`	OpenAI.AnnotationUrlCitation
`file_path`	OpenAI.AnnotationFilePath

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.AnnotationType		Sí

OpenAI.AnnotationFileCitation

Cita a un archivo.

Nombre	Tipo	Description	Obligatorio
ID del archivo	cuerda / cadena	Id. del archivo.	Sí
filename	cuerda / cadena	Nombre de archivo del archivo citado.	Sí
index	entero	Índice del archivo en la lista de archivos.	Sí
type	enum	Tipo de la cita de archivo. Siempre `file_citation`. Valores posibles: `file_citation`	Sí

OpenAI.AnnotationFilePath

Ruta de acceso a un archivo.

Nombre	Tipo	Description	Obligatorio
ID del archivo	cuerda / cadena	Id. del archivo.	Sí
index	entero	Índice del archivo en la lista de archivos.	Sí
type	enum	Tipo de la ruta de acceso del archivo. Siempre `file_path`. Valores posibles: `file_path`	Sí

OpenAI.AnnotationType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	`file_citation` `url_citation` `file_path` `container_file_citation`

OpenAI.AnnotationUrlCitation

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

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

OpenAI.ApproximateLocation

Nombre	Tipo	Description	Obligatorio
city	cuerda / cadena		No
country	cuerda / cadena		No
region	cuerda / cadena		No
zona horaria	cuerda / cadena		No
type	enum	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.CodeInterpreterOutput

Discriminador para OpenAI.CodeInterpreterOutput

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

Valor del tipo	Schema
`image`	OpenAI.CodeInterpreterOutputImage
`logs`	OpenAI.CodeInterpreterOutputLogs

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.CodeInterpreterOutputType		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	cuerda / cadena	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	cuerda / cadena	La salida de registros del intérprete de código.	Sí
type	enum	Tipo de la salida. Siempre "logs". Valores posibles: `logs`	Sí

OpenAI.CodeInterpreterOutputType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	`logs` `image`

OpenAI.CodeInterpreterTool

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

Nombre	Tipo	Description	Obligatorio
container	objeto	Configuración de un contenedor de intérpretes de código. Opcionalmente, especifique los identificadores. de los archivos en los que se va a ejecutar el código.	Sí
└─ identificadores_de_archivos	array	Lista opcional de archivos cargados para que estén disponibles para tu código.	No
└─ Tipo	enum	Siempre `auto`. Valores posibles: `auto`	No
type	enum	Tipo de la herramienta de intérprete de código. Siempre `code_interpreter`. Valores posibles: `code_interpreter`	Sí

OpenAI.CodeInterpreterToolAuto

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
identificadores de archivos	array	Lista opcional de archivos cargados para que estén disponibles para tu código.	No
type	enum	Siempre `auto`. Valores posibles: `auto`	Sí

OpenAI.CodeInterpreterToolCallItemParam

Una llamada de herramienta para ejecutar código.

Nombre	Tipo	Description	Obligatorio
código	cuerda / cadena	Código que se va a ejecutar o null si no está disponible.	Sí
container_id	cuerda / cadena	Identificador del contenedor usado para ejecutar el código.	Sí
outputs	array	Salidas generadas por el intérprete de código, como registros o imágenes. Puede ser null si no hay ninguna salida disponible.	Sí
type	enum	Valores posibles: `code_interpreter_call`	Sí

OpenAI.CodeInterpreterToolCallItemResource

Una llamada de herramienta para ejecutar código.

Nombre	Tipo	Description	Obligatorio
código	cuerda / cadena	Código que se va a ejecutar o null si no está disponible.	Sí
container_id	cuerda / cadena	Identificador del contenedor usado para ejecutar el código.	Sí
outputs	array	Salidas generadas por el intérprete de código, como registros o imágenes. Puede ser null si no hay ninguna salida disponible.	Sí
estado	enum	Valores posibles: `in_progress`, `completed`, `incomplete`, , `interpreting`, `failed`	Sí
type	enum	Valores posibles: `code_interpreter_call`	Sí

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
key	cuerda / cadena	Clave que se va a comparar con el valor.	Sí
type	enum	Especifica el operador de comparación: `eq` (igual), `ne` (no igual), `gt` (mayor que), `gte` (mayor o igual), `lt` (menor que), `lte` (menor o igual que). Valores posibles: `eq`, `ne`, `gt`, `gte`, , `lt`, `lte`	Sí
valor	cadena o número o booleano		Sí

OpenAI.CompoundFilter

Combine varios filtros mediante and o or.

Nombre	Tipo	Description	Obligatorio	Predeterminado
filters	array	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:

Valor del tipo	Schema
`click`	OpenAI.ComputerActionClick
`double_click`	OpenAI.ComputerActionDoubleClick
`drag`	OpenAI.ComputerActionDrag
`move`	OpenAI.ComputerActionMove
`screenshot`	OpenAI.ComputerActionScreenshot
`scroll`	OpenAI.ComputerActionScroll
`type`	OpenAI.ComputerActionTypeKeys
`wait`	OpenAI.ComputerActionWait
`keypress`	OpenAI.ComputerActionKeyPress

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ComputerActionType		Sí

OpenAI.ComputerActionClick

Una acción de clic.

Nombre	Tipo	Description	Obligatorio
button	enum	Indica qué botón del mouse se ha presionado durante el clic. Uno de estos valores: `left`, `right`, `wheel`, `back` o `forward`. Valores posibles: `left`, `right`, `wheel`, , `back`, `forward`	Sí
type	enum	Especifica el tipo de evento. Para una acción de clic, esta propiedad es establezca siempre en `click`. Valores posibles: `click`	Sí
x	entero	Coordenada x donde se produjo el clic.	Sí
y	entero	Coordenada y donde se produjo el clic.	Sí

OpenAI.ComputerActionDoubleClick

Una acción de doble clic.

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

OpenAI.ComputerActionDrag

Una acción de arrastre.

Nombre	Tipo	Description	Obligatorio	Predeterminado
ruta	array	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.ComputerActionKeyPress

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
keys	array	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 pulsación de teclas, esta propiedad es establezca siempre en `keypress`. Valores posibles: `keypress`	Sí

OpenAI.ComputerActionMove

Una acción de movimiento del mouse.

Nombre	Tipo	Description	Obligatorio
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	entero	Coordenada x a la que se va a mover.	Sí
y	entero	Coordenada y a la que se va a mover.	Sí

OpenAI.ComputerActionScreenshot

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

Una acción de desplazamiento.

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

OpenAI.ComputerActionType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	`screenshot` `click` `double_click` `scroll` `type` `wait` `keypress` `drag` `move`

OpenAI.ComputerActionTypeKeys

Acción para escribir texto.

Nombre	Tipo	Description	Obligatorio	Predeterminado
texto	cuerda / cadena	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.ComputerActionWait

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

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

Nombre	Tipo	Description	Obligatorio
acción	OpenAI.ComputerAction		Sí
call_id	cuerda / cadena	Identificador que se usa al responder a la llamada de herramienta con salida.	Sí
pending_safety_checks	array	Las comprobaciones de seguridad pendientes para la llamada al equipo.	Sí
type	enum	Valores posibles: `computer_call`	Sí

OpenAI.ComputerToolCallItemResource

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

Nombre	Tipo	Description	Obligatorio
acción	OpenAI.ComputerAction		Sí
call_id	cuerda / cadena	Identificador que se usa al responder a la llamada de herramienta con salida.	Sí
pending_safety_checks	array	Las comprobaciones de seguridad pendientes para la llamada al equipo.	Sí
estado	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	Valores posibles: `computer_call`	Sí

OpenAI.ComputerToolCallOutputItemOutput

Discriminador para OpenAI.ComputerToolCallOutputItemOutput

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

Valor del tipo	Schema
`computer_screenshot`	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ComputerToolCallOutputItemOutputType	Imagen de captura de pantalla del equipo que se usa con la herramienta de uso del equipo.	Sí

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Nombre	Tipo	Description	Obligatorio
ID del archivo	cuerda / cadena		No
image_url	cuerda / cadena		No
type	enum	Valores posibles: `computer_screenshot`	Sí

OpenAI.ComputerToolCallOutputItemOutputType

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

Propiedad	Importancia
Descripción	Imagen de captura de pantalla del equipo que se usa con la herramienta de uso del equipo.
Tipo	cuerda / cadena
Valores	`computer_screenshot`

OpenAI.ComputerToolCallOutputItemParam

Salida de una llamada a una herramienta de equipo.

Nombre	Tipo	Description	Obligatorio
acknowledged_safety_checks	array	Las comprobaciones de seguridad notificadas por la API que han sido confirmadas por desarrollador.	No
call_id	cuerda / cadena	Identificador de la llamada a la herramienta de equipo que generó la salida.	Sí
output	OpenAI.ComputerToolCallOutputItemOutput		Sí
type	enum	Valores posibles: `computer_call_output`	Sí

OpenAI.ComputerToolCallOutputItemResource

Salida de una llamada a una herramienta de equipo.

Nombre	Tipo	Description	Obligatorio
acknowledged_safety_checks	array	Las comprobaciones de seguridad notificadas por la API que han sido confirmadas por desarrollador.	No
call_id	cuerda / cadena	Identificador de la llamada a la herramienta de equipo que generó la salida.	Sí
output	OpenAI.ComputerToolCallOutputItemOutput		Sí
estado	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	Valores posibles: `computer_call_output`	Sí

OpenAI.ComputerToolCallSafetyCheck

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

Nombre	Tipo	Description	Obligatorio
código	cuerda / cadena	Tipo de comprobación de seguridad pendiente.	Sí
id	cuerda / cadena	Identificador de la comprobación de seguridad pendiente.	Sí
Mensaje	cuerda / cadena	Detalles sobre la comprobación de seguridad pendiente.	Sí

OpenAI.HerramientaDeVistaPreviaDeUsoDeComputadora

Herramienta que controla un equipo virtual.

Nombre	Tipo	Description	Obligatorio
altura_de_pantalla	entero	La altura de la pantalla del ordenador.	Sí
ancho_de_pantalla	entero	Ancho de la pantalla del equipo.	Sí
environment	enum	Tipo de entorno de equipo que se va a controlar. Valores posibles: `windows`, `mac`, `linux`, , `ubuntu`, `browser`	Sí
type	enum	Tipo de la herramienta para el uso de la computadora. Siempre `computer_use_preview`. Valores posibles: `computer_use_preview`	Sí

OpenAI.ConversationItemList

Nombre	Tipo	Description	Obligatorio
datos	array		Sí
first_id	cuerda / cadena		Sí
has_more	booleano		Sí
last_id	cuerda / cadena		Sí
objeto	enum	Valores posibles: `list`	Sí

OpenAI.ConversationResource

Nombre	Tipo	Description	Obligatorio
fecha_de_creación	entero		Sí
id	cuerda / cadena	El id. único de la conversación.	Sí
metadata	objeto	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í
objeto	enum	Tipo de objeto, que siempre es "conversación". Valores posibles: `conversation`	Sí

OpenAI.Coordinate

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

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

OpenAI.CreateConversationRequest

Creación de una conversación

Nombre	Tipo	Description	Obligatorio	Predeterminado
items	array	Elementos iniciales para incluir el contexto de conversación. Puede agregar hasta 20 elementos a la vez.	No
metadata	objeto	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
mensajes de entrada	objeto		No
└─ referencia_elemento	cuerda / cadena		No
└─ Plantilla	array		No
└─ Tipo	enum	Valores posibles: `item_reference`	No
modelo	cuerda / cadena	Nombre del modelo que se va a usar para generar finalizaciones (por ejemplo, "o3-mini").	No
parámetros_de_muestreo	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		No
source	objeto		Sí
└─ Contenido	array	Contenido del archivo jsonl.	No
└─ creado_después	OpenAI.integer		No
└─ creado_antes	OpenAI.integer		No
└─ id.	cuerda / cadena	Identificador del archivo.	No
└─ límite	OpenAI.integer		No
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.	No
└─ modelo	cuerda / cadena		No
└─ Tipo	enum	Tipo de origen. Siempre `stored_completions`. Valores posibles: `stored_completions`	No
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	cuerda / cadena		Sí
type	enum	Valores posibles: `item_reference`	Sí

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Nombre	Tipo	Description	Obligatorio	Predeterminado
template	array		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 los modelos de razonamiento. Actualmente, los valores admitidos no son ninguno, mínimo, bajo, medio y alto. 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 tiene como valor predeterminado ninguno, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son ninguno, bajo, medio y alto. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1. Todos los modelos anteriores a gpt-5.1 tienen como valor predeterminado el esfuerzo de razonamiento medio y no admiten ninguno. El modelo gpt-5-pro tiene como valor predeterminado (y solo admite) un alto esfuerzo de razonamiento.	No
formato_de_respuesta	objeto	Formato de respuesta predeterminado. Se usa para generar respuestas de texto.	No
└" json_schema	objeto	Opciones de configuración de salidas estructuradas, incluido un esquema JSON.	No
└─ Descripción	cuerda / cadena	Descripción del propósito del formato de respuesta que usa el modelo determine cómo responder en el formato.	No
└─ Nombre	cuerda / cadena	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.	No
└─ Esquema	objeto		No
└─ estricto	booleano	Indica si se debe habilitar la adhesión estricta al esquema al generar la salida. Si se establece en true, el modelo siempre seguirá el esquema exacto definido. en el campo `schema`. Solo se admite un subconjunto de esquema JSON cuando `strict` es `true`. Para más información, lea las guía de salidas estructuradas.	No	Falso
└─ Tipo	enum	Tipo de formato de respuesta que se va a definir. Siempre `json_object`. Valores posibles: `json_object`	No
seed	objeto		No
temperatura	objeto		No
herramientas	array		No
top_p	objeto		No

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
incluir_esquema_de_muestra	booleano	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	objeto	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
source	objeto		Sí
└─ Contenido	array	Contenido del archivo jsonl.	No
└─ id.	cuerda / cadena	Identificador del archivo.	No
└─ Tipo	enum	Tipo de origen jsonl. Siempre `file_id`. Valores posibles: `file_id`	No
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
metadata	objeto	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
mensajes de entrada	objeto		No
└─ referencia_elemento	cuerda / cadena		No
└─ Plantilla	array		No
└─ Tipo	enum	Valores posibles: `item_reference`	No
modelo	cuerda / cadena	Nombre del modelo que se va a usar para generar finalizaciones (por ejemplo, "o3-mini").	No
parámetros_de_muestreo	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		No
source	objeto		Sí
└─ Contenido	array	Contenido del archivo jsonl.	No
└─ creado_después	OpenAI.integer		No
└─ creado_antes	OpenAI.integer		No
└─ id.	cuerda / cadena	Identificador del archivo.	No
└─ instrucciones_búsqueda	cuerda / cadena		No
Metadatos └	objeto		No
└─ modelo	cuerda / cadena		No
└─ esfuerzo_de_razonamiento	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Actualmente, los valores admitidos no son ninguno, mínimo, bajo, medio y alto. 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 tiene como valor predeterminado ninguno, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son ninguno, bajo, medio y alto. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1. Todos los modelos anteriores a gpt-5.1 tienen como valor predeterminado el esfuerzo de razonamiento medio y no admiten ninguno. El modelo gpt-5-pro tiene como valor predeterminado (y solo admite) un alto esfuerzo de razonamiento.	No
└─ Temperatura	OpenAI.numeric		No
└─ herramientas	array		No
└─ top_p	OpenAI.numeric		No
└─ Tipo	enum	Tipo de origen de datos de ejecución. Siempre `responses`. Valores posibles: `responses`	No
└─ usuarios	array		No
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	cuerda / cadena		Sí
type	enum	Valores posibles: `item_reference`	Sí

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

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

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Nombre	Tipo	Description	Obligatorio
max_completion_tokens	OpenAI.integer		No
esfuerzo de razonamiento	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Actualmente, los valores admitidos no son ninguno, mínimo, bajo, medio y alto. 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 tiene como valor predeterminado ninguno, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son ninguno, bajo, medio y alto. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1. Todos los modelos anteriores a gpt-5.1 tienen como valor predeterminado el esfuerzo de razonamiento medio y no admiten ninguno. El modelo gpt-5-pro tiene como valor predeterminado (y solo admite) un alto esfuerzo de razonamiento.	No
seed	objeto		No
temperatura	objeto		No
texto	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		No
herramientas	array		No
top_p	objeto		No

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

Nombre	Tipo	Description	Obligatorio	Predeterminado
format	OpenAI.TextResponseFormatConfiguration	Objeto que especifica el formato que debe generar el modelo. La configuración de `{ "type": "json_schema" }` habilita salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON proporcionado. Más información en la 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. Uso de `json_schema` es preferible para los modelos que lo admiten.	No

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

En desuso en favor de LogsDataSourceConfig.

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadata	objeto	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	objeto	Hiperparámetros usados para el trabajo de ajuste preciso. Este valor ahora está en desuso en favor de `method` y debe pasarse bajo el parámetro `method`.	No
└─ batch_size	enum	Valores posibles: `auto`	No
"└─ learning_rate_multiplier"	enum	Valores posibles: `auto`	No
├─ n_epochs	enum	Valores posibles: `auto`	No
Integraciones	array	Lista de integraciones que se habilitarán para el trabajo de ajuste preciso.	No
metadata	objeto	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
modelo	string (consulte los modelos válidos a continuación)	Nombre del modelo que se va a ajustar. Puede seleccionar uno de los modelos admitidos.	Sí
seed	entero	La semilla controla la reproducibilidad del trabajo. Pasar los mismos parámetros de inicialización y trabajo debe generar los mismos resultados, pero puede diferir en raras ocasiones. Si no se especifica una semilla, se generará una para ti.	No
sufijo	cuerda / cadena	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`.	No	Ninguno
archivo_de_entrenamiento	cuerda / cadena	El Id. de un archivo cargado que contiene datos de entrenamiento. El conjunto de datos debe tener el formato de un archivo JSONL. Además, debe cargar su archivo con el propósito de `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. Consulte la guía de ajuste para obtener más detalles.	Sí
archivo_de_validación	cuerda / cadena	El Id. de un archivo cargado que contenga datos de validación. Si proporciona este archivo, los datos se usan para generar las métricas de validación 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 de un archivo JSONL. Debe cargar el archivo con el propósito `fine-tune`. Consulte la guía de ajuste para obtener más detalles.	No

OpenAI.CreateFineTuningJobRequestIntegration

Discriminador para OpenAI.CreateFineTuningJobRequestIntegration

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

Valor del tipo	Schema
`wandb`	OpenAI.CreateFineTuningJobRequestWandbIntegration

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	string (consulte los modelos válidos a continuación)		Sí

OpenAI.CreateFineTuningJobRequestWandbIntegration

Nombre	Tipo	Description	Obligatorio
type	enum	Valores posibles: `wandb`	Sí
wandb	objeto		Sí
└─ entidad	cuerda / cadena		No
└─ Nombre	cuerda / cadena		No
└─ proyecto	cuerda / cadena		No
└─ etiquetas	array		No

OpenAI.CreateResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent	objeto		No
└─ Nombre	cuerda / cadena	Nombre del agente.	No
└─ Tipo	enum	Valores posibles: `agent_reference`	No
└─ versión	cuerda / cadena	Identificador de versión del agente.	No
background	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano. Obtenga más información sobre las respuestas en segundo plano.	No	Falso
conversación	objeto		No
└─ id.	cuerda / cadena		No
incluir	array	Especifique datos de salida adicionales que se incluirán en la respuesta del modelo. Actualmente Los valores admitidos son: - `code_interpreter_call.outputs`: incluye las salidas de la ejecución de código de Python en elementos de llamada de 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 . llamada a la herramienta de búsqueda de archivos. - `message.input_image.image_url`: incluya las URL de las imágenes del mensaje de entrada. - `message.output_text.logprobs`: incluya logprobs con mensajes de asistente. - `reasoning.encrypted_content`: incluye una versión cifrada de razonamiento tokens en salidas de elemento de razonamiento. Esto permite usar elementos de razonamiento en conversaciones multiturno al usar la API de respuestas sin estado (por ejemplo, cuando el `store` parámetro se establece en `false`, o cuando una organización es inscrito en el programa de retención de datos cero).	No
entrada	cadena o matriz		No
instructions	cuerda / cadena	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Cuando se usa junto con `previous_response_id`, las instrucciones de un elemento anterior la respuesta no se transferirá a la siguiente respuesta. Esto hace que sea sencillo para intercambiar mensajes del sistema (o desarrollador) en nuevas respuestas.	No
max_output_tokens	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
max_tool_calls	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
metadata	objeto	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	cuerda / cadena	Implementación del modelo que se va a usar para la creación de esta respuesta.	No
parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	No	Cierto
previous_response_id	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno. Más información sobre administrar el estado de la conversación.	No
inmediato	objeto	Referencia a una plantilla de solicitud y sus variables. Más información.	No
└─ id.	cuerda / cadena	Identificador único de la plantilla de solicitud que se va a usar.	No
Variables └	OpenAI.ResponsePromptVariables	Asignación opcional de valores que se sustituyen por las variables de la solicitud. Los valores de sustitución pueden ser cadenas u otros tipos de entrada de respuesta como imágenes o archivos.	No
└─ versión	cuerda / cadena	Versión opcional de la plantilla de solicitud.	No
reasoning	objeto	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└─ esfuerzo	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Actualmente, los valores admitidos no son ninguno, mínimo, bajo, medio y alto. 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 tiene como valor predeterminado ninguno, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son ninguno, bajo, medio y alto. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1. Todos los modelos anteriores a gpt-5.1 tienen como valor predeterminado el esfuerzo de razonamiento medio y no admiten ninguno. El modelo gpt-5-pro tiene como valor predeterminado (y solo admite) un alto esfuerzo de razonamiento.	No
└─ generar_resumen	enum	Obsoleto: use `summary` en su lugar. Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno de`auto`, `concise` o `detailed`. Valores posibles: `auto`, `concise`, `detailed`	No
└─ resumen	enum	Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno de`auto`, `concise` o `detailed`. Valores posibles: `auto`, `concise`, `detailed`	No
nivel de servicio	objeto	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 del proyecto. A menos que se configure lo contrario, project usará "default". * Si se establece en "default", la solicitud se procesará con el estándar. precios y rendimiento del modelo seleccionado. * Si se establece en 'flex' o "prioridad", la solicitud se procesará con el servicio correspondiente. nivel. Póngase en contacto con las ventas para obtener más información sobre el procesamiento de prioridad. * 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 basado en el 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	Si se va a almacenar la respuesta del modelo generada para su recuperación posterior a través de API.	No	Cierto
flujo	booleano	Si se establece en true, los datos de respuesta del modelo se transmitirán al cliente. ya que se genera mediante eventos enviados por el servidor. para más información.	No	Falso
structured_inputs	objeto	Entradas estructuradas para la respuesta que pueden participar en enlaces de argumentos de herramienta o sustitución de plantillas de solicitud.	No
temperatura	número	Temperatura de muestreo que se vaya 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, recomendamos modificar esto o `top_p`, pero no ambos.	No	1
texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados. Consulte Entradas y salidas de texto. y salidas estructuradas	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
tool_choice	objeto	Controla la herramienta (si existe) a la que llama el modelo. `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 uno o más herramientas. `required` significa que el modelo debe llamar a una o varias herramientas.	No
└─ Tipo	OpenAI.ToolChoiceObjectType	Indica que el modelo debe usar una herramienta integrada para generar una respuesta. Obtenga más información sobre las herramientas integradas.	No
herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda de archivos. - Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, habilitando el modelo para llamar a su propio código.	No
top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	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, recomendamos modificar esto o `temperature`, pero no ambos.	No	1
truncation	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - `auto`: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará el respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en en medio de la conversación. - `disabled` (valor predeterminado): si una respuesta del modelo superará la ventana de contexto el tamaño de un modelo, la solicitud producirá un error 400. Valores posibles: `auto`, `disabled`	No
user	cuerda / cadena	Obtenga más información sobre los procedimientos recomendados de seguridad.	No

OpenAI.DeletedConversationResource

Nombre	Tipo	Description	Obligatorio
eliminado	booleano		Sí
id	cuerda / cadena		Sí
objeto	enum	Valores posibles: `conversation.deleted`	Sí

OpenAI.EasyInputMessage

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	cadena o matriz		Sí
role	cuerda / cadena		Sí

OpenAI.Error

Nombre	Tipo	Obligatorio
información adicional	objeto	No
código	cuerda / cadena	Sí
Información de depuración	objeto	No
details	array	No
Mensaje	cuerda / cadena	Sí
param	cuerda / cadena	Sí
type	cuerda / cadena	Sí

OpenAI.EvalApiError

Objeto que representa una respuesta de error de la API de Eval.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	cuerda / cadena	Código de error.	Sí
Mensaje	cuerda / cadena	El mensaje de error.	Sí

OpenAI.EvalGraderLabelModel

Nombre	Tipo	Description	Obligatorio
entrada	array		Sí
labels	array	Etiquetas que se van a asignar a cada elemento de la evaluación.	Sí
modelo	cuerda / cadena	Modelo que se va a usar para la evaluación. Debe admitir salidas estructuradas.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
passing_labels	array	Las etiquetas que indican un resultado aprobado. Debe ser un subconjunto de etiquetas.	Sí
type	enum	Tipo de objeto, que siempre es `label_model`. Valores posibles: `label_model`	Sí

OpenAI.EvalGraderPython

Nombre	Tipo	Description	Obligatorio
image_tag	cuerda / cadena	Etiqueta de imagen que se va a usar para el script de Python.	No
nombre	cuerda / cadena	Nombre del calificador.	Sí
pass_threshold	objeto		No
source	cuerda / cadena	Código fuente del script de Python.	Sí
type	enum	Tipo de objeto, que siempre es `python`. Valores posibles: `python`	Sí

OpenAI.EvalGraderScoreModel

Nombre	Tipo	Description	Obligatorio
entrada	array	Texto de entrada. Esto puede incluir cadenas de plantilla.	Sí
modelo	cuerda / cadena	Modelo que se va a usar para la evaluación.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
pass_threshold	objeto		No
rango	array	El rango de la puntuación. Tiene como valor predeterminado `[0, 1]`.	No
parámetros_de_muestreo	objeto		No
└" max_completions_tokens	OpenAI.integer		No
└─ esfuerzo_de_razonamiento	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Actualmente, los valores admitidos no son ninguno, mínimo, bajo, medio y alto. 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 tiene como valor predeterminado ninguno, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son ninguno, bajo, medio y alto. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1. Todos los modelos anteriores a gpt-5.1 tienen como valor predeterminado el esfuerzo de razonamiento medio y no admiten ninguno. El modelo gpt-5-pro tiene como valor predeterminado (y solo admite) un alto esfuerzo de razonamiento.	No
└— semilla	OpenAI.integer		No
└─ Temperatura	OpenAI.numeric		No
└─ top_p	OpenAI.numeric		No
type	enum	Tipo de objeto, que siempre es `score_model`. Valores posibles: `score_model`	Sí

OpenAI.EvalGraderScoreModelSamplingParams

Nombre	Tipo	Description	Obligatorio
max_completions_tokens	objeto		No
esfuerzo de razonamiento	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Actualmente, los valores admitidos no son ninguno, mínimo, bajo, medio y alto. 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 tiene como valor predeterminado ninguno, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son ninguno, bajo, medio y alto. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1. Todos los modelos anteriores a gpt-5.1 tienen como valor predeterminado el esfuerzo de razonamiento medio y no admiten ninguno. El modelo gpt-5-pro tiene como valor predeterminado (y solo admite) un alto esfuerzo de razonamiento.	No
seed	objeto		No
temperatura	objeto		No
top_p	objeto		No

OpenAI.EvalGraderStringCheck

Nombre	Tipo	Description	Obligatorio
entrada	cuerda / cadena	Texto de entrada. Esto puede incluir cadenas de plantilla.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
operation	enum	Operación de comprobación de cadena que se va a realizar. Uno de los siguientes: `eq`, `ne`, `like` o `ilike`. Valores posibles: `eq`, `ne`, `like`, `ilike`	Sí
referencia	cuerda / cadena	Texto de referencia. Esto puede incluir cadenas de plantilla.	Sí
type	enum	Tipo de objeto, que siempre es `string_check`. Valores posibles: `string_check`	Sí

OpenAI.EvalGraderTextSimilarity

Nombre	Tipo	Description	Obligatorio
métrica de evaluación	enum	Métrica de evaluación que se va a usar. Uno de `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í
entrada	cuerda / cadena	Texto que se va a calificar.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
pass_threshold	objeto		Sí
referencia	cuerda / cadena	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
contenido	objeto	Entrada de texto al modelo.	Sí
└─ datos	cuerda / cadena	Datos de audio codificados en Base64.	No
└─ detalle	cuerda / cadena		No
└─ Formato	enum	Formato de los datos de audio. Los formatos admitidos actualmente son `mp3` y `wav`. Valores posibles: `mp3`, `wav`	No
└─ image_url	cuerda / cadena		No
└─ texto	cuerda / cadena		No
└─ Tipo	enum	Tipo del elemento de entrada. Siempre `input_audio`. Valores posibles: `input_audio`	No
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.EvalItemContentInputImage

Nombre	Tipo	Description	Obligatorio
detail	cuerda / cadena		No
image_url	cuerda / cadena		Sí
type	enum	Valores posibles: `input_image`	Sí

OpenAI.EvalItemContentOutputText

Nombre	Tipo	Description	Obligatorio	Predeterminado
texto	cuerda / cadena		Sí
type	enum	Valores posibles: `output_text`	Sí

OpenAI.EvalJsonlFileContentSource

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	array	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	objeto		Sí
muestra	objeto		No

OpenAI.EvalJsonlFileIdSource

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	cuerda / cadena	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
created_after	objeto		No
creado_antes_de	objeto		No
instructions_search	cuerda / cadena		No
metadata	objeto		No
modelo	cuerda / cadena		No
esfuerzo de razonamiento	objeto	Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Actualmente, los valores admitidos no son ninguno, mínimo, bajo, medio y alto. 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 tiene como valor predeterminado ninguno, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son ninguno, bajo, medio y alto. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1. Todos los modelos anteriores a gpt-5.1 tienen como valor predeterminado el esfuerzo de razonamiento medio y no admiten ninguno. El modelo gpt-5-pro tiene como valor predeterminado (y solo admite) un alto esfuerzo de razonamiento.	No
temperatura	objeto		No
herramientas	array		No
top_p	objeto		No
type	enum	Tipo de origen de datos de ejecución. Siempre `responses`. Valores posibles: `responses`	Sí
users	array		No

OpenAI.EvalRunOutputItemSample

Nombre	Tipo	Description	Obligatorio
error	OpenAI.EvalApiError	Objeto que representa una respuesta de error de la API de Eval.	Sí
razón de finalización	cuerda / cadena		Sí
entrada	array		Sí
max_completion_tokens	OpenAI.integer		Sí
modelo	cuerda / cadena		Sí
output	array		Sí
seed	OpenAI.integer		Sí
temperatura	OpenAI.numeric		Sí
top_p	OpenAI.numeric		Sí
usage	OpenAI.EvalRunOutputItemSampleUsage		Sí

OpenAI.EvalRunOutputItemSampleInput

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	cuerda / cadena		Sí
role	cuerda / cadena		Sí

OpenAI.EvalRunOutputItemSampleOutput

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	cuerda / cadena		No
role	cuerda / cadena		No

OpenAI.EvalRunOutputItemSampleUsage

Nombre	Tipo	Obligatorio
cached_tokens	OpenAI.integer	Sí
completion_tokens	OpenAI.integer	Sí
prompt_tokens	OpenAI.integer	Sí
total_tokens	OpenAI.integer	Sí

OpenAI.EvalRunPerModelUsage

Nombre	Tipo	Obligatorio
cached_tokens	OpenAI.integer	Sí
completion_tokens	OpenAI.integer	Sí
invocation_count	OpenAI.integer	Sí
model_name	cuerda / cadena	Sí
prompt_tokens	OpenAI.integer	Sí
total_tokens	OpenAI.integer	Sí

OpenAI.EvalRunPerTestingCriteriaResults

Nombre	Tipo	Obligatorio
fallido	OpenAI.integer	Sí
Pasado	OpenAI.integer	Sí
criterios_de_prueba	cuerda / cadena	Sí

OpenAI.EvalRunResultCounts

Nombre	Tipo	Obligatorio
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
created_after	objeto		No
creado_antes_de	objeto		No
limit	objeto		No
metadata	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.	No
modelo	cuerda / cadena		No
type	enum	Tipo de origen. Siempre `stored_completions`. Valores posibles: `stored_completions`	Sí

OpenAI.FileSearchTool

Herramienta que busca contenido relevante de los archivos cargados.

Nombre	Tipo	Description	Obligatorio
filters	objeto		No
número_máximo_de_resultados	entero	El número máximo de resultados que se devolverán. Este número debe estar comprendido entre 1 y 50 inclusive.	No
opciones_de_clasificación	objeto		No
└─ clasificador	enum	Clasificador que se va a usar para la búsqueda de archivos. Valores posibles: `auto`, `default-2024-11-15`	No
└─ umbral_de_puntuación	número	Umbral de puntuación para la búsqueda de archivos, un número comprendido entre 0 y 1. Los números más cercanos a 1 intentarán devolver solo los resultados más relevantes, pero pueden devolver menos resultados.	No
type	enum	Tipo de la herramienta de búsqueda de archivos. Siempre `file_search`. Valores posibles: `file_search`	Sí
vector_store_ids	array	Identificadores de los almacenes vectoriales que se van a buscar.	Sí

OpenAI.FileSearchToolCallItemParam

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
queries	array	Las consultas usadas para buscar archivos.	Sí
results	array	Resultados de la llamada a la herramienta de búsqueda de archivos.	No
type	enum	Valores posibles: `file_search_call`	Sí

OpenAI.FileSearchToolCallItemResource

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
queries	array	Las consultas usadas para buscar archivos.	Sí
results	array	Resultados de la llamada a la herramienta de búsqueda de archivos.	No
estado	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	Valores posibles: `file_search_call`	Sí

OpenAI.Filters

Nombre	Tipo	Description	Obligatorio
filters	array	Conjunto de filtros para combinar. Los elementos pueden ser `ComparisonFilter` o `CompoundFilter`.	Sí
key	cuerda / cadena	Clave que se va a comparar con el valor.	Sí
type	enum	Tipo de operación: `and` o `or`. Valores posibles: `and`, `or`	Sí
valor	cadena o número o booleano	Valor que se va a comparar con la clave de atributo; admite tipos de cadena, número o booleano.	Sí

OpenAI.FineTuneDPOHyperparameters

Hiperparámetros usados para el trabajo de ajuste preciso de DPO.

Nombre	Tipo	Description	Obligatorio
tamaño del lote	enum	Valores posibles: `auto`	No
beta	enum	Valores posibles: `auto`	No
multiplicador_de_tasa_de_aprendizaje	enum	Valores posibles: `auto`	No
n_epochs (número de épocas)	enum	Valores posibles: `auto`	No

OpenAI.FineTuneDPOMethod

Configuración para el método de ajuste preciso de DPO.

Nombre	Tipo	Description	Obligatorio	Predeterminado
hiperparámetros	OpenAI.FineTuneDPOHyperparameters	Hiperparámetros usados para el trabajo de ajuste preciso de DPO.	No

OpenAI.FineTuneMethod

Método que se usa para ajustar.

Nombre	Tipo	Description	Obligatorio
dpo	OpenAI.FineTuneDPOMethod	Configuración para el método de ajuste preciso 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 preciso supervisado.	No
type	enum	Tipo de método. Es `supervised`, `dpo`, o `reinforcement`. Valores posibles: `supervised`, `dpo`, `reinforcement`	Sí

OpenAI.FineTuneReinforcementHyperparameters

Los hiperparámetros usados para el trabajo de ajuste preciso de refuerzo.

Nombre	Tipo	Description	Obligatorio
tamaño del lote	enum	Valores posibles: `auto`	No
compute_multiplier	enum	Valores posibles: `auto`	No
eval_interval	enum	Valores posibles: `auto`	No
eval_samples	enum	Valores posibles: `auto`	No
multiplicador_de_tasa_de_aprendizaje	enum	Valores posibles: `auto`	No
n_epochs (número de épocas)	enum	Valores posibles: `auto`	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
evaluador	objeto	Objeto StringCheckGrader que realiza una comparación de cadenas entre la entrada y la referencia mediante una operación especificada.	Sí
└─ calcular_salida	cuerda / cadena	Fórmula para calcular la salida en función de los resultados del evaluador.	No
└─ métrica_de_evaluación	enum	Métrica de evaluación que se va a usar. Uno de `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`	No
└─ evaluadores	OpenAI.GraderStringCheck o OpenAI.GraderTextSimilarity o OpenAI.GraderPython o OpenAI.GraderScoreModel o OpenAI.GraderLabelModel	Objeto StringCheckGrader que realiza una comparación de cadenas entre la entrada y la referencia mediante una operación especificada.	No
└" image_tag	cuerda / cadena	Etiqueta de imagen que se va a usar para el script de Python.	No
└─ Entrada	array	Texto de entrada. Esto puede incluir cadenas de plantilla.	No
└─ modelo	cuerda / cadena	Modelo que se va a usar para la evaluación.	No
└─ Nombre	cuerda / cadena	Nombre del calificador.	No
└─ operación	enum	Operación de comprobación de cadena que se va a realizar. Uno de los siguientes: `eq`, `ne`, `like` o `ilike`. Valores posibles: `eq`, `ne`, `like`, `ilike`	No
└─ intervalo	array	El rango de la puntuación. Tiene como valor predeterminado `[0, 1]`.	No
└─ referencia	cuerda / cadena	Texto con el que se va a calificar.	No
└─ parámetros_de_muestreo	OpenAI.EvalGraderScoreModelSamplingParams	Parámetros de muestreo para el modelo.	No
└─ Origen	cuerda / cadena	Código fuente del script de Python.	No
└─ Tipo	enum	Tipo de objeto, que siempre es `multi`. Valores posibles: `multi`	No
hiperparámetros	OpenAI.FineTuneReinforcementHyperparameters	Los hiperparámetros usados para el trabajo de ajuste preciso de refuerzo.	No

OpenAI.FineTuneSupervisedHyperparameters

Hiperparámetros usados para el trabajo de ajuste preciso.

Nombre	Tipo	Description	Obligatorio
tamaño del lote	enum	Valores posibles: `auto`	No
multiplicador_de_tasa_de_aprendizaje	enum	Valores posibles: `auto`	No
n_epochs (número de épocas)	enum	Valores posibles: `auto`	No

OpenAI.FineTuneSupervisedMethod

Configuración del método de ajuste preciso supervisado.

Nombre	Tipo	Description	Obligatorio	Predeterminado
hiperparámetros	OpenAI.FineTuneSupervisedHyperparameters	Hiperparámetros usados para el trabajo de ajuste preciso.	No

OpenAI.FineTuningIntegration

Discriminador para OpenAI.FineTuningIntegration

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

Valor del tipo	Schema
`wandb`	OpenAI.FineTuningIntegrationWandb

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	string (consulte los modelos válidos a continuación)		Sí

OpenAI.FineTuningIntegrationWandb

Nombre	Tipo	Description	Obligatorio
type	enum	Tipo de integración que se está habilitada para el trabajo de ajuste preciso Valores posibles: `wandb`	Sí
wandb	objeto	La configuración de la integración con Weights y Biases. Esta carga especifica el proyecto al que se enviarán métricas. Opcionalmente, puede establecer un nombre para mostrar explícito para la ejecución, agregar etiquetas a la ejecución y establecer una entidad predeterminada (equipo, nombre de usuario, etc.) que se asociará a la ejecución.	Sí
└─ entidad	cuerda / cadena	Entidad que se va a usar para la ejecución. Esto le permite establecer el equipo o el nombre de usuario del usuario wandB que quiere que se asocie a la ejecución. Si no se establece, se usa la entidad predeterminada para la clave de API wandB registrada.	No
└─ Nombre	cuerda / cadena	Nombre para mostrar que se va a establecer para la ejecución. Si no se establece, usaremos el identificador de trabajo como nombre.	No
└─ proyecto	cuerda / cadena	Nombre del proyecto en el que se creará la nueva ejecución.	No
└─ etiquetas	array	Lista de etiquetas que se van a adjuntar a la ejecución recién creada. Estas etiquetas se pasan directamente a WandB. Some OpenAI genera etiquetas predeterminadas: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".	No

OpenAI.FineTuningJob

El objeto fine_tuning.job representa un trabajo de ajuste preciso que se ha creado a través de la API.

Nombre	Tipo	Description	Obligatorio
fecha_de_creación	entero	Marca de tiempo de Unix (en segundos) para cuando se creó el trabajo de ajuste.	Sí
error	objeto	Para los trabajos de ajuste preciso que tienen `failed`, esto contendrá más información sobre la causa del error.	Sí
└─ código	cuerda / cadena	Código de error legible por máquina.	No
└─ Mensaje	cuerda / cadena	Mensaje de error legible.	No
└— param	cuerda / cadena	Parámetro que no era válido, normalmente `training_file` o `validation_file`. Este campo será null si el error no era específico del parámetro.	No
fin estimado	entero	Marca de tiempo de Unix (en segundos) para cuando se estima que finalizará el trabajo de ajuste. El valor será null si el trabajo de ajuste fino no se está ejecutando.	No
fine_tuned_model	cuerda / cadena	Nombre del modelo optimizado que se va a crear. El valor será null si el trabajo de ajuste se sigue ejecutando.	Sí
finished_at	entero	Marca de tiempo de Unix (en segundos) para cuando se finalizó el trabajo de ajuste. El valor será null si el trabajo de ajuste se sigue ejecutando.	Sí
hiperparámetros	objeto	Hiperparámetros usados para el trabajo de ajuste preciso. Este valor solo se devolverá cuando se ejecuten `supervised` trabajos.	Sí
└─ batch_size	enum	Valores posibles: `auto`	No
"└─ learning_rate_multiplier"	enum	Valores posibles: `auto`	No
├─ n_epochs	enum	Valores posibles: `auto`	No
id	cuerda / cadena	Identificador de objeto, al que se puede hacer referencia en los puntos de conexión de API.	Sí
Integraciones	array	Lista de integraciones que se habilitarán para este trabajo de ajuste preciso.	No
metadata	objeto	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í
method	OpenAI.FineTuneMethod	Método que se usa para ajustar.	No
modelo	cuerda / cadena	Modelo base que se está ajustando.	Sí
objeto	enum	Tipo de objeto, que siempre es "fine_tuning.job". Valores posibles: `fine_tuning.job`	Sí
organization_id	cuerda / cadena	La organización que posee el trabajo de ajuste preciso.	Sí
archivos_de_resultados	array	Identificadores de archivo de resultados compilados para el trabajo de ajuste preciso. Puede recuperar los resultados con la API de los archivos.	Sí
seed	entero	Valor de inicialización utilizado para el trabajo de ajuste preciso.	Sí
estado	enum	Estado actual del trabajo de ajuste, que puede ser `validating_files`, `queued`, `running`, `succeeded`, `failed` o `cancelled`. Valores posibles: `validating_files`, `queued`, `running`, `succeeded`, , `failed`, `cancelled`	Sí
trained_tokens	entero	Número total de tokens facturables procesados por este trabajo de ajuste preciso. El valor será null si el trabajo de ajuste se sigue ejecutando.	Sí
archivo_de_entrenamiento	cuerda / cadena	Identificador de archivo usado para el entrenamiento. Puede recuperar los datos de entrenamiento con la API de archivos.	Sí
user_provided_suffix	cuerda / cadena	Sufijo descriptivo aplicado al trabajo, tal como se especifica en la solicitud de creación de trabajos.	No
archivo_de_validación	cuerda / cadena	Identificador de archivo usado para la validación. Puede recuperar los resultados de validación con la API de archivos.	Sí

OpenAI.FineTuningJobCheckpoint

El objeto fine_tuning.job.checkpoint representa un punto de comprobación de modelo para un trabajo de ajuste que está listo para usarse.

Nombre	Tipo	Description	Obligatorio
fecha_de_creación	entero	Marca de tiempo de Unix (en segundos) para cuando se creó el punto de comprobación.	Sí
fine_tuned_model_checkpoint	cuerda / cadena	Nombre del modelo de punto de comprobación ajustado que se crea.	Sí
fine_tuning_job_id	cuerda / cadena	El nombre del trabajo de ajuste preciso del que se creó este punto de control.	Sí
id	cuerda / cadena	Identificador de punto de comprobación, al que se puede hacer referencia en los puntos de conexión de API.	Sí
metrics	objeto	Métricas en el número de paso durante el trabajo de ajuste preciso.	Sí
└─ full_valid_loss	número		No
└─ full_valid_mean_token_accuracy	número		No
└─ paso	número		No
└─ pérdida_entrenamiento	número		No
└─ train_mean_token_accuracy	número		No
└─ valid_loss	número		No
└" valid_mean_token_accuracy	número		No
objeto	enum	Tipo de objeto, que siempre es "fine_tuning.job.checkpoint". Valores posibles: `fine_tuning.job.checkpoint`	Sí
número_de_paso	entero	Número de paso en el que se creó el punto de comprobación.	Sí

OpenAI.FineTuningJobEvent

Objeto de evento de trabajo de ajuste preciso

Nombre	Tipo	Description	Obligatorio
fecha_de_creación	entero	Marca de tiempo de Unix (en segundos) para cuando se creó el trabajo de ajuste.	Sí
datos		Los datos asociados al evento.	No
id	cuerda / cadena	Identificador de objeto.	Sí
nivel	enum	Nivel de registro del evento. Valores posibles: `info`, `warn`, `error`	Sí
Mensaje	cuerda / cadena	Mensaje del evento.	Sí
objeto	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.FunctionObject

Nombre	Tipo	Description	Obligatorio	Predeterminado
descripción	cuerda / cadena	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	cuerda / cadena	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		Los parámetros que aceptan las funciones, que se describen como un objeto de esquema JSON. Consulte la guía para obtener ejemplos y referencia del esquema JSON de documentación sobre el formato. Al omitir `parameters` se define una función con una lista de parámetros vacía.	No
strict	booleano	Indica si se debe habilitar el cumplimiento estricto del esquema al generar la llamada a la función. Si se establece en true, el modelo seguirá el esquema exacto definido en el campo `parameters`. Solo se admite un subconjunto del esquema JSON cuando `strict` es `true`. Más información sobre las salidas estructuradas en	No	Falso

OpenAI.FunctionTool

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

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Descripción de la función. Lo usa el modelo para determinar si se debe llamar a la función o no.	No
nombre	cuerda / cadena	El nombre de la función que se va a llamar.	Sí
parameters		Objeto de esquema JSON que describe los parámetros de la función.	Sí
strict	booleano	Si se va a aplicar la validación estricta de parámetros. El valor predeterminado es `true`.	Sí
type	enum	Tipo de la herramienta de funciones. Siempre `function`. Valores posibles: `function`	Sí

OpenAI.FunctionToolCallItemParam

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

Nombre	Tipo	Description	Obligatorio
argumentos	cuerda / cadena	Cadena JSON de los argumentos que se van a pasar a la función.	Sí
call_id	cuerda / cadena	Identificador único de la llamada a la herramienta de función generada por el modelo.	Sí
nombre	cuerda / cadena	Nombre de la función que se va a ejecutar.	Sí
type	enum	Valores posibles: `function_call`	Sí

OpenAI.FunctionToolCallItemResource

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

Nombre	Tipo	Description	Obligatorio
argumentos	cuerda / cadena	Cadena JSON de los argumentos que se van a pasar a la función.	Sí
call_id	cuerda / cadena	Identificador único de la llamada a la herramienta de función generada por el modelo.	Sí
nombre	cuerda / cadena	Nombre de la función que se va a ejecutar.	Sí
estado	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	Valores posibles: `function_call`	Sí

OpenAI.FunctionToolCallOutputItemParam

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

Nombre	Tipo	Description	Obligatorio
call_id	cuerda / cadena	Identificador único de la llamada a la herramienta de función generada por el modelo.	Sí
output	cuerda / cadena	Cadena JSON de la salida de la llamada a la herramienta de función.	Sí
type	enum	Valores posibles: `function_call_output`	Sí

OpenAI.FunctionToolCallOutputItemResource

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

Nombre	Tipo	Description	Obligatorio
call_id	cuerda / cadena	Identificador único de la llamada a la herramienta de función generada por el modelo.	Sí
output	cuerda / cadena	Cadena JSON de la salida de la llamada a la herramienta de función.	Sí
estado	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	Valores posibles: `function_call_output`	Sí

OpenAI.GraderLabelModel

Objeto LabelModelGrader que usa un modelo para asignar etiquetas a cada elemento de la evaluación.

Nombre	Tipo	Description	Obligatorio
entrada	array		Sí
labels	array	Etiquetas que se van a asignar a cada elemento de la evaluación.	Sí
modelo	cuerda / cadena	Modelo que se va a usar para la evaluación. Debe admitir salidas estructuradas.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
passing_labels	array	Las etiquetas que indican un resultado aprobado. Debe ser un subconjunto de etiquetas.	Sí
type	enum	Tipo de objeto, que siempre es `label_model`. Valores posibles: `label_model`	Sí

OpenAI.GraderMulti

Un objeto MultiGrader combina la salida de varios evaluadores para generar una sola puntuación.

Nombre	Tipo	Description	Obligatorio
calculate_output	cuerda / cadena	Fórmula para calcular la salida en función de los resultados del evaluador.	Sí
evaluadores	objeto	Objeto StringCheckGrader que realiza una comparación de cadenas entre la entrada y la referencia mediante una operación especificada.	Sí
└─ métrica_de_evaluación	enum	Métrica de evaluación que se va a usar. Uno de `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`	No
└" image_tag	cuerda / cadena	Etiqueta de imagen que se va a usar para el script de Python.	No
└─ Entrada	array		No
Etiquetas └—	array	Etiquetas que se van a asignar a cada elemento de la evaluación.	No
└─ modelo	cuerda / cadena	Modelo que se va a usar para la evaluación. Debe admitir salidas estructuradas.	No
└─ Nombre	cuerda / cadena	Nombre del calificador.	No
└─ operación	enum	Operación de comprobación de cadena que se va a realizar. Uno de los siguientes: `eq`, `ne`, `like` o `ilike`. Valores posibles: `eq`, `ne`, `like`, `ilike`	No
└" passing_labels	array	Las etiquetas que indican un resultado aprobado. Debe ser un subconjunto de etiquetas.	No
└─ intervalo	array	El rango de la puntuación. Tiene como valor predeterminado `[0, 1]`.	No
└─ referencia	cuerda / cadena	Texto con el que se va a calificar.	No
└─ parámetros_de_muestreo	OpenAI.EvalGraderScoreModelSamplingParams	Parámetros de muestreo para el modelo.	No
└─ Origen	cuerda / cadena	Código fuente del script de Python.	No
└─ Tipo	enum	Tipo de objeto, que siempre es `label_model`. Valores posibles: `label_model`	No
nombre	cuerda / cadena	Nombre del calificador.	Sí
type	enum	Tipo de objeto, que siempre es `multi`. Valores posibles: `multi`	Sí

OpenAI.GraderPython

Objeto PythonGrader que ejecuta un script de Python en la entrada.

Nombre	Tipo	Description	Obligatorio
image_tag	cuerda / cadena	Etiqueta de imagen que se va a usar para el script de Python.	No
nombre	cuerda / cadena	Nombre del calificador.	Sí
source	cuerda / cadena	Código fuente del script de Python.	Sí
type	enum	Tipo de objeto, que siempre es `python`. Valores posibles: `python`	Sí

OpenAI.GraderScoreModel

Objeto ScoreModelGrader que usa un modelo para asignar una puntuación a la entrada.

Nombre	Tipo	Description	Obligatorio
entrada	array	Texto de entrada. Esto puede incluir cadenas de plantilla.	Sí
modelo	cuerda / cadena	Modelo que se va a usar para la evaluación.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
rango	array	El rango de la puntuación. Tiene como valor predeterminado `[0, 1]`.	No
parámetros_de_muestreo	objeto		No
└" max_completions_tokens	OpenAI.integer		No
└─ esfuerzo_de_razonamiento	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Actualmente, los valores admitidos no son ninguno, mínimo, bajo, medio y alto. 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 tiene como valor predeterminado ninguno, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son ninguno, bajo, medio y alto. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1. Todos los modelos anteriores a gpt-5.1 tienen como valor predeterminado el esfuerzo de razonamiento medio y no admiten ninguno. El modelo gpt-5-pro tiene como valor predeterminado (y solo admite) un alto esfuerzo de razonamiento.	No
└— semilla	OpenAI.integer		No
└─ Temperatura	OpenAI.numeric		No
└─ top_p	OpenAI.numeric		No
type	enum	Tipo de objeto, que siempre es `score_model`. 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
entrada	cuerda / cadena	Texto de entrada. Esto puede incluir cadenas de plantilla.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
operation	enum	Operación de comprobación de cadena que se va a realizar. Uno de los siguientes: `eq`, `ne`, `like` o `ilike`. Valores posibles: `eq`, `ne`, `like`, `ilike`	Sí
referencia	cuerda / cadena	Texto de referencia. Esto puede incluir cadenas de plantilla.	Sí
type	enum	Tipo de objeto, que siempre es `string_check`. 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
métrica de evaluación	enum	Métrica de evaluación que se va a usar. Uno de `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í
entrada	cuerda / cadena	Texto que se va a calificar.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
referencia	cuerda / cadena	Texto con el que se va a calificar.	Sí
type	enum	Tipo de calificador. Valores posibles: `text_similarity`	Sí

OpenAI.ImageGenTool

Herramienta que genera imágenes mediante un modelo como gpt-image-1.

Nombre	Tipo	Description	Obligatorio	Predeterminado
background	enum	Tipo de fondo para la imagen generada. Uno de `transparent`, `opaque` o `auto`. Predeterminado: `auto`. Valores posibles: `transparent`, `opaque`, `auto`	No
máscara_de_imagen_de_entrada	objeto	Máscara opcional para inpainting. Contiene `image_url` (string, optional) y `file_id` (string, optional).	No
└─ file_id	cuerda / cadena	Identificador de archivo de la imagen de máscara.	No
└─ image_url	cuerda / cadena	Imagen de máscara codificada en Base64.	No
modelo	enum	Modelo de generación de imágenes que se va a usar. Predeterminado: `gpt-image-1`. Valores posibles: `gpt-image-1`	No
moderation	enum	Nivel de moderación de la imagen generada. Predeterminado: `auto`. Valores posibles: `auto`, `low`	No
compresión_de_salida	entero	Nivel de compresión de la imagen de salida. Valor predeterminado: 100.	No	100
formato_de_salida	enum	Formato de salida de la imagen generada. Uno de `png`, `webp`, o `jpeg`. Predeterminado: `png`. Valores posibles: `png`, `webp`, `jpeg`	No
imágenes_parciales	entero	Número de imágenes parciales que se van a generar en modo de streaming, de 0 (valor predeterminado) a 3.	No	0
calidad	enum	Calidad de la imagen generada. Uno de `low`, `medium`, `high`, o `auto`. Predeterminado: `auto`. Valores posibles: `low`, `medium`, `high`, `auto`	No
tamaño	enum	Tamaño de la imagen generada. Uno de estos valores: `1024x1024`, `1024x1536`, `1536x1024` o `auto`. 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.ImageGenToolCallItemParam

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
resultado	cuerda / cadena	Imagen generada codificada en base64.	Sí
type	enum	Valores posibles: `image_generation_call`	Sí

OpenAI.ImageGenToolCallItemResource

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

Nombre	Tipo	Description	Obligatorio
resultado	cuerda / cadena	Imagen generada codificada en base64.	Sí
estado	enum	Valores posibles: `in_progress`, `completed`, `generating`, `failed`	Sí
type	enum	Valores posibles: `image_generation_call`	Sí

OpenAI.Includable

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

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	Importancia
Descripción	Especifique datos de salida adicionales que se incluirán en la respuesta del modelo. Actualmente Los valores admitidos son: - `code_interpreter_call.outputs`: incluye las salidas de la ejecución de código de Python en elementos de llamada de 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 . llamada a la herramienta de búsqueda de archivos. - `message.input_image.image_url`: incluya las URL de las imágenes del mensaje de entrada. - `message.output_text.logprobs`: incluya logprobs con mensajes de asistente. - `reasoning.encrypted_content`: incluye una versión cifrada de razonamiento tokens en salidas de elemento de razonamiento. Esto permite usar elementos de razonamiento en conversaciones multiturno al usar la API de respuestas sin estado (por ejemplo, cuando el `store` parámetro se establece en `false`, o cuando una organización es inscrito en el programa de retención de datos cero).
Tipo	cuerda / cadena
Valores	`code_interpreter_call.outputs` `computer_call_output.output.image_url` `file_search_call.results` `message.input_image.image_url` `message.output_text.logprobs` `reasoning.encrypted_content` `web_search_call.results` `web_search_call.action.sources` `memory_search_call.results`

OpenAI.ItemContent

Discriminador para OpenAI.ItemContent

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

Valor del tipo	Schema
`input_audio`	OpenAI.ItemContentInputAudio
`output_audio`	OpenAI.ItemContentOutputAudio
`refusal`	OpenAI.ItemContentRefusal
`input_text`	OpenAI.ItemContentInputText
`input_image`	OpenAI.ItemContentInputImage
`input_file`	OpenAI.ItemContentInputFile
`output_text`	OpenAI.ItemContentOutputText

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ItemContentType	Contenidos de entrada y salida multimodales.	Sí

OpenAI.ItemContentInputAudio

Entrada de audio al modelo.

Nombre	Tipo	Description	Obligatorio
datos	cuerda / cadena	Datos de audio codificados en Base64.	Sí
format	enum	Formato de los datos de audio. Los formatos admitidos actualmente son `mp3` y `wav`. Valores posibles: `mp3`, `wav`	Sí
type	enum	Tipo del elemento de entrada. Siempre `input_audio`. Valores posibles: `input_audio`	Sí

OpenAI.ItemContentInputFile

Entrada de archivo para el modelo.

Nombre	Tipo	Description	Obligatorio
file_data	cuerda / cadena	Contenido del archivo que se va a enviar al modelo.	No
ID del archivo	cuerda / cadena	Identificador del archivo que se va a enviar al modelo.	No
filename	cuerda / cadena	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.ItemContentInputImage

Entrada de imagen en el modelo. Obtén información sobre las entradas de imágenes.

Nombre	Tipo	Description	Obligatorio
detail	enum	Nivel de detalle de la imagen que se va a enviar al modelo. Uno de`high`, `low` o `auto`. Tiene como valor predeterminado `auto`. Valores posibles: `low`, `high`, `auto`	No
ID del archivo	cuerda / cadena	Identificador del archivo que se va a enviar al modelo.	No
image_url	cuerda / cadena	Dirección URL de la imagen que se va a enviar al modelo. Una URL completamente calificada o una imagen codificada en base64 en un URL de datos.	No
type	enum	Tipo del elemento de entrada. Siempre `input_image`. Valores posibles: `input_image`	Sí

OpenAI.ItemContentInputText

Entrada de texto al modelo.

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

OpenAI.ItemContentOutputAudio

Salida de audio del modelo.

Nombre	Tipo	Description	Obligatorio
datos	cuerda / cadena	Datos del modelo codificados en audio Base64.	Sí
transcript	cuerda / cadena	Transcripción de los datos de audio del modelo.	Sí
type	enum	Tipo del audio de salida. Siempre `output_audio`. Valores posibles: `output_audio`	Sí

OpenAI.ItemContentOutputText

Salida de texto del modelo.

Nombre	Tipo	Description	Obligatorio
Anotaciones	array	Anotaciones de la salida de texto.	Sí
logprobs	array		No
texto	cuerda / cadena	Salida de texto del modelo.	Sí
type	enum	Tipo del texto de salida. Siempre `output_text`. Valores posibles: `output_text`	Sí

OpenAI.ItemContentRefusal

Una negativa del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
refusal	cuerda / cadena	Explicación de denegación del modelo.	Sí
type	enum	Tipo de denegación. Siempre `refusal`. Valores posibles: `refusal`	Sí

OpenAI.ItemContentType

Contenidos de entrada y salida multimodales.

Propiedad	Importancia
Descripción	Contenidos de entrada y salida multimodales.
Tipo	cuerda / cadena
Valores	`input_text` `input_audio` `input_image` `input_file` `output_text` `output_audio` `refusal`

OpenAI.ItemParam

Elemento de contenido usado para generar una respuesta.

Discriminador para OpenAI.ItemParam

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

Valor del tipo	Schema
`message`	OpenAI.ResponsesMessageItemParam
`function_call_output`	OpenAI.FunctionToolCallOutputItemParam
`file_search_call`	OpenAI.FileSearchToolCallItemParam
`computer_call`	OpenAI.ComputerToolCallItemParam
`computer_call_output`	OpenAI.ComputerToolCallOutputItemParam
`web_search_call`	OpenAI.WebSearchToolCallItemParam
`function_call`	OpenAI.FunctionToolCallItemParam
`reasoning`	OpenAI.ReasoningItemParam
`item_reference`	OpenAI.ItemReferenceItemParam
`image_generation_call`	OpenAI.ImageGenToolCallItemParam
`code_interpreter_call`	OpenAI.CodeInterpreterToolCallItemParam
`local_shell_call`	OpenAI.LocalShellToolCallItemParam
`local_shell_call_output`	OpenAI.LocalShellToolCallOutputItemParam
`mcp_list_tools`	OpenAI.MCPListToolsItemParam
`mcp_approval_request`	OpenAI.MCPApprovalRequestItemParam
`mcp_approval_response`	OpenAI.MCPApprovalResponseItemParam
`mcp_call`	OpenAI.MCPCallItemParam
`memory_search_call`	MemorySearchToolCallItemParam

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ItemType		Sí

OpenAI.ItemReferenceItemParam

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	cuerda / cadena	ID generado por el servicio del elemento de respuesta previamente generado al que se hace referencia.	Sí
type	enum	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:

Valor del tipo	Schema
`structured_outputs`	StructuredOutputsItemResource
`workflow_action`	WorkflowActionOutputItemResource
`oauth_consent_request`	OAuthConsentRequestItemResource
`message`	OpenAI.ResponsesMessageItemResource
`computer_call_output`	OpenAI.ComputerToolCallOutputItemResource
`function_call`	OpenAI.FunctionToolCallItemResource
`function_call_output`	OpenAI.FunctionToolCallOutputItemResource
`mcp_approval_response`	OpenAI.MCPApprovalResponseItemResource
`file_search_call`	OpenAI.FileSearchToolCallItemResource
`computer_call`	OpenAI.ComputerToolCallItemResource
`web_search_call`	OpenAI.WebSearchToolCallItemResource
`reasoning`	OpenAI.ReasoningItemResource
`image_generation_call`	OpenAI.ImageGenToolCallItemResource
`code_interpreter_call`	OpenAI.CodeInterpreterToolCallItemResource
`local_shell_call`	OpenAI.LocalShellToolCallItemResource
`local_shell_call_output`	OpenAI.LocalShellToolCallOutputItemResource
`mcp_list_tools`	OpenAI.MCPListToolsItemResource
`mcp_approval_request`	OpenAI.MCPApprovalRequestItemResource
`mcp_call`	OpenAI.MCPCallItemResource
`memory_search_call`	MemorySearchToolCallItemResource

Nombre	Tipo	Description	Obligatorio
created_by	objeto		No
Agente └	AgentId	Agente que creó el elemento.	No
└" response_id	cuerda / cadena	Respuesta en la que se crea el elemento.	No
id	cuerda / cadena		Sí
type	OpenAI.ItemType		Sí

OpenAI.ItemType

Propiedad Importancia

Tipo cuerda / cadena

Valores message
file_search_call
function_call
function_call_output
computer_call
computer_call_output
web_search_call
reasoning
item_reference
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
structured_outputs
workflow_action
memory_search_call
oauth_consent_request

OpenAI.ListFineTuningJobCheckpointsResponse

Nombre	Tipo	Description	Obligatorio
datos	array		Sí
first_id	cuerda / cadena		No
has_more	booleano		Sí
last_id	cuerda / cadena		No
objeto	enum	Valores posibles: `list`	Sí

OpenAI.ListFineTuningJobEventsResponse

Nombre	Tipo	Description	Obligatorio
datos	array		Sí
has_more	booleano		Sí
objeto	enum	Valores posibles: `list`	Sí

OpenAI.ListPaginatedFineTuningJobsResponse

Nombre	Tipo	Description	Obligatorio
datos	array		Sí
has_more	booleano		Sí
objeto	enum	Valores posibles: `list`	Sí

OpenAI.LocalShellExecAction

Ejecute un comando de shell en el servidor.

Nombre	Tipo	Description	Obligatorio
command	array	El comando que se va a ejecutar.	Sí
Entorno	objeto	Variables de entorno que se van a establecer para el comando.	Sí
tiempo_de_espera_ms	entero	Tiempo de espera opcional en milisegundos para el comando.	No
type	enum	Tipo de la acción de shell local. Siempre `exec`. Valores posibles: `exec`	Sí
user	cuerda / cadena	Usuario opcional como el cual ejecutar el comando.	No
working_directory	cuerda / cadena	Directorio de trabajo opcional en el que ejecutar el comando.	No

OpenAI.LocalShellTool

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

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

Nombre	Tipo	Description	Obligatorio
acción	OpenAI.LocalShellExecAction	Ejecute un comando de shell en el servidor.	Sí
call_id	cuerda / cadena	Identificador único de la llamada de herramienta de shell local generada por el modelo.	Sí
type	enum	Valores posibles: `local_shell_call`	Sí

OpenAI.LocalShellToolCallItemResource

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

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

OpenAI.LocalShellToolCallOutputItemParam

Salida de una llamada a la herramienta de shell local.

Nombre	Tipo	Description	Obligatorio	Predeterminado
output	cuerda / cadena	Cadena JSON de la salida de la llamada a la herramienta de shell local.	Sí
type	enum	Valores posibles: `local_shell_call_output`	Sí

OpenAI.LocalShellToolCallOutputItemResource

Salida de una llamada a la herramienta de shell local.

Nombre	Tipo	Description	Obligatorio
output	cuerda / cadena	Cadena JSON de la salida de la llamada a la herramienta de shell local.	Sí
estado	enum	Valores posibles: `in_progress`, `completed`, `incomplete`	Sí
type	enum	Valores posibles: `local_shell_call_output`	Sí

OpenAI.Location

Discriminador para OpenAI.Location

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

Valor del tipo	Schema
`approximate`	OpenAI.ApproximateLocation

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.LocationType		Sí

OpenAI.LocationType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	`approximate`

OpenAI.LogProb

Probabilidad de registro de un token.

Nombre	Tipo	Obligatorio
bytes	array	Sí
logprob	número	Sí
token	cuerda / cadena	Sí
top_logprobs	array	Sí

OpenAI.MCPApprovalRequestItemParam

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

Nombre	Tipo	Description	Obligatorio
argumentos	cuerda / cadena	Cadena JSON de argumentos para la herramienta.	Sí
nombre	cuerda / cadena	Nombre de la herramienta que se va a ejecutar.	Sí
etiqueta del servidor	cuerda / cadena	Etiqueta del servidor MCP que realiza la solicitud.	Sí
type	enum	Valores posibles: `mcp_approval_request`	Sí

OpenAI.MCPApprovalRequestItemResource

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

Nombre	Tipo	Description	Obligatorio
argumentos	cuerda / cadena	Cadena JSON de argumentos para la herramienta.	Sí
nombre	cuerda / cadena	Nombre de la herramienta que se va a ejecutar.	Sí
etiqueta del servidor	cuerda / cadena	Etiqueta del servidor MCP que realiza la solicitud.	Sí
type	enum	Valores posibles: `mcp_approval_request`	Sí

OpenAI.MCPApprovalResponseItemParam

Respuesta a una solicitud de aprobación de MCP.

Nombre	Tipo	Description	Obligatorio
approval_request_id	cuerda / cadena	Identificador de la solicitud de aprobación que está siendo respondida.	Sí
aprobar	booleano	Si se aprobó la solicitud.	Sí
reason	cuerda / cadena	Motivo opcional de la decisión.	No
type	enum	Valores posibles: `mcp_approval_response`	Sí

OpenAI.MCPApprovalResponseItemResource

Respuesta a una solicitud de aprobación de MCP.

Nombre	Tipo	Description	Obligatorio
approval_request_id	cuerda / cadena	Identificador de la solicitud de aprobación que está siendo respondida.	Sí
aprobar	booleano	Si se aprobó la solicitud.	Sí
reason	cuerda / cadena	Motivo opcional de la decisión.	No
type	enum	Valores posibles: `mcp_approval_response`	Sí

OpenAI.MCPCallItemParam

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

Nombre	Tipo	Description	Obligatorio
argumentos	cuerda / cadena	Cadena JSON de los argumentos pasados a la herramienta.	Sí
error	cuerda / cadena	Error de la llamada a la herramienta, si existe.	No
nombre	cuerda / cadena	Nombre de la herramienta que se ejecutó.	Sí
output	cuerda / cadena	Salida de la llamada a la herramienta.	No
etiqueta del servidor	cuerda / cadena	Etiqueta del servidor MCP que ejecuta la herramienta.	Sí
type	enum	Valores posibles: `mcp_call`	Sí

OpenAI.MCPCallItemResource

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

Nombre	Tipo	Description	Obligatorio
argumentos	cuerda / cadena	Cadena JSON de los argumentos pasados a la herramienta.	Sí
error	cuerda / cadena	Error de la llamada a la herramienta, si existe.	No
nombre	cuerda / cadena	Nombre de la herramienta que se ejecutó.	Sí
output	cuerda / cadena	Salida de la llamada a la herramienta.	No
etiqueta del servidor	cuerda / cadena	Etiqueta del servidor MCP que ejecuta la herramienta.	Sí
type	enum	Valores posibles: `mcp_call`	Sí

OpenAI.MCPListToolsItemParam

Lista de herramientas disponibles en un servidor MCP.

Nombre	Tipo	Description	Obligatorio
error	cuerda / cadena	Mensaje de error si el servidor no pudo enumerar las herramientas.	No
etiqueta del servidor	cuerda / cadena	Etiqueta del servidor MCP.	Sí
herramientas	array	Las herramientas disponibles en el servidor.	Sí
type	enum	Valores posibles: `mcp_list_tools`	Sí

OpenAI.MCPListToolsItemResource

Lista de herramientas disponibles en un servidor MCP.

Nombre	Tipo	Description	Obligatorio
error	cuerda / cadena	Mensaje de error si el servidor no pudo enumerar las herramientas.	No
etiqueta del servidor	cuerda / cadena	Etiqueta del servidor MCP.	Sí
herramientas	array	Las herramientas disponibles en el servidor.	Sí
type	enum	Valores posibles: `mcp_list_tools`	Sí

OpenAI.MCPListToolsTool

Una herramienta disponible en un servidor MCP.

Nombre	Tipo	Description	Obligatorio
Anotaciones		Anotaciones adicionales sobre la herramienta.	No
descripción	cuerda / cadena	Descripción de la herramienta.	No
input_schema		Esquema JSON que describe la entrada de la herramienta.	Sí
nombre	cuerda / cadena	Nombre de la herramienta.	Sí

OpenAI.MCPTool

Conceda al modelo acceso a herramientas adicionales a través de servidores remotos del Protocolo de contexto de modelo (MCP). Obtenga más información sobre MCP.

Nombre	Tipo	Description	Obligatorio
herramientas_permitidas	objeto		No
└─ nombres_de_herramientas	array	Lista de nombres de herramientas permitidos.	No
headers	objeto	Encabezados HTTP opcionales para enviar al servidor MCP. Uso para la autenticación u otros propósitos.	No
project_connection_id	cuerda / cadena	El ID de conexión en el proyecto 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)	Especifique cuál de las herramientas del servidor MCP requiere aprobación.	No
etiqueta del servidor	cuerda / cadena	Etiqueta para este servidor MCP, que se usa para identificarlo en las llamadas a herramientas.	Sí
server_url	cuerda / cadena	Dirección URL del servidor MCP.	Sí
type	enum	Tipo de la herramienta MCP. Siempre `mcp`. Valores posibles: `mcp`	Sí

OpenAI.Metadata

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

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

Nombre	Tipo	Description	Obligatorio
id	cuerda / cadena	Identificador único de la plantilla de solicitud que se va a usar.	Sí
variables	objeto	Asignación opcional de valores que se sustituyen por las variables de la solicitud. Los valores de sustitución pueden ser cadenas u otros tipos de entrada de respuesta como imágenes o archivos.	No
version	cuerda / cadena	Versión opcional de la plantilla de solicitud.	No

OpenAI.RankingOptions

Nombre	Tipo	Description	Obligatorio	Predeterminado
clasificador	enum	Clasificador que se va a usar para la búsqueda de archivos. Valores posibles: `auto`, `default-2024-11-15`	No
umbral de puntuación	número	Umbral de puntuación para la búsqueda de archivos, un número comprendido entre 0 y 1. Los números más cercanos a 1 intentarán devolver solo los resultados más relevantes, pero pueden devolver menos resultados.	No

OpenAI.Reasoning

Solo modelos de la serie o

Opciones de configuración para modelos de razonamiento.

Nombre	Tipo	Description	Obligatorio
effort	objeto	Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Actualmente, los valores admitidos no son ninguno, mínimo, bajo, medio y alto. 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 tiene como valor predeterminado ninguno, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son ninguno, bajo, medio y alto. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1. Todos los modelos anteriores a gpt-5.1 tienen como valor predeterminado el esfuerzo de razonamiento medio y no admiten ninguno. El modelo gpt-5-pro tiene como valor predeterminado (y solo admite) un alto esfuerzo de razonamiento.	No
generate_summary	enum	Obsoleto: use `summary` en su lugar. Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno de`auto`, `concise` o `detailed`. Valores posibles: `auto`, `concise`, `detailed`	No
summary	enum	Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno de`auto`, `concise` o `detailed`. Valores posibles: `auto`, `concise`, `detailed`	No

OpenAI.ReasoningEffort

Restringe el esfuerzo en el razonamiento de los modelos de razonamiento.

Actualmente, los valores admitidos no son ninguno, mínimo, bajo, medio y alto.

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 tiene como valor predeterminado ninguno, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son ninguno, bajo, medio y alto. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1.

Todos los modelos anteriores a gpt-5.1 tienen como valor predeterminado el esfuerzo de razonamiento medio y no admiten ninguno.

El modelo gpt-5-pro tiene como valor predeterminado (y solo admite) un alto esfuerzo de razonamiento.

Propiedad	Importancia
Descripción	Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Actualmente, los valores admitidos no son ninguno, mínimo, bajo, medio y alto. 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 tiene como valor predeterminado ninguno, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son ninguno, bajo, medio y alto. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1. Todos los modelos anteriores a gpt-5.1 tienen como valor predeterminado el esfuerzo de razonamiento medio y no admiten ninguno. El modelo gpt-5-pro tiene como valor predeterminado (y solo admite) un alto esfuerzo de razonamiento.
Tipo	cuerda / cadena
Valores	`none` `minimal` `low` `medium` `high`

OpenAI.ReasoningItemParam

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

Nombre	Tipo	Description	Obligatorio
encrypted_content	cuerda / cadena	El contenido cifrado del elemento de razonamiento, rellenado cuando se proporciona una respuesta generado con `reasoning.encrypted_content` en el `include` parámetro .	No
summary	array	Contenido del texto de razonamiento.	Sí
type	enum	Valores posibles: `reasoning`	Sí

OpenAI.ReasoningItemResource

Nombre	Tipo	Description	Obligatorio
encrypted_content	cuerda / cadena	El contenido cifrado del elemento de razonamiento, rellenado cuando se proporciona una respuesta generado con `reasoning.encrypted_content` en el `include` parámetro .	No
summary	array	Contenido del texto de razonamiento.	Sí
type	enum	Valores posibles: `reasoning`	Sí

OpenAI.ReasoningItemSummaryPart

Discriminador para OpenAI.ReasoningItemSummaryPart

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

Valor del tipo	Schema
`summary_text`	OpenAI.ReasoningItemSummaryTextPart

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ReasoningItemSummaryPartType		Sí

OpenAI.ReasoningItemSummaryPartType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	`summary_text`

OpenAI.ReasoningItemSummaryTextPart

Nombre	Tipo	Description	Obligatorio	Predeterminado
texto	cuerda / cadena		Sí
type	enum	Valores posibles: `summary_text`	Sí

OpenAI.Response

Nombre	Tipo	Description	Obligatorio	Predeterminado
agent	objeto		No
└─ Nombre	cuerda / cadena	Nombre del agente.	No
└─ Tipo	enum	Valores posibles: `agent_id`	No
└─ versión	cuerda / cadena	Identificador de versión del agente.	No
background	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano. Obtenga más información sobre las respuestas en segundo plano.	No	Falso
conversación	objeto		Sí
└─ id.	cuerda / cadena		No
fecha_de_creación	entero	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
error	objeto	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	Sí
└─ código	OpenAI.ResponseErrorCode	Código de error de la respuesta.	No
└─ Mensaje	cuerda / cadena	Una descripción legible del error.	No
id	cuerda / cadena	Identificador único de esta respuesta.	Sí
incomplete_details	objeto	Detalles sobre por qué la respuesta está incompleta.	Sí
└─ Motivo	enum	Motivo por el que la respuesta está incompleta. Valores posibles: `max_output_tokens`, `content_filter`	No
instructions	cadena o matriz		Sí
max_output_tokens	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
max_tool_calls	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
metadata	objeto	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í
modelo	cuerda / cadena	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í
output	array	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 matriz `output` 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	cuerda / cadena	Propiedad de conveniencia de solo SDK que contiene la salida de texto agregada de entre todos los `output_text` elementos de la matriz `output`, si hay alguno presente. Compatible con los SDK de Python y JavaScript.	No
parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	Sí	Cierto
previous_response_id	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno. Más información sobre administrar el estado de la conversación.	No
inmediato	objeto	Referencia a una plantilla de solicitud y sus variables. Más información.	No
└─ id.	cuerda / cadena	Identificador único de la plantilla de solicitud que se va a usar.	No
Variables └	OpenAI.ResponsePromptVariables	Asignación opcional de valores que se sustituyen por las variables de la solicitud. Los valores de sustitución pueden ser cadenas u otros tipos de entrada de respuesta como imágenes o archivos.	No
└─ versión	cuerda / cadena	Versión opcional de la plantilla de solicitud.	No
reasoning	objeto	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└─ esfuerzo	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Actualmente, los valores admitidos no son ninguno, mínimo, bajo, medio y alto. 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 tiene como valor predeterminado ninguno, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son ninguno, bajo, medio y alto. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1. Todos los modelos anteriores a gpt-5.1 tienen como valor predeterminado el esfuerzo de razonamiento medio y no admiten ninguno. El modelo gpt-5-pro tiene como valor predeterminado (y solo admite) un alto esfuerzo de razonamiento.	No
└─ generar_resumen	enum	Obsoleto: use `summary` en su lugar. Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno de`auto`, `concise` o `detailed`. Valores posibles: `auto`, `concise`, `detailed`	No
└─ resumen	enum	Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno de`auto`, `concise` o `detailed`. Valores posibles: `auto`, `concise`, `detailed`	No
nivel de servicio	objeto	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 del proyecto. A menos que se configure lo contrario, project usará "default". * Si se establece en "default", la solicitud se procesará con el estándar. precios y rendimiento del modelo seleccionado. * Si se establece en 'flex' o "prioridad", la solicitud se procesará con el servicio correspondiente. nivel. Póngase en contacto con las ventas para obtener más información sobre el procesamiento de prioridad. * 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 basado en el 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 estos valores: `completed`, `failed`, `in_progress`, `cancelled`, `queued` o `incomplete`. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
structured_inputs	objeto	Entradas estructuradas para la respuesta que pueden participar en enlaces de argumentos de herramienta o sustitución de plantillas de solicitud.	No
temperatura	número	Temperatura de muestreo que se vaya 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, recomendamos modificar esto o `top_p`, pero no ambos.	Sí
texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados. Consulte Entradas y salidas de texto. y salidas estructuradas	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
tool_choice	objeto	Controla la herramienta (si existe) a la que llama el modelo. `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 uno o más herramientas. `required` significa que el modelo debe llamar a una o varias herramientas.	No
└─ Tipo	OpenAI.ToolChoiceObjectType	Indica que el modelo debe usar una herramienta integrada para generar una respuesta. Obtenga más información sobre las herramientas integradas.	No
herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú / Usted puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: * Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda web o búsqueda de archivos. Más información sobre herramientas integradas. * Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, habilitando el modelo para llamar a su propio código. Más información sobre llamada a función.	No
top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	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, recomendamos modificar esto o `temperature`, pero no ambos.	Sí
truncation	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - `auto`: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará el respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en en medio de la conversación. - `disabled` (valor predeterminado): si una respuesta del modelo superará la ventana de contexto el tamaño de un modelo, la solicitud producirá un error 400. Valores posibles: `auto`, `disabled`	No
usage	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	cuerda / cadena	Obtenga más información sobre los procedimientos recomendados de seguridad.	Sí

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

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

Nombre	Tipo	Description	Obligatorio
delta	cuerda / cadena	Fragmento de código parcial que transmite el intérprete de código.	Sí
item_id	cuerda / cadena	Identificador único del elemento de llamada de herramienta de intérprete de código.	Sí
output_index	entero	Índice del elemento de salida en la respuesta para la que se transmite el código.	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
código	cuerda / cadena	Resultado del fragmento de código final por el intérprete de código.	Sí
item_id	cuerda / cadena	Identificador único del elemento de llamada de herramienta de intérprete de código.	Sí
output_index	entero	Índice del elemento de salida en la respuesta para la que se finaliza el código.	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
item_id	cuerda / cadena	Identificador único del elemento de llamada de herramienta de intérprete de código.	Sí
output_index	entero	Índice del elemento de salida en la respuesta para la que se completa la llamada del intérprete de código.	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
item_id	cuerda / cadena	Identificador único del elemento de llamada de herramienta de intérprete de código.	Sí
output_index	entero	Índice del elemento de salida en la respuesta para la que está en curso la llamada del intérprete de código.	Sí
type	enum	El tipo de evento. Siempre `response.code_interpreter_call.in_progress`. Valores posibles: `response.code_interpreter_call.in_progress`	Sí

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

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

Nombre	Tipo	Description	Obligatorio
item_id	cuerda / cadena	Identificador único del elemento de llamada de herramienta de intérprete de código.	Sí
output_index	entero	Índice del elemento de salida en la respuesta para la que el intérprete de código interpreta el código.	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
response	objeto		Sí
Agente └	AgentId	Agente usado para esta respuesta	No
└─ fondo	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano. Obtenga más información sobre las respuestas en segundo plano.	No	Falso
Conversación └	objeto		No
└─ id.	cuerda / cadena		No
└─ created_at	entero	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	No
└─ Error	OpenAI.ResponseError	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	No
└─ id.	cuerda / cadena	Identificador único de esta respuesta.	No
└─ detalles_incompletos	objeto	Detalles sobre por qué la respuesta está incompleta.	No
└─ Motivo	enum	Motivo por el que la respuesta está incompleta. Valores posibles: `max_output_tokens`, `content_filter`	No
└─ Instrucciones	cadena o matriz	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Cuando se usa junto con `previous_response_id`, las instrucciones de un elemento anterior la respuesta no se transferirá a la siguiente respuesta. Esto hace que sea sencillo para intercambiar mensajes del sistema (o desarrollador) en nuevas respuestas.	No
└─ max_output_tokens	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
└─ «max_tool_calls»	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
Metadatos └	objeto	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	cuerda / cadena	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`	No
└─ salida	array	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 matriz `output` 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.	No
└─ texto_de_salida	cuerda / cadena	Propiedad de conveniencia de solo SDK que contiene la salida de texto agregada de entre todos los `output_text` elementos de la matriz `output`, si hay alguno presente. Compatible con los SDK de Python y JavaScript.	No
└" parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	No	Cierto
└─ id_de_respuesta_anterior	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno. Más información sobre administrar el estado de la conversación.	No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Más información.	No
└─ razonamiento	OpenAI.Reasoning	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└" service_tier	OpenAI.ServiceTier	Nota: service_tier no es aplicable a Azure OpenAI.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de estos valores: `completed`, `failed`, `in_progress`, `cancelled`, `queued` o `incomplete`. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└" structured_inputs	objeto	Entradas estructuradas para la respuesta que pueden participar en enlaces de argumentos de herramienta o sustitución de plantillas de solicitud.	No
└─ Temperatura	número	Temperatura de muestreo que se vaya 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, recomendamos modificar esto o `top_p`, pero no ambos.	No
└─ texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados. Consulte Entradas y salidas de texto. y salidas estructuradas	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
└─ selección_de_herramienta	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
└─ herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú / Usted puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: * Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda web o búsqueda de archivos. Más información sobre herramientas integradas. * Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, habilitando el modelo para llamar a su propio código. Más información sobre llamada a función.	No
└" top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	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, recomendamos modificar esto o `temperature`, pero no ambos.	No
└─ truncamiento	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - `auto`: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará el respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en en medio de la conversación. - `disabled` (valor predeterminado): si una respuesta del modelo superará la ventana de contexto el tamaño de un modelo, la solicitud producirá un error 400. 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	cuerda / cadena	Obtenga más información sobre los procedimientos recomendados de seguridad.	No
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
content_index	entero	Índice del elemento de contenido que se agregó.	Sí
item_id	cuerda / cadena	Identificador del elemento de salida al que se agregó la parte de contenido.	Sí
output_index	entero	Índice del elemento de salida al que se agregó la parte de contenido.	Sí
part	objeto		Sí
└─ Tipo	OpenAI.ItemContentType	Contenidos de entrada y salida multimodales.	No
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
content_index	entero	Índice de la parte de contenido que se realiza.	Sí
item_id	cuerda / cadena	Identificador del elemento de salida al que se agregó la parte de contenido.	Sí
output_index	entero	Índice del elemento de salida al que se agregó la parte de contenido.	Sí
part	objeto		Sí
└─ Tipo	OpenAI.ItemContentType	Contenidos de entrada y salida multimodales.	No
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
response	objeto		Sí
Agente └	AgentId	Agente usado para esta respuesta	No
└─ fondo	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano. Obtenga más información sobre las respuestas en segundo plano.	No	Falso
Conversación └	objeto		No
└─ id.	cuerda / cadena		No
└─ created_at	entero	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	No
└─ Error	OpenAI.ResponseError	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	No
└─ id.	cuerda / cadena	Identificador único de esta respuesta.	No
└─ detalles_incompletos	objeto	Detalles sobre por qué la respuesta está incompleta.	No
└─ Motivo	enum	Motivo por el que la respuesta está incompleta. Valores posibles: `max_output_tokens`, `content_filter`	No
└─ Instrucciones	cadena o matriz	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Cuando se usa junto con `previous_response_id`, las instrucciones de un elemento anterior la respuesta no se transferirá a la siguiente respuesta. Esto hace que sea sencillo para intercambiar mensajes del sistema (o desarrollador) en nuevas respuestas.	No
└─ max_output_tokens	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
└─ «max_tool_calls»	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
Metadatos └	objeto	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	cuerda / cadena	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`	No
└─ salida	array	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 matriz `output` 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.	No
└─ texto_de_salida	cuerda / cadena	Propiedad de conveniencia de solo SDK que contiene la salida de texto agregada de entre todos los `output_text` elementos de la matriz `output`, si hay alguno presente. Compatible con los SDK de Python y JavaScript.	No
└" parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	No	Cierto
└─ id_de_respuesta_anterior	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno. Más información sobre administrar el estado de la conversación.	No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Más información.	No
└─ razonamiento	OpenAI.Reasoning	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└" service_tier	OpenAI.ServiceTier	Nota: service_tier no es aplicable a Azure OpenAI.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de estos valores: `completed`, `failed`, `in_progress`, `cancelled`, `queued` o `incomplete`. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└" structured_inputs	objeto	Entradas estructuradas para la respuesta que pueden participar en enlaces de argumentos de herramienta o sustitución de plantillas de solicitud.	No
└─ Temperatura	número	Temperatura de muestreo que se vaya 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, recomendamos modificar esto o `top_p`, pero no ambos.	No
└─ texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados. Consulte Entradas y salidas de texto. y salidas estructuradas	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
└─ selección_de_herramienta	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
└─ herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú / Usted puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: * Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda web o búsqueda de archivos. Más información sobre herramientas integradas. * Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, habilitando el modelo para llamar a su propio código. Más información sobre llamada a función.	No
└" top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	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, recomendamos modificar esto o `temperature`, pero no ambos.	No
└─ truncamiento	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - `auto`: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará el respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en en medio de la conversación. - `disabled` (valor predeterminado): si una respuesta del modelo superará la ventana de contexto el tamaño de un modelo, la solicitud producirá un error 400. 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	cuerda / cadena	Obtenga más información sobre los procedimientos recomendados de seguridad.	No
type	enum	El tipo de evento. Siempre `response.created`. Valores posibles: `response.created`	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í
Mensaje	cuerda / cadena	Una descripción legible del error.	Sí

OpenAI.ResponseErrorCode

Código de error de la respuesta.

Propiedad	Importancia
Descripción	Código de error de la respuesta.
Tipo	cuerda / cadena
Valores	`server_error` `rate_limit_exceeded` `invalid_prompt` `vector_store_timeout` `invalid_image` `invalid_image_format` `invalid_base64_image` `invalid_image_url` `image_too_large` `image_too_small` `image_parse_error` `image_content_policy_violation` `invalid_image_mode` `image_file_too_large` `unsupported_image_media_type` `empty_image_file` `failed_to_download_image` `image_file_not_found`

OpenAI.ResponseErrorEvent

Se genera cuando se produce un error.

Nombre	Tipo	Description	Obligatorio
código	cuerda / cadena	Código de error.	Sí
Mensaje	cuerda / cadena	El mensaje de error.	Sí
param	cuerda / cadena	Parámetro de error.	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
response	objeto		Sí
Agente └	AgentId	Agente usado para esta respuesta	No
└─ fondo	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano. Obtenga más información sobre las respuestas en segundo plano.	No	Falso
Conversación └	objeto		No
└─ id.	cuerda / cadena		No
└─ created_at	entero	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	No
└─ Error	OpenAI.ResponseError	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	No
└─ id.	cuerda / cadena	Identificador único de esta respuesta.	No
└─ detalles_incompletos	objeto	Detalles sobre por qué la respuesta está incompleta.	No
└─ Motivo	enum	Motivo por el que la respuesta está incompleta. Valores posibles: `max_output_tokens`, `content_filter`	No
└─ Instrucciones	cadena o matriz	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Cuando se usa junto con `previous_response_id`, las instrucciones de un elemento anterior la respuesta no se transferirá a la siguiente respuesta. Esto hace que sea sencillo para intercambiar mensajes del sistema (o desarrollador) en nuevas respuestas.	No
└─ max_output_tokens	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
└─ «max_tool_calls»	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
Metadatos └	objeto	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	cuerda / cadena	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`	No
└─ salida	array	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 matriz `output` 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.	No
└─ texto_de_salida	cuerda / cadena	Propiedad de conveniencia de solo SDK que contiene la salida de texto agregada de entre todos los `output_text` elementos de la matriz `output`, si hay alguno presente. Compatible con los SDK de Python y JavaScript.	No
└" parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	No	Cierto
└─ id_de_respuesta_anterior	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno. Más información sobre administrar el estado de la conversación.	No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Más información.	No
└─ razonamiento	OpenAI.Reasoning	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└" service_tier	OpenAI.ServiceTier	Nota: service_tier no es aplicable a Azure OpenAI.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de estos valores: `completed`, `failed`, `in_progress`, `cancelled`, `queued` o `incomplete`. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└" structured_inputs	objeto	Entradas estructuradas para la respuesta que pueden participar en enlaces de argumentos de herramienta o sustitución de plantillas de solicitud.	No
└─ Temperatura	número	Temperatura de muestreo que se vaya 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, recomendamos modificar esto o `top_p`, pero no ambos.	No
└─ texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados. Consulte Entradas y salidas de texto. y salidas estructuradas	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
└─ selección_de_herramienta	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
└─ herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú / Usted puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: * Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda web o búsqueda de archivos. Más información sobre herramientas integradas. * Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, habilitando el modelo para llamar a su propio código. Más información sobre llamada a función.	No
└" top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	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, recomendamos modificar esto o `temperature`, pero no ambos.	No
└─ truncamiento	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - `auto`: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará el respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en en medio de la conversación. - `disabled` (valor predeterminado): si una respuesta del modelo superará la ventana de contexto el tamaño de un modelo, la solicitud producirá un error 400. 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	cuerda / cadena	Obtenga más información sobre los procedimientos recomendados de seguridad.	No
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
item_id	cuerda / cadena	Identificador del elemento de salida con el que se inicia la llamada de búsqueda de archivos.	Sí
output_index	entero	Índice del elemento de salida que se inicia la llamada de búsqueda de archivos.	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
item_id	cuerda / cadena	Identificador del elemento de salida con el que se inicia la llamada de búsqueda de archivos.	Sí
output_index	entero	Índice del elemento de salida que se inicia la llamada de búsqueda de archivos.	Sí
type	enum	El tipo de evento. Siempre `response.file_search_call.in_progress`. Valores posibles: `response.file_search_call.in_progress`	Sí

OpenAI.ResponseFileSearchCallSearchingEvent

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

Nombre	Tipo	Description	Obligatorio
item_id	cuerda / cadena	Identificador del elemento de salida con el que se inicia la llamada de búsqueda de archivos.	Sí
output_index	entero	Índice del elemento de salida que la llamada de búsqueda de archivos está buscando.	Sí
type	enum	El tipo de evento. Siempre `response.file_search_call.searching`. Valores posibles: `response.file_search_call.searching`	Sí

OpenAI.ResponseFormat

Discriminador para OpenAI.ResponseFormat

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

Valor del tipo	Schema
`json_object`	OpenAI.ResponseFormatJsonObject
`json_schema`	OpenAI.ResponseFormatJsonSchema

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Valores posibles: `text`, `json_object`, `json_schema`	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 de usuario o sistema que le indique que lo haga.

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

OpenAI.ResponseFormatJsonSchema

Esquema para el formato de respuesta, descrito como un objeto de esquema JSON. Obtenga información sobre cómo compilar esquemas JSON aquí. Formato de respuesta de esquema JSON. Se usa para generar respuestas JSON estructuradas. Obtenga más información sobre las salidas estructuradas.

Nombre	Tipo	Description	Obligatorio	Predeterminado
json_schema	objeto	Opciones de configuración de salidas estructuradas, incluido un esquema JSON.	Sí
└─ Descripción	cuerda / cadena	Descripción del propósito del formato de respuesta que usa el modelo determine cómo responder en el formato.	No
└─ Nombre	cuerda / cadena	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.	No
└─ Esquema	objeto		No
└─ estricto	booleano	Indica si se debe habilitar la adhesión estricta al esquema al generar la salida. Si se establece en true, el modelo siempre seguirá el esquema exacto definido. en el campo `schema`. Solo se admite un subconjunto de esquema JSON cuando `strict` es `true`. Para más información, lea las guía de salidas estructuradas.	No	Falso
type	enum	Tipo de formato de respuesta que se va a definir. Siempre `json_schema`. Valores posibles: `json_schema`	Sí

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
delta	cuerda / cadena	Los argumentos de llamada a función delta que se agregan.	Sí
item_id	cuerda / cadena	Identificador del elemento de salida al que se agrega el delta de argumentos de llamada de función.	Sí
output_index	entero	Índice del elemento de salida al que se agrega el delta de argumentos de llamada de función.	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
argumentos	cuerda / cadena	Argumentos de llamada de función.	Sí
item_id	cuerda / cadena	Identificador del elemento.	Sí
output_index	entero	El índice del elemento de salida.	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
item_id	cuerda / cadena	Identificador único del elemento de generación de imágenes que se está procesando.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	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
item_id	cuerda / cadena	Identificador único del elemento de generación de imágenes que se está procesando.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	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
item_id	cuerda / cadena	Identificador único del elemento de generación de imágenes que se está procesando.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	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
item_id	cuerda / cadena	Identificador único del elemento de generación de imágenes que se está procesando.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
partial_image_b64	cuerda / cadena	Datos de imagen parcial codificados en Base64, adecuados para la representación como una imagen.	Sí
partial_image_index	entero	Índice basado en 0 para la imagen parcial (el back-end está basado en 1, pero se basa en 0 para el usuario).	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
response	objeto		Sí
Agente └	AgentId	Agente usado para esta respuesta	No
└─ fondo	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano. Obtenga más información sobre las respuestas en segundo plano.	No	Falso
Conversación └	objeto		No
└─ id.	cuerda / cadena		No
└─ created_at	entero	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	No
└─ Error	OpenAI.ResponseError	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	No
└─ id.	cuerda / cadena	Identificador único de esta respuesta.	No
└─ detalles_incompletos	objeto	Detalles sobre por qué la respuesta está incompleta.	No
└─ Motivo	enum	Motivo por el que la respuesta está incompleta. Valores posibles: `max_output_tokens`, `content_filter`	No
└─ Instrucciones	cadena o matriz	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Cuando se usa junto con `previous_response_id`, las instrucciones de un elemento anterior la respuesta no se transferirá a la siguiente respuesta. Esto hace que sea sencillo para intercambiar mensajes del sistema (o desarrollador) en nuevas respuestas.	No
└─ max_output_tokens	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
└─ «max_tool_calls»	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
Metadatos └	objeto	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	cuerda / cadena	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`	No
└─ salida	array	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 matriz `output` 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.	No
└─ texto_de_salida	cuerda / cadena	Propiedad de conveniencia de solo SDK que contiene la salida de texto agregada de entre todos los `output_text` elementos de la matriz `output`, si hay alguno presente. Compatible con los SDK de Python y JavaScript.	No
└" parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	No	Cierto
└─ id_de_respuesta_anterior	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno. Más información sobre administrar el estado de la conversación.	No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Más información.	No
└─ razonamiento	OpenAI.Reasoning	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└" service_tier	OpenAI.ServiceTier	Nota: service_tier no es aplicable a Azure OpenAI.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de estos valores: `completed`, `failed`, `in_progress`, `cancelled`, `queued` o `incomplete`. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└" structured_inputs	objeto	Entradas estructuradas para la respuesta que pueden participar en enlaces de argumentos de herramienta o sustitución de plantillas de solicitud.	No
└─ Temperatura	número	Temperatura de muestreo que se vaya 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, recomendamos modificar esto o `top_p`, pero no ambos.	No
└─ texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados. Consulte Entradas y salidas de texto. y salidas estructuradas	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
└─ selección_de_herramienta	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
└─ herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú / Usted puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: * Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda web o búsqueda de archivos. Más información sobre herramientas integradas. * Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, habilitando el modelo para llamar a su propio código. Más información sobre llamada a función.	No
└" top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	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, recomendamos modificar esto o `temperature`, pero no ambos.	No
└─ truncamiento	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - `auto`: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará el respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en en medio de la conversación. - `disabled` (valor predeterminado): si una respuesta del modelo superará la ventana de contexto el tamaño de un modelo, la solicitud producirá un error 400. 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	cuerda / cadena	Obtenga más información sobre los procedimientos recomendados de seguridad.	No
type	enum	El tipo de evento. Siempre `response.in_progress`. Valores posibles: `response.in_progress`	Sí

OpenAI.ResponseIncompleteEvent

Evento que se genera cuando una respuesta finaliza como incompleta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
response	objeto		Sí
Agente └	AgentId	Agente usado para esta respuesta	No
└─ fondo	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano. Obtenga más información sobre las respuestas en segundo plano.	No	Falso
Conversación └	objeto		No
└─ id.	cuerda / cadena		No
└─ created_at	entero	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	No
└─ Error	OpenAI.ResponseError	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	No
└─ id.	cuerda / cadena	Identificador único de esta respuesta.	No
└─ detalles_incompletos	objeto	Detalles sobre por qué la respuesta está incompleta.	No
└─ Motivo	enum	Motivo por el que la respuesta está incompleta. Valores posibles: `max_output_tokens`, `content_filter`	No
└─ Instrucciones	cadena o matriz	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Cuando se usa junto con `previous_response_id`, las instrucciones de un elemento anterior la respuesta no se transferirá a la siguiente respuesta. Esto hace que sea sencillo para intercambiar mensajes del sistema (o desarrollador) en nuevas respuestas.	No
└─ max_output_tokens	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
└─ «max_tool_calls»	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
Metadatos └	objeto	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	cuerda / cadena	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`	No
└─ salida	array	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 matriz `output` 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.	No
└─ texto_de_salida	cuerda / cadena	Propiedad de conveniencia de solo SDK que contiene la salida de texto agregada de entre todos los `output_text` elementos de la matriz `output`, si hay alguno presente. Compatible con los SDK de Python y JavaScript.	No
└" parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	No	Cierto
└─ id_de_respuesta_anterior	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno. Más información sobre administrar el estado de la conversación.	No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Más información.	No
└─ razonamiento	OpenAI.Reasoning	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└" service_tier	OpenAI.ServiceTier	Nota: service_tier no es aplicable a Azure OpenAI.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de estos valores: `completed`, `failed`, `in_progress`, `cancelled`, `queued` o `incomplete`. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└" structured_inputs	objeto	Entradas estructuradas para la respuesta que pueden participar en enlaces de argumentos de herramienta o sustitución de plantillas de solicitud.	No
└─ Temperatura	número	Temperatura de muestreo que se vaya 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, recomendamos modificar esto o `top_p`, pero no ambos.	No
└─ texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados. Consulte Entradas y salidas de texto. y salidas estructuradas	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
└─ selección_de_herramienta	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
└─ herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú / Usted puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: * Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda web o búsqueda de archivos. Más información sobre herramientas integradas. * Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, habilitando el modelo para llamar a su propio código. Más información sobre llamada a función.	No
└" top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	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, recomendamos modificar esto o `temperature`, pero no ambos.	No
└─ truncamiento	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - `auto`: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará el respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en en medio de la conversación. - `disabled` (valor predeterminado): si una respuesta del modelo superará la ventana de contexto el tamaño de un modelo, la solicitud producirá un error 400. 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	cuerda / cadena	Obtenga más información sobre los procedimientos recomendados de seguridad.	No
type	enum	El tipo de evento. Siempre `response.incomplete`. Valores posibles: `response.incomplete`	Sí

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
delta		Actualización parcial de los argumentos para la llamada a la herramienta MCP.	Sí
item_id	cuerda / cadena	Identificador único del elemento de llamada a la herramienta MCP que se está procesando.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	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
argumentos		Argumentos finalizados para la llamada a la herramienta MCP.	Sí
item_id	cuerda / cadena	Identificador único del elemento de llamada a la herramienta MCP que se está procesando.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	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
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
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
item_id	cuerda / cadena	Identificador único del elemento de llamada a la herramienta MCP que se está procesando.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	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
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
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
type	enum	El tipo de evento. Siempre "response.mcp_list_tools.in_progress". Valores posibles: `response.mcp_list_tools.in_progress`	Sí

OpenAI.ResponseOutputItemAddedEvent

Se genera cuando se agrega un nuevo elemento de salida.

Nombre	Tipo	Description	Obligatorio
item	objeto	Elemento de contenido usado para generar una respuesta.	Sí
└" created_by	CreadoPor	La información sobre el creador del elemento	No
└─ id.	cuerda / cadena		No
└─ Tipo	OpenAI.ItemType		No
output_index	entero	Índice del elemento de salida que se agregó.	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
item	objeto	Elemento de contenido usado para generar una respuesta.	Sí
└" created_by	CreadoPor	La información sobre el creador del elemento	No
└─ id.	cuerda / cadena		No
└─ Tipo	OpenAI.ItemType		No
output_index	entero	Índice del elemento de salida que fue marcado como completado.	Sí
type	enum	El tipo de evento. Siempre `response.output_item.done`. Valores posibles: `response.output_item.done`	Sí

OpenAI.ResponsePromptVariables

Asignación opcional de valores para sustituir por variables en la solicitud. 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
response	objeto		Sí
Agente └	AgentId	Agente usado para esta respuesta	No
└─ fondo	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano. Obtenga más información sobre las respuestas en segundo plano.	No	Falso
Conversación └	objeto		No
└─ id.	cuerda / cadena		No
└─ created_at	entero	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	No
└─ Error	OpenAI.ResponseError	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	No
└─ id.	cuerda / cadena	Identificador único de esta respuesta.	No
└─ detalles_incompletos	objeto	Detalles sobre por qué la respuesta está incompleta.	No
└─ Motivo	enum	Motivo por el que la respuesta está incompleta. Valores posibles: `max_output_tokens`, `content_filter`	No
└─ Instrucciones	cadena o matriz	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Cuando se usa junto con `previous_response_id`, las instrucciones de un elemento anterior la respuesta no se transferirá a la siguiente respuesta. Esto hace que sea sencillo para intercambiar mensajes del sistema (o desarrollador) en nuevas respuestas.	No
└─ max_output_tokens	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
└─ «max_tool_calls»	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
Metadatos └	objeto	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	cuerda / cadena	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`	No
└─ salida	array	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 matriz `output` 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.	No
└─ texto_de_salida	cuerda / cadena	Propiedad de conveniencia de solo SDK que contiene la salida de texto agregada de entre todos los `output_text` elementos de la matriz `output`, si hay alguno presente. Compatible con los SDK de Python y JavaScript.	No
└" parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	No	Cierto
└─ id_de_respuesta_anterior	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno. Más información sobre administrar el estado de la conversación.	No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables. Más información.	No
└─ razonamiento	OpenAI.Reasoning	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└" service_tier	OpenAI.ServiceTier	Nota: service_tier no es aplicable a Azure OpenAI.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de estos valores: `completed`, `failed`, `in_progress`, `cancelled`, `queued` o `incomplete`. Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	No
└" structured_inputs	objeto	Entradas estructuradas para la respuesta que pueden participar en enlaces de argumentos de herramienta o sustitución de plantillas de solicitud.	No
└─ Temperatura	número	Temperatura de muestreo que se vaya 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, recomendamos modificar esto o `top_p`, pero no ambos.	No
└─ texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados. Consulte Entradas y salidas de texto. y salidas estructuradas	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
└─ selección_de_herramienta	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject	Cómo debe el modelo seleccionar qué herramienta (o herramientas) usar al generar una respuesta. Consulte el `tools` parámetro para ver cómo especificar qué herramientas el modelo puede llamar.	No
└─ herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú / Usted puede especificar qué herramienta se va a usar estableciendo el `tool_choice` parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: * Herramientas integradas: herramientas proporcionadas por OpenAI que amplían Funcionalidades del modelo, como la búsqueda web o búsqueda de archivos. Más información sobre herramientas integradas. * Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, habilitando el modelo para llamar a su propio código. Más información sobre llamada a función.	No
└" top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	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, recomendamos modificar esto o `temperature`, pero no ambos.	No
└─ truncamiento	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - `auto`: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará el respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en en medio de la conversación. - `disabled` (valor predeterminado): si una respuesta del modelo superará la ventana de contexto el tamaño de un modelo, la solicitud producirá un error 400. 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	cuerda / cadena	Obtenga más información sobre los procedimientos recomendados de seguridad.	No
type	enum	El tipo de evento. Siempre 'response.queued'. Valores posibles: `response.queued`	Sí

OpenAI.ResponseReasoningDeltaEvent

Se genera cuando hay una diferencia (actualización parcial) al contenido de razonamiento.

Nombre	Tipo	Description	Obligatorio
content_index	entero	Índice de la parte de contenido de razonamiento dentro del elemento de salida.	Sí
delta		Actualización parcial del contenido de razonamiento.	Sí
item_id	cuerda / cadena	Identificador único del elemento para el que se actualiza el razonamiento.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
type	enum	El tipo de evento. Siempre 'response.reasoning.delta'. Valores posibles: `response.reasoning.delta`	Sí

OpenAI.ResponseReasoningDoneEvent

Se emite cuando el contenido de razonamiento se completa para un ítem.

Nombre	Tipo	Description	Obligatorio
content_index	entero	Índice de la parte de contenido de razonamiento dentro del elemento de salida.	Sí
item_id	cuerda / cadena	Identificador único del elemento para el que se finaliza el razonamiento.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
texto	cuerda / cadena	Texto de razonamiento finalizado.	Sí
type	enum	El tipo de evento. La entrada siempre es 'response.reasoning.done'. Valores posibles: `response.reasoning.done`	Sí

OpenAI.ResponseReasoningSummaryDeltaEvent

Se genera cuando hay una diferencia (actualización parcial) al contenido de resumen de razonamiento.

Nombre	Tipo	Description	Obligatorio
delta		Actualización parcial del contenido del resumen del razonamiento.	Sí
item_id	cuerda / cadena	Identificador único del elemento para el que se actualiza el resumen de razonamiento.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
summary_index	entero	Índice del elemento de resumen dentro del elemento de salida.	Sí
type	enum	El tipo de evento. Siempre 'response.reasoning_summary.delta'. Valores posibles: `response.reasoning_summary.delta`	Sí

OpenAI.ResponseReasoningSummaryDoneEvent

Se genera cuando el contenido de resumen de razonamiento se finaliza para un elemento.

Nombre	Tipo	Description	Obligatorio
item_id	cuerda / cadena	Identificador único del elemento para el que se finaliza el resumen de razonamiento.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
summary_index	entero	Índice del elemento de resumen dentro del elemento de salida.	Sí
texto	cuerda / cadena	Texto de resumen de razonamiento finalizado.	Sí
type	enum	El tipo de evento. Siempre 'response.reasoning_summary.done'. Valores posibles: `response.reasoning_summary.done`	Sí

OpenAI.ResponseReasoningSummaryPartAddedEvent

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

Nombre	Tipo	Description	Obligatorio
item_id	cuerda / cadena	El identificador del elemento al que está asociado este elemento de resumen.	Sí
output_index	entero	Índice del elemento de salida al que está asociado esta parte de resumen.	Sí
part	objeto		Sí
└─ Tipo	OpenAI.ReasoningItemSummaryPartType		No
summary_index	entero	Índice de la parte de resumen dentro del resumen de razonamiento.	Sí
type	enum	El tipo de evento. Siempre `response.reasoning_summary_part.added`. Valores posibles: `response.reasoning_summary_part.added`	Sí

OpenAI.ResponseReasoningSummaryPartDoneEvent

Se emite cuando se completa una parte del resumen de razonamiento.

Nombre	Tipo	Description	Obligatorio
item_id	cuerda / cadena	El identificador del elemento al que está asociado este elemento de resumen.	Sí
output_index	entero	Índice del elemento de salida al que está asociado esta parte de resumen.	Sí
part	objeto		Sí
└─ Tipo	OpenAI.ReasoningItemSummaryPartType		No
summary_index	entero	Índice de la parte de resumen dentro del resumen de razonamiento.	Sí
type	enum	El tipo de evento. Siempre `response.reasoning_summary_part.done`. Valores posibles: `response.reasoning_summary_part.done`	Sí

OpenAI.ResponseReasoningSummaryTextDeltaEvent

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

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

OpenAI.ResponseReasoningSummaryTextDoneEvent

Se genera cuando se completa un texto de resumen de razonamiento.

Nombre	Tipo	Description	Obligatorio
item_id	cuerda / cadena	El identificador del elemento al que está asociado este texto de resumen.	Sí
output_index	entero	Índice del elemento de salida al que está asociado este texto de resumen.	Sí
summary_index	entero	Índice de la parte de resumen dentro del resumen de razonamiento.	Sí
texto	cuerda / cadena	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.ResponseRefusalDeltaEvent

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

Nombre	Tipo	Description	Obligatorio
content_index	entero	Índice de la parte de contenido a la que se agrega el texto de denegación.	Sí
delta	cuerda / cadena	Texto de denegación que se agrega.	Sí
item_id	cuerda / cadena	Identificador del elemento de salida al que se agrega el texto de denegación.	Sí
output_index	entero	Índice del elemento de salida al que se agrega el texto de denegación.	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
content_index	entero	Índice de la parte de contenido en la que se finaliza el texto de denegación.	Sí
item_id	cuerda / cadena	Identificador del elemento de salida que finaliza el texto de denegación.	Sí
output_index	entero	Índice del elemento de salida que finaliza el texto de denegación.	Sí
refusal	cuerda / cadena	Texto de denegación finalizado.	Sí
type	enum	El tipo de evento. Siempre `response.refusal.done`. Valores posibles: `response.refusal.done`	Sí

OpenAI.ResponseStreamEvent

Discriminador para OpenAI.ResponseStreamEvent

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

Valor del tipo	Schema
`response.completed`	OpenAI.ResponseCompletedEvent
`response.content_part.added`	OpenAI.ResponseContentPartAddedEvent
`response.content_part.done`	OpenAI.ResponseContentPartDoneEvent
`response.created`	OpenAI.ResponseCreatedEvent
`error`	OpenAI.ResponseErrorEvent
`response.file_search_call.completed`	OpenAI.ResponseFileSearchCallCompletedEvent
`response.file_search_call.in_progress`	OpenAI.ResponseFileSearchCallInProgressEvent
`response.file_search_call.searching`	OpenAI.ResponseFileSearchCallSearchingEvent
`response.function_call_arguments.delta`	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
`response.function_call_arguments.done`	OpenAI.ResponseFunctionCallArgumentsDoneEvent
`response.in_progress`	OpenAI.ResponseInProgressEvent
`response.failed`	OpenAI.ResponseFailedEvent
`response.incomplete`	OpenAI.ResponseIncompleteEvent
`response.output_item.added`	OpenAI.ResponseOutputItemAddedEvent
`response.output_item.done`	OpenAI.ResponseOutputItemDoneEvent
`response.refusal.delta`	OpenAI.ResponseRefusalDeltaEvent
`response.refusal.done`	OpenAI.ResponseRefusalDoneEvent
`response.output_text.delta`	OpenAI.ResponseTextDeltaEvent
`response.output_text.done`	OpenAI.ResponseTextDoneEvent
`response.reasoning_summary_part.added`	OpenAI.ResponseReasoningSummaryPartAddedEvent
`response.reasoning_summary_part.done`	OpenAI.ResponseReasoningSummaryPartDoneEvent
`response.reasoning_summary_text.delta`	OpenAI.ResponseReasoningSummaryTextDeltaEvent
`response.reasoning_summary_text.done`	OpenAI.ResponseReasoningSummaryTextDoneEvent
`response.web_search_call.completed`	OpenAI.ResponseWebSearchCallCompletedEvent
`response.web_search_call.in_progress`	OpenAI.ResponseWebSearchCallInProgressEvent
`response.web_search_call.searching`	OpenAI.ResponseWebSearchCallSearchingEvent
`response.image_generation_call.completed`	OpenAI.ResponseImageGenCallCompletedEvent
`response.image_generation_call.generating`	OpenAI.ResponseImageGenCallGeneratingEvent
`response.image_generation_call.in_progress`	OpenAI.ResponseImageGenCallInProgressEvent
`response.image_generation_call.partial_image`	OpenAI.ResponseImageGenCallPartialImageEvent
`response.mcp_call.arguments_delta`	OpenAI.ResponseMCPCallArgumentsDeltaEvent
`response.mcp_call.arguments_done`	OpenAI.ResponseMCPCallArgumentsDoneEvent
`response.mcp_call.completed`	OpenAI.ResponseMCPCallCompletedEvent
`response.mcp_call.failed`	OpenAI.ResponseMCPCallFailedEvent
`response.mcp_call.in_progress`	OpenAI.ResponseMCPCallInProgressEvent
`response.mcp_list_tools.completed`	OpenAI.ResponseMCPListToolsCompletedEvent
`response.mcp_list_tools.failed`	OpenAI.ResponseMCPListToolsFailedEvent
`response.mcp_list_tools.in_progress`	OpenAI.ResponseMCPListToolsInProgressEvent
`response.queued`	OpenAI.ResponseQueuedEvent
`response.reasoning.delta`	OpenAI.ResponseReasoningDeltaEvent
`response.reasoning.done`	OpenAI.ResponseReasoningDoneEvent
`response.reasoning_summary.delta`	OpenAI.ResponseReasoningSummaryDeltaEvent
`response.reasoning_summary.done`	OpenAI.ResponseReasoningSummaryDoneEvent
`response.code_interpreter_call_code.delta`	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
`response.code_interpreter_call_code.done`	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
`response.code_interpreter_call.completed`	OpenAI.ResponseCodeInterpreterCallCompletedEvent
`response.code_interpreter_call.in_progress`	OpenAI.ResponseCodeInterpreterCallInProgressEvent
`response.code_interpreter_call.interpreting`	OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Nombre	Tipo	Description	Obligatorio	Predeterminado
sequence_number	entero	Número de secuencia de este evento.	Sí
type	OpenAI.ResponseStreamEventType		Sí

OpenAI.ResponseStreamEventType

Propiedad Importancia

Tipo cuerda / cadena

Valores response.audio.delta
response.audio.done
response.audio_transcript.delta
response.audio_transcript.done
response.code_interpreter_call_code.delta
response.code_interpreter_call_code.done
response.code_interpreter_call.completed
response.code_interpreter_call.in_progress
response.code_interpreter_call.interpreting
response.completed
response.content_part.added
response.content_part.done
response.created
error
response.file_search_call.completed
response.file_search_call.in_progress
response.file_search_call.searching
response.function_call_arguments.delta
response.function_call_arguments.done
response.in_progress
response.failed
response.incomplete
response.output_item.added
response.output_item.done
response.refusal.delta
response.refusal.done
response.output_text.annotation.added
response.output_text.delta
response.output_text.done
response.reasoning_summary_part.added
response.reasoning_summary_part.done
response.reasoning_summary_text.delta
response.reasoning_summary_text.done
response.web_search_call.completed
response.web_search_call.in_progress
response.web_search_call.searching
response.image_generation_call.completed
response.image_generation_call.generating
response.image_generation_call.in_progress
response.image_generation_call.partial_image
response.mcp_call.arguments_delta
response.mcp_call.arguments_done
response.mcp_call.completed
response.mcp_call.failed
response.mcp_call.in_progress
response.mcp_list_tools.completed
response.mcp_list_tools.failed
response.mcp_list_tools.in_progress
response.queued
response.reasoning.delta
response.reasoning.done
response.reasoning_summary.delta
response.reasoning_summary.done

OpenAI.ResponseTextDeltaEvent

Se genera cuando hay un delta de texto adicional.

Nombre	Tipo	Description	Obligatorio
content_index	entero	Índice de la parte de contenido a la que se agregó el delta de texto.	Sí
delta	cuerda / cadena	Delta de texto que se agregó.	Sí
item_id	cuerda / cadena	Identificador del elemento de salida al que se agregó el delta de texto.	Sí
output_index	entero	Índice del elemento de salida al que se agregó el delta de texto.	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
content_index	entero	Índice de la parte de contenido que finaliza el contenido de texto.	Sí
item_id	cuerda / cadena	Identificador del elemento de salida que finaliza el contenido del texto.	Sí
output_index	entero	Índice del elemento de salida que finaliza el contenido del texto.	Sí
texto	cuerda / cadena	Contenido de texto finalizado.	Sí
type	enum	El tipo de evento. Siempre `response.output_text.done`. Valores posibles: `response.output_text.done`	Sí

OpenAI.ResponseTextFormatConfiguration

Discriminador para OpenAI.ResponseTextFormatConfiguration

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

Valor del tipo	Schema
`text`	OpenAI.ResponseTextFormatConfigurationText
`json_object`	OpenAI.ResponseTextFormatConfigurationJsonObject
`json_schema`	OpenAI.ResponseTextFormatConfigurationJsonSchema

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ResponseTextFormatConfigurationType	Objeto que especifica el formato que debe generar el modelo. La configuración de `{ "type": "json_schema" }` habilita salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON proporcionado. Más información en la El formato predeterminado es `{ "type": "text" }` sin opciones adicionales. No se recomienda para los modelos gpt-4o y más recientes: Al establecer en `{ "type": "json_object" }` se habilita el modo JSON anterior, que garantiza que el mensaje que genera el modelo es JSON válido. Uso de `json_schema` es preferible para los modelos que lo admiten.	Sí

OpenAI.ResponseTextFormatConfigurationJsonObject

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

OpenAI.ResponseTextFormatConfigurationJsonSchema

Formato de respuesta del esquema JSON. Se usa para generar respuestas JSON estructuradas. Obtenga más información sobre las salidas estructuradas.

Nombre	Tipo	Description	Obligatorio	Predeterminado
descripción	cuerda / cadena	Descripción del propósito del formato de respuesta que usa el modelo determine cómo responder en el formato.	No
nombre	cuerda / cadena	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	objeto		Sí
strict	booleano	Indica si se debe habilitar la adhesión estricta al esquema al generar la salida. Si se establece en true, el modelo siempre seguirá el esquema exacto definido. en el campo `schema`. Solo se admite un subconjunto de esquema JSON cuando `strict` es `true`. Para más información, lea las guía de salidas estructuradas.	No	Falso
type	enum	Tipo de formato de respuesta que se va a definir. Siempre `json_schema`. Valores posibles: `json_schema`	Sí

OpenAI.ResponseTextFormatConfigurationText

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

OpenAI.ResponseTextFormatConfigurationType

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 la

El formato predeterminado es { "type": "text" } sin opciones adicionales.

No se recomienda para los modelos gpt-4o y más recientes:

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.

Propiedad	Importancia
Descripción	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 la

El formato predeterminado es { "type": "text" } sin opciones adicionales.

No se recomienda para los modelos gpt-4o y más recientes:

OpenAI.ResponseUsage

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

Nombre	Tipo	Description	Obligatorio
input_tokens	entero	Número de tokens de entrada.	Sí
input_tokens_details	objeto	Desglose detallado de los tokens de entrada.	Sí
└─ cached_tokens	entero	Número de tokens que se recuperaron de la memoria caché. Más información sobre el almacenamiento en caché de solicitudes.	No
output_tokens	entero	Número de tokens de salida.	Sí
output_tokens_details	objeto	Desglose detallado de los tokens de salida.	Sí
─ reasoning_tokens	entero	Número de elementos de razonamiento.	No
total_tokens	entero	Número total de tokens usados.	Sí

OpenAI.ResponseWebSearchCallCompletedEvent

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

Nombre	Tipo	Description	Obligatorio
item_id	cuerda / cadena	Identificador único del elemento de salida asociado a la llamada de búsqueda web.	Sí
output_index	entero	Índice del elemento de salida al que está asociada la llamada de búsqueda web.	Sí
type	enum	El tipo de evento. Siempre `response.web_search_call.completed`. Valores posibles: `response.web_search_call.completed`	Sí

OpenAI.ResponseWebSearchCallInProgressEvent

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

Nombre	Tipo	Description	Obligatorio
item_id	cuerda / cadena	Identificador único del elemento de salida asociado a la llamada de búsqueda web.	Sí
output_index	entero	Índice del elemento de salida al que está asociada la llamada de búsqueda web.	Sí
type	enum	El tipo de evento. Siempre `response.web_search_call.in_progress`. Valores posibles: `response.web_search_call.in_progress`	Sí

OpenAI.ResponseWebSearchCallSearchingEvent

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

Nombre	Tipo	Description	Obligatorio
item_id	cuerda / cadena	Identificador único del elemento de salida asociado a la llamada de búsqueda web.	Sí
output_index	entero	Índice del elemento de salida al que está asociada la llamada de búsqueda web.	Sí
type	enum	El tipo de evento. Siempre `response.web_search_call.searching`. Valores posibles: `response.web_search_call.searching`	Sí

OpenAI.ResponsesAssistantMessageItemParam

Un elemento de parámetro de mensaje con el rol assistant.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	cadena o matriz		Sí
role	enum	El papel del mensaje, que siempre `assistant`. Valores posibles: `assistant`	Sí

OpenAI.ResponsesAssistantMessageItemResource

Un elemento de recurso de mensaje con el rol assistant.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	array	Contenido asociado al mensaje.	Sí
role	enum	El papel del mensaje, que siempre `assistant`. Valores posibles: `assistant`	Sí

OpenAI.ResponsesDeveloperMessageItemParam

Un elemento de parámetro de mensaje con el rol developer.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	cadena o matriz		Sí
role	enum	El papel del mensaje, que siempre `developer`. Valores posibles: `developer`	Sí

OpenAI.ResponsesDeveloperMessageItemResource

Un elemento de recurso de mensaje con el rol developer.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	array	Contenido asociado al mensaje.	Sí
role	enum	El papel del mensaje, que siempre `developer`. Valores posibles: `developer`	Sí

OpenAI.ResponsesMessageItemParam

Elemento de mensaje de respuesta, que representa un rol y contenido, proporcionado como parámetros de solicitud del cliente.

Discriminador para OpenAI.ResponsesMessageItemParam

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

Valor del tipo	Schema
`user`	OpenAI.ResponsesUserMessageItemParam
`system`	OpenAI.ResponsesSystemMessageItemParam
`developer`	OpenAI.ResponsesDeveloperMessageItemParam
`assistant`	OpenAI.ResponsesAssistantMessageItemParam

Nombre	Tipo	Description	Obligatorio	Predeterminado
role	objeto	Colección de roles válidos para los elementos de mensaje de respuestas.	Sí
type	enum	Tipo del elemento de respuestas, que siempre es "message". Valores posibles: `message`	Sí

OpenAI.ResponsesMessageItemResource

Un elemento de recurso de mensaje de respuesta, que representa un rol y contenido, tal como se proporciona en las respuestas de servicio.

Discriminador para OpenAI.ResponsesMessageItemResource

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

Valor del tipo	Schema
`user`	OpenAI.ResponsesUserMessageItemResource
`system`	OpenAI.ResponsesSystemMessageItemResource
`developer`	OpenAI.ResponsesDeveloperMessageItemResource
`assistant`	OpenAI.ResponsesAssistantMessageItemResource

Nombre	Tipo	Description	Obligatorio
role	objeto	Colección de roles válidos para los elementos de mensaje de respuestas.	Sí
estado	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 del elemento de respuestas, que siempre es "message". Valores posibles: `message`	Sí

OpenAI.ResponsesMessageRole

Colección de roles válidos para los elementos de mensaje de respuestas.

Propiedad	Importancia
Descripción	Colección de roles válidos para los elementos de mensaje de respuestas.
Tipo	cuerda / cadena
Valores	`system` `developer` `user` `assistant`

OpenAI.ResponsesSystemMessageItemParam

Un elemento de parámetro de mensaje con el rol system.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	cadena o matriz		Sí
role	enum	El papel del mensaje, que siempre `system`. Valores posibles: `system`	Sí

OpenAI.ResponsesSystemMessageItemResource

Un elemento de recurso de mensaje con el rol system.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	array	Contenido asociado al mensaje.	Sí
role	enum	El papel del mensaje, que siempre `system`. Valores posibles: `system`	Sí

OpenAI.ResponsesUserMessageItemParam

Un elemento de parámetro de mensaje con el rol user.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	cadena o matriz		Sí
role	enum	El papel del mensaje, que siempre `user`. Valores posibles: `user`	Sí

OpenAI.ResponsesUserMessageItemResource

Un elemento de recurso de mensaje con el rol user.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	array	Contenido asociado al mensaje.	Sí
role	enum	El papel del mensaje, que siempre `user`. Valores posibles: `user`	Sí

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 del proyecto. A menos que se configure lo contrario, 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. Póngase en contacto con las ventas para obtener más información sobre el procesamiento de prioridad.
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	Importancia
Descripción	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 del proyecto. A menos que se configure lo contrario, project usará "default". * Si se establece en "default", la solicitud se procesará con el estándar. precios y rendimiento del modelo seleccionado. * Si se establece en 'flex' o "prioridad", la solicitud se procesará con el servicio correspondiente. nivel. Póngase en contacto con las ventas para obtener más información sobre el procesamiento de prioridad. * 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 basado en el modo de procesamiento usado realmente para atender la solicitud. Este valor de respuesta puede ser diferente del valor establecido en el parámetro .
Tipo	cuerda / cadena
Valores	`auto` `default` `flex` `scale` `priority`

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 la

El formato predeterminado es { "type": "text" } sin opciones adicionales.

No se recomienda para los modelos gpt-4o y más recientes:*

Discriminador para OpenAI.TextResponseFormatConfiguration

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

Valor del tipo	Schema

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	cuerda / cadena		Sí

OpenAI.Tool

Discriminador para OpenAI.Tool

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

Valor del tipo	Schema
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search_preview`	OpenAI.WebSearchPreviewTool
`code_interpreter`	OpenAI.CodeInterpreterTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellTool
`mcp`	OpenAI.MCPTool
`bing_grounding`	BingGroundingAgentTool
`fabric_dataagent_preview`	MicrosoftFabricAgentTool
`sharepoint_grounding_preview`	SharepointAgentTool
`azure_ai_search`	AzureAISearchAgentTool
`openapi`	OpenApiAgentTool
`bing_custom_search_preview`	BingCustomSearchAgentTool
`browser_automation_preview`	BrowserAutomationAgentTool
`azure_function`	AzureFunctionAgentTool
`capture_structured_outputs`	CaptureStructuredOutputsTool
`a2a_preview`	A2ATool
`memory_search`	MemorySearchTool

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ToolType	Herramienta que se puede usar para generar una respuesta.	Sí

OpenAI.ToolChoiceObject

Discriminador para OpenAI.ToolChoiceObject

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

Valor del tipo	Schema
`file_search`	OpenAI.ToolChoiceObjectFileSearch
`computer_use_preview`	OpenAI.ToolChoiceObjectComputer
`web_search_preview`	OpenAI.ToolChoiceObjectWebSearch
`image_generation`	OpenAI.ToolChoiceObjectImageGen
`code_interpreter`	OpenAI.ToolChoiceObjectCodeInterpreter
`function`	OpenAI.ToolChoiceObjectFunction
`mcp`	OpenAI.ToolChoiceObjectMCP

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ToolChoiceObjectType	Indica que el modelo debe usar una herramienta integrada para generar una respuesta. Obtenga más información sobre las herramientas integradas.	Sí

OpenAI.ToolChoiceObjectCodeInterpreter

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

OpenAI.ToolChoiceObjectComputer

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

OpenAI.ToolChoiceObjectFileSearch

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

OpenAI.ToolChoiceObjectFunction

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
nombre	cuerda / cadena	El nombre de la función que se va a llamar.	Sí
type	enum	En el caso de las llamadas a funciones, el tipo siempre es `function`. Valores posibles: `function`	Sí

OpenAI.ToolChoiceObjectImageGen

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

OpenAI.ToolChoiceObjectMCP

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

Nombre	Tipo	Description	Obligatorio
nombre	cuerda / cadena	Nombre de la herramienta que se va a llamar en el servidor.	No
etiqueta del servidor	cuerda / cadena	Etiqueta del servidor MCP que se va a usar.	Sí
type	enum	En el caso de las herramientas MCP, el tipo siempre es `mcp`. Valores posibles: `mcp`	Sí

OpenAI.ToolChoiceObjectType

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

Propiedad	Importancia
Descripción	Indica que el modelo debe usar una herramienta integrada para generar una respuesta.
Obtenga más información sobre las herramientas integradas.
Tipo	cuerda / cadena
Valores	`file_search` `function` `computer_use_preview` `web_search_preview` `image_generation` `code_interpreter` `mcp`

OpenAI.ToolChoiceObjectWebSearch

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

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

OpenAI.ToolChoiceOptions

Controla la herramienta (si existe) a la que llama el modelo.

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	Importancia
Descripción	Controla la herramienta (si existe) a la que llama el modelo. `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 uno o más herramientas. `required` significa que el modelo debe llamar a una o varias herramientas.
Tipo	cuerda / cadena
Valores	`none` `auto` `required`

OpenAI.ToolType

Herramienta que se puede usar para generar una respuesta.

Propiedad	Importancia
Descripción	Herramienta que se puede usar para generar una respuesta.
Tipo	cuerda / cadena
Valores	`file_search` `function` `computer_use_preview` `web_search_preview` `mcp` `code_interpreter` `image_generation` `local_shell` `bing_grounding` `browser_automation_preview` `fabric_dataagent_preview` `sharepoint_grounding_preview` `azure_ai_search` `openapi` `bing_custom_search_preview` `capture_structured_outputs` `a2a_preview` `azure_function` `memory_search`

OpenAI.TopLogProb

La probabilidad de registro superior de un token.

Nombre	Tipo	Obligatorio
bytes	array	Sí
logprob	número	Sí
token	cuerda / cadena	Sí

OpenAI.UpdateConversationRequest

Actualizar una conversación

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadata	objeto	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.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.WebSearchAction

Discriminador para OpenAI.WebSearchAction

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

Valor del tipo	Schema
`find`	OpenAI.WebSearchActionFind
`open_page`	OpenAI.WebSearchActionOpenPage
`search`	OpenAI.WebSearchActionSearch

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.WebSearchActionType		Sí

OpenAI.WebSearchActionFind

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

Nombre	Tipo	Description	Obligatorio
pattern	cuerda / cadena	Patrón o texto que se va a buscar en la página.	Sí
type	enum	Tipo de acción. Valores posibles: `find`	Sí
URL	cuerda / cadena	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	cuerda / cadena	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
query	cuerda / cadena	Consulta de la búsqueda.	Sí
Fuentes	array	Las fuentes utilizadas 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	cuerda / cadena		Sí

OpenAI.WebSearchActionType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	`search` `open_page` `find`

OpenAI.WebSearchPreviewTool

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

Nombre	Tipo	Description	Obligatorio
tamaño_del_contexto_de_búsqueda	enum	Orientación general sobre la cantidad de espacio de ventana de contexto que se va a usar para la búsqueda. Uno de`low`, `medium` o `high`. `medium` es el valor predeterminado. Valores posibles: `low`, `medium`, `high`	No
type	enum	Tipo de la herramienta de búsqueda web. Uno de estos valores: `web_search_preview` o `web_search_preview_2025_03_11`. Valores posibles: `web_search_preview`	Sí
ubicación_del_usuario	objeto		No
└─ Tipo	OpenAI.LocationType		No

OpenAI.WebSearchToolCallItemParam

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

Nombre	Tipo	Description	Obligatorio
acción	objeto		Sí
└─ Tipo	OpenAI.WebSearchActionType		No
type	enum	Valores posibles: `web_search_call`	Sí

OpenAI.WebSearchToolCallItemResource

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

Nombre	Tipo	Description	Obligatorio
acción	objeto		Sí
└─ Tipo	OpenAI.WebSearchActionType		No
estado	enum	El estado de la llamada a la herramienta de búsqueda web. Valores posibles: `in_progress`, `searching`, `completed`, `failed`	Sí
type	enum	Valores posibles: `web_search_call`	Sí

OpenAI.integer

Tipo: entero

Formato: int64

OpenAI.numeric

Tipo: número

Formato: double

OpenApiAgentTool

La información de definición de entrada de una herramienta OpenAPI como se usa para configurar un agente.

Nombre	Tipo	Description	Obligatorio
openapi	objeto	Información de definición de entrada para una función openapi.	Sí
Autenticación └	OpenApiAuthDetails	Detalles de autenticación de Open API	No
└" default_params	array	Lista de parámetros de especificación de OpenAPI que usarán los valores predeterminados proporcionados por el usuario	No
└─ Descripción	cuerda / cadena	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 └	array	Lista de definiciones de funciones utilizadas por la herramienta OpenApi	No
└─ Nombre	cuerda / cadena	El nombre de la función que se llamará.	No
Especificación └		Forma de la función openapi, que se describe como un objeto de esquema JSON.	No
type	enum	El tipo de objeto, que siempre es 'openapi'. Valores posibles: `openapi`	Sí

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:

Valor del tipo	Schema
`anonymous`	OpenApiAnonymousAuthDetails
`project_connection`	OpenApiProjectConnectionAuthDetails
`managed_identity`	OpenApiManagedAuthDetails

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	objeto	Tipo de autenticación para el punto de conexión de OpenApi. Los tipos permitidos son: - Anónimo (sin autenticación necesaria) - Conexión de proyecto (requiere project_connection_id al punto de conexión, como configuración en 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)
Conexión de proyecto (requiere project_connection_id al punto de conexión, como configuración en Foundry)
Managed_Identity (requiere audiencia para la autenticación basada en identidad)

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	`anonymous` `project_connection` `managed_identity`

OpenApiFunctionDefinition

Información de definición de entrada para una función openapi.

Nombre	Tipo	Description	Obligatorio
auth	objeto	detalles de autenticación de OpenApiFunctionDefinition	Sí
└─ Tipo	OpenApiAuthType	El tipo de autenticación debe ser anónimo,project_connection/managed_identity	No
default_params	array	Lista de parámetros de especificación de OpenAPI que usarán los valores predeterminados proporcionados por el usuario	No
descripción	cuerda / cadena	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	array	Lista de definiciones de funciones utilizadas por la herramienta OpenApi	No
nombre	cuerda / cadena	El nombre de la función que se llamará.	Sí
spec		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
security_scheme	objeto	Esquema de seguridad para la autenticación de openApi managed_identity	Sí
Audiencia └—	cuerda / cadena	Ámbito de autenticación para managed_identity tipo de autenticación	No
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	cuerda / cadena	Ámbito de autenticación para managed_identity tipo de autenticación	Sí

OpenApiProjectConnectionAuthDetails

Detalles de seguridad para la autenticación de conexión de proyecto OpenApi

Nombre	Tipo	Description	Obligatorio
security_scheme	objeto	Esquema de seguridad para la autenticación de openApi managed_identity	Sí
└" project_connection_id	cuerda / cadena	Identificador de conexión de proyecto para el tipo de autenticación de conexión de proyecto	No
type	enum	El 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	cuerda / cadena	Identificador de conexión de proyecto para el tipo de autenticación de conexión de proyecto	Sí

PagedConnection

Colección paginada de objetos de conexión

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	cuerda / cadena	Vínculo a la página siguiente de elementos	No
valor	array	Los elementos de conexión de esta página	Sí

PagedDatasetVersion

Colección paginada de elementos DatasetVersion

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	cuerda / cadena	Vínculo a la página siguiente de elementos	No
valor	array	Los elementos DatasetVersion de esta página	Sí

PagedDeployment

Colección paginada de elementos de implementación

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	cuerda / cadena	Vínculo a la página siguiente de elementos	No
valor	array	Elementos de implementación de esta página	Sí

PagedEvaluationRule

Colección paginada de elementos EvaluationRule

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	cuerda / cadena	Vínculo a la página siguiente de elementos	No
valor	array	Elementos EvaluationRule de esta página	Sí

PagedEvaluationTaxonomy

Colección paginada de elementos EvaluationTaxonomy

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	cuerda / cadena	Vínculo a la página siguiente de elementos	No
valor	array	Elementos EvaluationTaxonomy de esta página	Sí

PagedEvaluatorVersion

Colección paginada de elementos de EvaluatorVersion

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	cuerda / cadena	Vínculo a la página siguiente de elementos	No
valor	array	Elementos de EvaluadorVersion de esta página	Sí

PagedIndex

Colección paginada de elementos de índice

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	cuerda / cadena	Vínculo a la página siguiente de elementos	No
valor	array	Los elementos de índice de esta página	Sí

PagedInsight

Colección paginada de elementos de Insight

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	cuerda / cadena	Vínculo a la página siguiente de elementos	No
valor	array	Elementos de información de esta página	Sí

PagedRedTeam

Colección paginada de artículos de RedTeam

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	cuerda / cadena	Vínculo a la página siguiente de elementos	No
valor	array	Los elementos de RedTeam en esta página	Sí

PagedSchedule

Colección paginada de elementos de programación

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	cuerda / cadena	Vínculo a la página siguiente de elementos	No
valor	array	Los elementos Programación de esta página	Sí

PagedScheduleRun

Colección paginada de elementos ScheduleRun

Nombre	Tipo	Description	Obligatorio	Predeterminado
nextLink	cuerda / cadena	Vínculo a la página siguiente de elementos	No
valor	array	Los elementos de ScheduleRun de esta página	Sí

PendingUploadRequest

Representa una solicitud de una carga pendiente.

Nombre	Tipo	Description	Obligatorio
connectionName	cuerda / cadena	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	cuerda / cadena	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
blobReference	objeto	Detalles de referencia de blobs.	Sí
└— blobUri	cuerda / cadena	Ruta de acceso del URI del blob para que el cliente cargue datos. Ejemplo: `https://blob.windows.core.net/Container/Path`	No
Credencial de └	SasCredential	Información de credenciales para acceder a la cuenta de almacenamiento.	No
└] storageAccountArmId	cuerda / cadena	Id. de ARM de la cuenta de almacenamiento que se va a usar.	No
pendingUploadId	cuerda / cadena	ID para esta solicitud de carga.	Sí
pendingUploadType	enum	BlobReference es el único tipo admitido Valores posibles: `BlobReference`	Sí
version	cuerda / cadena	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	cuerda / cadena	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo.	No
amable	enum	Valores posibles: `prompt`	Sí
modelo	cuerda / cadena	Implementación del modelo que se va a usar para este agente.	Sí
reasoning	objeto	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└─ esfuerzo	OpenAI.ReasoningEffort	Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Actualmente, los valores admitidos no son ninguno, mínimo, bajo, medio y alto. 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 tiene como valor predeterminado ninguno, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son ninguno, bajo, medio y alto. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1. Todos los modelos anteriores a gpt-5.1 tienen como valor predeterminado el esfuerzo de razonamiento medio y no admiten ninguno. El modelo gpt-5-pro tiene como valor predeterminado (y solo admite) un alto esfuerzo de razonamiento.	No
└─ generar_resumen	enum	Obsoleto: use `summary` en su lugar. Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno de`auto`, `concise` o `detailed`. Valores posibles: `auto`, `concise`, `detailed`	No
└─ resumen	enum	Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno de`auto`, `concise` o `detailed`. Valores posibles: `auto`, `concise`, `detailed`	No
structured_inputs	objeto	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 vaya 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, recomendamos modificar esto o `top_p`, pero no ambos.	No	1
texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados.	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú / Usted 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, recomendamos modificar esto o `temperature`, pero no ambos.	No	1

PromptBasedEvaluatorDefinition

Evaluador basado en indicaciones

Nombre	Tipo	Description	Obligatorio	Predeterminado
prompt_text	cuerda / cadena	El texto de solicitud utilizado 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	objeto		Sí
version	cuerda / cadena	La 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	cuerda / cadena	El nombre de la política de 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:

Valor del tipo	Schema
`Hourly`	HourlyRecurrenceSchedule
`Daily`	DailyRecurrenceSchedule
`Weekly`	WeeklyRecurrenceSchedule
`Monthly`	MonthlyRecurrenceSchedule

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	objeto	Tipo de recurrencia.	Sí

RecurrenceTrigger

Desencadenador basado en recurrencia.

Nombre	Tipo	Description	Obligatorio	Predeterminado
endTime	cuerda / cadena	Hora de finalización de la programación de periodicidad en formato ISO 8601.	No
interval	entero	Intervalo para el programa de periodicidad.	Sí
horario	objeto	Modelo de programación de periodicidad.	Sí
└─ Tipo	RecurrenceType	Tipo de periodicidad para la programación de periodicidad.	No
startTime	cuerda / cadena	Hora de inicio de la programación de recurrencia en formato ISO 8601.	No
timeZone	cuerda / cadena	Zona horaria para la programación de periodicidad.	No	Tiempo Universal Coordinado (UTC)
type	enum	Tipo de desencadenante. Valores posibles: `Recurrence`	Sí

RecurrenceType

Tipo de recurrencia.

Propiedad	Importancia
Descripción	Tipo de recurrencia.
Tipo	cuerda / cadena
Valores	`Hourly` `Daily` `Weekly` `Monthly`

RedTeam

Detalles del equipo rojo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
applicationScenario	cuerda / cadena	Escenario de aplicación para la operación del equipo rojo, para generar ataques específicos del escenario.	No
attackStrategies	array	Lista de estrategias de ataque o listas anidadas de estrategias de ataque.	No
Nombre para mostrar	cuerda / cadena	Nombre de la carrera del equipo rojo.	No
id	cuerda / cadena	Identificador de la carrera del equipo rojo.	Sí
numTurns	entero	Número de rondas de simulación.	No
Propiedades	objeto	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	array	Lista de categorías de riesgo para las que generar objetivos de ataque.	No
simulationOnly	booleano	Solo Simulación o Simulación + Evaluación. Predeterminado false, si es true, el escaneo genera una conversación, no el resultado de la evaluación.	No	Falso
estado	cuerda / cadena	Estatus del equipo rojo. Lo establece el servicio y es de solo lectura.	No
tags	objeto	Etiquetas del equipo rojo. A diferencia de las propiedades, las etiquetas son completamente mutables.	No
target	objeto	Clase abstracta para la configuración de destino.	Sí
└─ Tipo	cuerda / cadena	Tipo de configuración del modelo.	No

RedTeamItemGenerationParams

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

Nombre	Tipo	Description	Obligatorio
attack_strategies	array	Colección de estrategias de ataque que se van a usar.	Sí
num_turns	entero	Número de turnos permitidos en el juego.	Sí
type	enum	Tipo de parámetros de generación de elementos, siempre `red_team`. Valores posibles: `red_team`	Sí

RiskCategory

Categoría de riesgo para el objetivo del ataque.

Propiedad	Importancia
Descripción	Categoría de riesgo para el objetivo del ataque.
Tipo	cuerda / cadena
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	cuerda / cadena	Token de SAS	No
type	enum	Tipo de credencial Valores posibles: `SAS`	Sí

SampleType

El tipo de muestra utilizada en el análisis.

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	`EvaluationResultSample`

SasCredential

Definición de credenciales de SAS

Nombre	Tipo	Description	Obligatorio	Predeterminado
sasUri	cuerda / cadena	Uri de SAS	Sí
type	enum	Tipo de credencial Valores posibles: `SAS`	Sí

Programación

Modelo de programación.

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Descripción de la programación.	No
Nombre para mostrar	cuerda / cadena	Nombre de la programación.	No
habilitado	booleano	Estado habilitado del horario.	Sí
id	cuerda / cadena	Identificador del horario.	Sí
Propiedades	objeto	Schedule. A diferencia de las etiquetas, las propiedades son de solo complemento. Una vez agregado, no se puede quitar una propiedad.	No
provisioningStatus	objeto	Programar el estado de aprovisionamiento.	No
datos del sistema	objeto	Metadatos del sistema para el recurso.	Sí
tags	objeto	Etiquetas de programación. A diferencia de las propiedades, las etiquetas son completamente mutables.	No
task	objeto	Modelo de tareas de programación.	Sí
Configuración de └	objeto	Configuración de la tarea.	No
└─ Tipo	ScheduleTaskType	Tipo de la tarea.	No
trigger	objeto	Modelo base para el Disparador del horario.	Sí
└─ Tipo	Tipo de desencadenante	Tipo de desencadenante.	No

ScheduleProvisioningStatus

Programar el estado de aprovisionamiento.

Propiedad	Importancia
Descripción	Programar el estado de aprovisionamiento.
Tipo	cuerda / cadena
Valores	`Creating` `Updating` `Deleting` `Succeeded` `Failed`

ScheduleRun

Programar modelo de ejecución.

Nombre	Tipo	Description	Obligatorio
error	cuerda / cadena	Información de error para la ejecución programada.	No
id	cuerda / cadena	Identificador de la ejecución programada.	Sí
Propiedades	objeto	Propiedades de la ejecución programada.	Sí
scheduleId	cuerda / cadena	Identificador del horario.	Sí
correcto	booleano	Desencadenar el estado correcto de la ejecución de programación.	Sí
triggerTime	cuerda / cadena	Tiempo de activación de la ejecución programada.	No

ScheduleTask

Modelo de tareas de programación.

Discriminador para ScheduleTask

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

Valor del tipo	Schema
`Evaluation`	EvaluationScheduleTask
`Insight`	InsightScheduleTask

Nombre	Tipo	Description	Obligatorio	Predeterminado
configuration	objeto	Configuración de la tarea.	No
type	objeto	Tipo de la tarea.	Sí

ScheduleTaskType

Tipo de la tarea.

Propiedad	Importancia
Descripción	Tipo de la tarea.
Tipo	cuerda / cadena
Valores	`Evaluation` `Insight`

SeedPromptsRedTeamItemGenerationParams

Representa los parámetros para la generación de elementos de equipo rojo con avisos de inicialización.

Nombre	Tipo	Description	Obligatorio
attack_strategies	array	Colección de estrategias de ataque que se van a usar.	Sí
num_turns	entero	Número de turnos permitidos en el juego.	Sí
source	objeto		Sí
└─ Contenido	array	Contenido del archivo jsonl.	No
└─ id.	cuerda / cadena	Identificador del archivo.	No
└─ Tipo	enum	Tipo de origen jsonl. Siempre `file_id`. Valores posibles: `file_id`	No
type	enum	Tipo de parámetros de generación de elementos, siempre `red_team`. Valores posibles: `red_team_seed_prompts`	Sí

SharepointAgentTool

La información de definición de entrada de una herramienta de sharepoint como se usa para configurar un agente.

Nombre	Tipo	Description	Obligatorio
sharepoint_grounding_preview	objeto	Los parámetros de la herramienta de conexión a tierra de SharePoint.	Sí
└" project_connections	array	Las conexiones del proyecto asociadas a esta herramienta. Puede haber un máximo de 1 conexión. recurso asociado a la herramienta.	No
type	enum	Tipo de objeto, que siempre es "sharepoint_grounding". Valores posibles: `sharepoint_grounding_preview`	Sí

SharepointGroundingToolParameters

Los parámetros de la herramienta de conexión a tierra de SharePoint.

Nombre	Tipo	Description	Obligatorio	Predeterminado
project_connections	array	Las conexiones del proyecto asociadas a esta herramienta. Puede haber un máximo de 1 conexión. recurso asociado a la herramienta.	No

Sku

Información de SKU

Nombre	Tipo	Description	Obligatorio
capacidad	entero	Capacidad de SKU	Sí
family	cuerda / cadena	Familia de SKU	Sí
nombre	cuerda / cadena	Nombre de SKU	Sí
tamaño	cuerda / cadena	Tamaño de SKU	Sí
nivel	cuerda / cadena	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
descripción	cuerda / cadena	Una descripción legible por humanos de la entrada.	No
required	booleano	Si la propiedad de entrada es necesaria cuando se invoca el agente.	No	Falso
schema		El esquema JSON para la entrada estructurada (opcional).	No

StructuredOutputDefinition

Salida estructurada que el agente puede generar.

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Una descripción de la salida que se va a emitir. Utilizado por el modelo para determinar cuándo emitir la salida.	Sí
nombre	cuerda / cadena	El nombre de la salida estructurada.	Sí
schema		El esquema JSON para la salida estructurada.	Sí
strict	booleano	Si se debe aplicar una validación estricta. El valor predeterminado es `true`.	Sí

StructuredOutputsItemResource

Nombre	Tipo	Description	Obligatorio	Predeterminado
output		Salida estructurada capturada durante la respuesta.	Sí
type	enum	Valores posibles: `structured_outputs`	Sí

Objetivo

Clase base para destinos con compatibilidad con discriminadores.

Discriminador para destino

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

Valor del tipo	Schema
`azure_ai_model`	AzureAIModelTarget
`azure_ai_agent`	AzureAIAgentTarget
`azure_ai_assistant`	AzureAIAssistantTarget

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	cuerda / cadena	Tipo de destino.	Sí

TargetCompletions

Representa un origen de datos para la configuración de evaluación de finalización basada en destino.

Nombre	Tipo	Description	Obligatorio
mensajes de entrada	objeto		No
└─ referencia_elemento	cuerda / cadena		No
└─ Tipo	enum	Valores posibles: `item_reference`	No
source	objeto		Sí
└─ Contenido	array	Contenido del archivo jsonl.	No
└─ id.	cuerda / cadena	Identificador del archivo.	No
└─ Tipo	enum	Tipo de origen jsonl. Siempre `file_id`. Valores posibles: `file_id`	No
target	objeto	Clase base para destinos con compatibilidad con discriminadores.	Sí
└─ Tipo	cuerda / cadena	Tipo de destino.	No
type	enum	Tipo de origen de datos, siempre `TargetCompletions`. 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:

Valor del tipo	Schema
`AzureOpenAIModel`	AzureOpenAIModelConfiguration

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	cuerda / cadena	Tipo de 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:

Valor del tipo	Schema
`azure_ai_model`	AzureAIModelTargetUpdate
`azure_ai_assistant`	AzureAIAssistantTargetUpdate

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	cuerda / cadena	Tipo de destino.	Sí

TaxonomíaCategory

Definición de categoría de taxonomía.

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Descripción de la categoría de taxonomía.	No
id	cuerda / cadena	Identificador único de la categoría de taxonomía.	Sí
nombre	cuerda / cadena	Nombre de la categoría de taxonomía.	Sí
Propiedades	objeto	Propiedades adicionales para la categoría de taxonomía.	No
riskCategory	objeto	Categoría de riesgo para el objetivo del ataque.	Sí
Subcategorías	array	Lista de subcategorías de taxonomía.	Sí

TaxonomyRedTeamItemGenerationParams

Representa los parámetros para la generación de elementos de equipo rojo con avisos de inicialización.

Nombre	Tipo	Description	Obligatorio
attack_strategies	array	Colección de estrategias de ataque que se van a usar.	Sí
num_turns	entero	Número de turnos permitidos en el juego.	Sí
source	objeto		Sí
└─ Contenido	array	Contenido del archivo jsonl.	No
└─ id.	cuerda / cadena	Identificador del archivo.	No
└─ Tipo	enum	Tipo de origen jsonl. Siempre `file_id`. Valores posibles: `file_id`	No
type	enum	Tipo de parámetros de generación de elementos, siempre `red_team`. Valores posibles: `red_team_taxonomy`	Sí

TaxonomíaSubCategory

Definición de subcategoría de taxonomía.

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Descripción de la subcategoría de taxonomía.	No
habilitado	booleano	Lista de elementos de taxonomía en esta subcategoría.	Sí
id	cuerda / cadena	Identificador único de la subcategoría de taxonomía.	Sí
nombre	cuerda / cadena	Nombre de la subcategoría de taxonomía.	Sí
Propiedades	objeto	Propiedades adicionales para la subcategoría de taxonomía.	No

ToolDescription

Descripción de una herramienta que puede ser utilizada por un agente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
descripción	cuerda / cadena	Una breve descripción del propósito de la herramienta.	No
nombre	cuerda / cadena	Nombre de la herramienta.	No

ToolProjectConnection

Un recurso de conexión de proyecto.

Nombre	Tipo	Description	Obligatorio	Predeterminado
project_connection_id	cuerda / cadena	Una conexión de proyecto en un ToolProjectConnectionList adjunto a esta herramienta.	Sí

TracesEvalRunDataSource

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
lookback_hours	entero	Ventana de devolución de búsqueda (en horas) aplicada al recuperar seguimientos de Application Insights.	No	168
trace_ids	array	Colección de identificadores de seguimiento del agente que se deben evaluar.	Sí
type	enum	Tipo de origen de datos, siempre `azure_ai_traces`. Valores posibles: `azure_ai_traces`	Sí

TreatmentEffectType

Tipo de efecto del tratamiento.

Propiedad	Importancia
Tipo	cuerda / cadena
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:

Valor del tipo	Schema
`Cron`	CronTrigger
`Recurrence`	recurrenceTrigger
`OneTime`	OneTimeTrigger

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	objeto	Tipo de desencadenante.	Sí

TriggerType

Tipo de desencadenante.

Propiedad	Importancia
Descripción	Tipo de desencadenante.
Tipo	cuerda / cadena
Valores	`Cron` `Recurrence` `OneTime`

UpdateAgentFromManifestRequest

Nombre	Tipo	Description	Obligatorio
descripción	cuerda / cadena	Descripción legible del agente.	No
manifest_id	cuerda / cadena	Identificador de manifiesto desde el que se va a importar la versión del agente.	Sí
metadata	objeto	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	objeto	Las entradas del manifiesto que darán lugar a un agente totalmente materializado.	Sí

UpdateAgentRequest

Nombre	Tipo	Description	Obligatorio
definición	objeto		Sí
└└ kind	AgentKind		No
└" rai_config	RaiConfig	Configuración para funciones de seguridad y filtrado de contenido de IA responsable (RAI).	No
descripción	cuerda / cadena	Descripción legible del agente.	No
metadata	objeto	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
metadata	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.	No
nombre	cuerda / cadena		No
Propiedades	objeto	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
amable	enum	El tipo de elemento de memoria. Valores posibles: `user_profile`	Sí

WeeklyRecurrenceSchedule

Calendario de recurrencia semanal.

Nombre	Tipo	Description	Obligatorio	Predeterminado
daysOfWeek	array	Días de la semana para el programa de periodicidad.	Sí
type	enum	Tipo de recurrencia semanal. Valores posibles: `Weekly`	Sí

WorkflowActionOutputItemResource

Nombre	Tipo	Description	Obligatorio
action_id	cuerda / cadena	Identificador único de la acción.	Sí
amable	cuerda / cadena	El tipo de acción CSDL (por ejemplo, "SetVariable", "InvokeAzureAgent").	Sí
parent_action_id	cuerda / cadena	Identificador de la acción primaria si se trata de una acción anidada.	No
previous_action_id	cuerda / cadena	Identificador de la acción anterior si esta acción sigue a otra.	No
estado	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í
flujo de trabajo	cuerda / cadena	La definición de YAML de CSDL del flujo de trabajo.	No

entero

Tipo: entero

Formato: int64

Comentarios

¿Le ha resultado útil esta página?

Last updated on 2026-02-28

Compartir a través de

Referencia de REST de Microsoft Foundry Project

Agentes: creación de agente

Parámetros de URI

Encabezado de solicitud

Cuerpo de la solicitud

Respuestas

Agentes: enumerar agentes

Parámetros de URI

Encabezado de solicitud

Respuestas

Agentes: obtener agente

Parámetros de URI

Encabezado de solicitud

Respuestas

Agentes: agente de actualización

Parámetros de URI

Encabezado de solicitud

Cuerpo de la solicitud

Respuestas

Agentes: eliminación del agente

Parámetros de URI

Encabezado de solicitud

Respuestas

Agentes: actualización del agente desde el manifiesto

Parámetros de URI

Encabezado de solicitud

Cuerpo de la solicitud

Respuestas

Agentes: enumerar las operaciones de contenedor del agente

Parámetros de URI

Encabezado de solicitud

Respuestas

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

Parámetros de URI

Encabezado de solicitud

Respuestas

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

Parámetros de URI

Encabezado de solicitud

Cuerpo de la solicitud

Respuestas

Agentes: enumerar las versiones del agente

Parámetros de URI

Encabezado de solicitud

Respuestas

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

Parámetros de URI

Encabezado de solicitud

Respuestas

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

Parámetros de URI

Encabezado de solicitud

Respuestas

Agentes: obtención del contenedor de agentes

Parámetros de URI

Encabezado de solicitud

Respuestas

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

Parámetros de URI

Encabezado de solicitud

Respuestas

Agentes: eliminación del contenedor del agente

Parámetros de URI

Encabezado de solicitud

Respuestas

Agentes: iniciar el contenedor del agente

Parámetros de URI

Encabezado de solicitud

Cuerpo de la solicitud

Respuestas

Agentes: detener el contenedor del agente

Parámetros de URI

Encabezado de solicitud

Respuestas

Agentes: actualización del contenedor del agente

Parámetros de URI

Encabezado de solicitud

Cuerpo de la solicitud

Respuestas