Azure AI Foundry Agent Service (versión preliminar)

Integre fácilmente las funcionalidades de Azure AI Foundry Agent Service en los flujos de trabajo.

Este conector está disponible en los siguientes productos y regiones:

Service Class Regions
Copilot Studio Estándar Todas las regiones Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas Estándar Todas las regiones de Logic Apps excepto las siguientes:
     - regiones de Azure Government
     - Azure regiones de China
     - Departamento de Defensa de EE. UU. (DoD)
Power Apps Estándar Todas las regiones Power Apps excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Power Automate Estándar Todas las regiones Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Contacto
Nombre Microsoft
URL https://support.microsoft.com
Metadatos del conector
Publisher Microsoft
Website https://learn.microsoft.com/en-us/azure/ai-services/agents/
Directiva de privacidad https://learn.microsoft.com/en-us/legal/cognitive-services/agents/data-privacy-security
Categorías IA; Business Intelligence

Azure ai Agent Service es un servicio totalmente administrado diseñado para permitir a los desarrolladores crear, implementar y escalar de forma segura agentes de inteligencia artificial extensibles y de alta calidad sin necesidad de administrar los recursos de proceso y almacenamiento subyacentes. Azure AI Agent Service integra modelos, herramientas y tecnología y le permite ampliar los agentes con conocimientos de orígenes conectados (como Bing Search, SharePoint, Fabric, Azure Blob Storage y datos con licencia) y acciones mediante herramientas como Azure Logic Apps, Azure Functions, herramientas y intérprete de código especificados de OpenAPI 3.0

Prerrequisitos

Obtención de las credenciales

Para autenticar las solicitudes de API, necesitará el punto de conexión para los recursos del servicio del agente de IA de Azure.

Para el recurso del servicio del agente de IA de Azure:

  1. Vaya al recurso en el portal Azure.
  2. En la página del recurso, seleccione Claves y punto de conexión en el menú de navegación izquierdo. Anote sus credenciales. Usará una de las claves y el punto de conexión.

Problemas y limitaciones conocidos

  • Solo se admite Azure servicio de agente de IA como servicio de agente con este conector de Power Platform solo para Logic Apps. No para power automate y power apps

Creación de una conexión

El conector admite los siguientes tipos de autenticación:

Identidad administrada Creación de una conexión mediante una identidad administrada Solo LOGICAPPS Compartible
Microsoft Entra ID inicio de sesión de usuario Inicio de sesión con credenciales de Microsoft Entra ID Todas las regiones No se puede compartir
Valor predeterminado [EN DESUSO] Esta opción solo es para conexiones anteriores sin un tipo de autenticación explícito y solo se proporciona para la compatibilidad con versiones anteriores. Todas las regiones No se puede compartir

Identidad administrada

Identificador de autenticación: managedIdentityAuth

Aplicable: SOLO LOGICAPPS

Creación de una conexión mediante una identidad administrada

Se trata de una conexión que se puede compartir. Si la aplicación de energía se comparte con otro usuario, también se comparte la conexión. Para obtener más información, consulte la información general de Connectors para aplicaciones de lienzo: Power Apps | Microsoft Docs

Nombre Tipo Description Obligatorio
Identidad administrada managedIdentity Inicio de sesión con una identidad administrada Cierto
punto de conexión de Project de IA de Azure cuerda / cadena Nombre del punto de conexión de Project de IA de Azure, como https://{account-name}.services.ai.azure. com/api/projects/{project-name} Cierto

inicio de sesión de usuario de Microsoft Entra ID

Identificador de autenticación: entraIDUserLogin

Aplicable: Todas las regiones

Inicio de sesión con credenciales de Microsoft Entra ID

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre Tipo Description Obligatorio
punto de conexión de Project de IA de Azure cuerda / cadena Nombre del punto de conexión de Project de IA de Azure, como https://{account-name}.services.ai.azure. com/api/projects/{project-name} Cierto

Valor predeterminado [EN DESUSO]

Aplicable: Todas las regiones

Esta opción solo es para conexiones anteriores sin un tipo de autenticación explícito y solo se proporciona para la compatibilidad con versiones anteriores.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Limitaciones

Nombre Llamadas Período de renovación
Llamadas API por conexión 1000 60 segundos

Acciones

Actualización del enrutamiento del agente hospedado

Actualiza el punto de conexión del agente hospedado para enrutar el 100 % del tráfico a una versión específica del agente activo. Las versiones de borrador no pueden ser destinos de enrutamiento.

Agentes de lista

Agentes de lista

Cargar archivo de sesión hospedado

Carga contenido de archivo sin procesar en una sesión hospedada. El tamaño máximo de archivo es de 50 MB.

Corre

Corre

Creación de la versión del agente del símbolo del sistema

Crea una nueva versión del agente de solicitud mediante una implementación de modelos, instrucciones y herramientas opcionales.

Crear agente hospedado

Crea un agente hospedado y su versión inicial a partir de una imagen de contenedor.

Crear ejecución

Crear ejecución

Crear sesión hospedada

Crea una sesión de agente hospedada. Opcionalmente, seleccione una versión específica del agente; De lo contrario, la configuración de enrutamiento del agente hospedado selecciona la versión.

Crear subproceso

Crear subproceso

Crear versión del agente hospedado

Crea una nueva versión del agente hospedado a partir de una imagen de contenedor.

Descargar archivo de sesión hospedado

Descarga el contenido binario de un archivo desde una sesión hospedada.

Deshabilitar agente hospedado

Deshabilita un punto de conexión del agente hospedado sin eliminar el agente ni sus versiones.

Eliminar agente

Elimina permanentemente un agente y todas sus versiones. En el caso de los agentes hospedados, las sesiones activas provocan un conflicto a menos que la eliminación forzada esté habilitada.

Eliminar archivo de sesión hospedado

Elimina un archivo o directorio de una sesión hospedada.

Eliminar sesión hospedada

Elimina una sesión del agente hospedado, finaliza su espacio aislado y libera sus recursos.

Eliminar versión del agente

Elimina permanentemente una versión específica del agente. En el caso de los agentes hospedados, las sesiones activas provocan un conflicto a menos que la eliminación forzada esté habilitada.

Enumerar agentes (servicio de agente)

Enumerar agentes del servicio del agente

Enumerar archivos de sesión hospedados

Enumera archivos y directorios en una ruta de acceso en una sesión hospedada.

Enumerar sesiones hospedadas

Enumera las sesiones hospedadas de un agente al que se puede acceder al autor de la llamada.

Enumerar versiones del agente

Enumera las versiones de un agente.

Habilitación del agente hospedado

Habilita un punto de conexión del agente hospedado para que pueda atender solicitudes.

Invocar agente hospedado (invocaciones)

Invoca un agente hospedado que expone el protocolo invocaciones. La implementación del agente hospedado define el JSON de solicitud y respuesta.

Invocar agente hospedado (respuestas)

Invoca un agente hospedado que expone el protocolo De respuestas. La acción usa respuestas JSON que no son de streaming.

Invoke Prompt Agent

Invoca un agente de solicitud.

Mensajes de lista

Mensajes de lista

Obtener agente

Obtiene un agente y su versión más reciente.

Obtener sesión hospedada

Obtiene una sesión de agente hospedada por su identificador de sesión.

Obtener versión del agente

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

Protocolo de actividad del agente externo basado en el identificador del agente

Protocolo de actividad del agente externo basado en el identificador del agente

Protocolo de actividad del agente externo basado en el identificador del agente con el punto de conexión V2

Protocolo de actividad del agente externo basado en el identificador del agente con el punto de conexión V2

Protocolo de actividad del agente externo basado en la aplicación

Protocolo de actividad del agente externo basado en la aplicación

Actualización del enrutamiento del agente hospedado

Actualiza el punto de conexión del agente hospedado para enrutar el 100 % del tráfico a una versión específica del agente activo. Las versiones de borrador no pueden ser destinos de enrutamiento.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Versión del agente
agent_version True string

La versión activa y no borrador del agente que recibe el tráfico del punto de conexión.

Devoluciones

Agentes de lista

Agentes de lista

Parámetros

Nombre Clave Requerido Tipo Description
Versión de API
api-version True string

Versión de API

Devoluciones

Cargar archivo de sesión hospedado

Carga contenido de archivo sin procesar en una sesión hospedada. El tamaño máximo de archivo es de 50 MB.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Clave de aislamiento de usuario
x-ms-user-isolation-key string

Clave de partición opcional para agentes hospedados configurados con aislamiento de sesión basado en encabezados. Use el mismo valor para cada operación de la sesión. Esta clave no proporciona autenticación.

Identificador de sesión
SessionId True string

Identificador de sesión hospedado.

Ruta del archivo
path True string

Ruta de acceso del archivo o directorio en la sesión hospedada.

Contenido del archivo
body True binary

Contenido binario del archivo que se va a cargar.

Devoluciones

Corre

Corre

Parámetros

Nombre Clave Requerido Tipo Description
Versión de API
api-version True string

Versión de API

Identificador del subproceso para el que se va a crear un mensaje.
ThreadId True string

Identificador del subproceso para el que se va a crear un mensaje.

Identificador de la ejecución.
RunId True string

Identificador de la ejecución.

Devoluciones

Creación de la versión del agente del símbolo del sistema

Crea una nueva versión del agente de solicitud mediante una implementación de modelos, instrucciones y herramientas opcionales.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Description
description string

Descripción legible de la versión del agente del símbolo del sistema.

Metadata
metadata object

Metadatos que se van a asociar a la versión del agente del símbolo del sistema.

Crear como borrador
draft boolean

Si se va a crear una versión de borrador.

Implementación del modelo
model True string

Nombre de una implementación de modelo disponible en el proyecto foundry actual. Los nombres de modelo directo de Foundry admitidos también se pueden escribir manualmente.

Instrucciones
instructions string

Instrucciones del sistema que definen el comportamiento del agente de solicitud.

herramientas
Tools object
Elección de herramientas
tool_choice

Controla cómo selecciona el agente de solicitud las herramientas.

Temperatura
temperature float

Temperatura de muestreo entre 0 y 2.

P superior
top_p float

Probabilidad de muestreo de núcleo entre 0 y 1.

Configuración de texto
text object

Configuración de texto opcional y salida estructurada.

Configuración del razonamiento
reasoning object

Configuración de razonamiento opcional para los modelos admitidos.

Habilidades
Skills object
Entradas estructuradas
structured_inputs object

Definiciones de entrada estructuradas opcionales.

Harness
harness object

Configuración opcional del arnés del agente.

Devoluciones

Crear agente hospedado

Crea un agente hospedado y su versión inicial a partir de una imagen de contenedor.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
name True string

Nombre del agente hospedado.

Description
description string

Descripción legible del agente hospedado.

Metadata
metadata object

Metadatos que se van a asociar al agente hospedado.

Imagen de contenedor
image True string

Referencia de imagen de contenedor completa, por ejemplo, myregistry.azurecr.io/my-agent:v1.

Id. de conexión del Registro
registry_connection_id string

Identificador de conexión del proyecto Foundry para el registro de contenedor, cuando sea necesario.

Unidad Central de Procesamiento (CPU)
cpu True string

Número de núcleos de CPU solicitados para el contenedor del agente hospedado, por ejemplo 1.

Memory
memory True string

Cantidad de memoria solicitada para el contenedor del agente hospedado, por ejemplo 2Gi.

Protocol
protocol True string

Protocolo expuesto por el agente hospedado. Seleccione Respuestas o invocaciones.

Variables de entorno
environment_variables object

Variables de entorno pasadas al contenedor del agente hospedado.

Configuración de ia responsable
rai_config object

Configuración opcional de filtro de contenido de IA responsable.

Configuración de telemetría
telemetry_config object

Configuración de telemetría opcional.

Configuración de la sesión
session_configuration object

Configuración opcional de la sesión del agente hospedado.

Devoluciones

Crear ejecución

Crear ejecución

Parámetros

Nombre Clave Requerido Tipo Description
Versión de API
api-version True string

Versión de API

Identificador del subproceso para el que se va a crear un mensaje.
ThreadId True string

Identificador del subproceso para el que se va a crear un mensaje.

assistant_id
assistant_id True string

Identificador del asistente que se va a usar para ejecutar esta ejecución.

model
model string

Nombre de implementación del modelo que se usará para ejecutar esta ejecución. Si se proporciona, invalida el nombre de implementación del modelo del asistente.

instructions
instructions string

Invalida las instrucciones del asistente. Resulta útil para modificar el comportamiento por ejecución.

additional_instructions
additional_instructions string

Anexa instrucciones adicionales al final de las instrucciones para la ejecución.

role
role string

Rol de la entidad que está creando el mensaje. Puede ser usuario o asistente. 'user' indica que un usuario real envía el mensaje y se debe usar en la mayoría de los casos para representar mensajes generados por el usuario. 'assistant' indica que el asistente genera el mensaje. Use este valor para insertar mensajes del asistente en la conversación.

contenido
content string

Contenido del mensaje.

nombre
name string

Lista de identificadores de archivo o mensajes que se pueden usar en la ejecución.

metadata
metadata object

Conjunto de 16 pares clave-valor que se pueden adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado. Las claves pueden tener un máximo de 64 caracteres y los valores pueden tener un máximo de 512 caracteres.

nombre
name string

Lista de herramientas que se pueden usar en la ejecución.

metadata
metadata object

Conjunto de 16 pares clave-valor adjuntos a un objeto . Longitud máxima de las claves: 64 caracteres, Longitud máxima de valores: 512 caracteres.

temperatura
temperature number

Temperatura de muestreo (0-2). Los valores más altos (por ejemplo, 0,8) aumentan la aleatoriedad, los valores más bajos (por ejemplo, 0,2) hacen que la salida sea más determinista.

top_p
top_p number

Muestreo de núcleo alternativo a la temperatura. 0,1 significa que se consideran 10% masa de probabilidad.

flujo
stream boolean

Si es true, devuelve una secuencia de eventos durante la ejecución como eventos enviados por el servidor, finalizando con un mensaje "data: [DONE]".

max_prompt_tokens
max_prompt_tokens integer

Número máximo de tokens de finalización que se pueden usar durante la ejecución. Si se supera, la ejecución finaliza como incompleta.

max_completion_tokens
max_completion_tokens integer

Número máximo de tokens de finalización que se pueden usar durante la ejecución. Si se supera, la ejecución finaliza como incompleta.

truncation_strategy
truncation_strategy object

Controla cómo se trunca un subproceso antes de la ejecución para administrar la ventana de contexto inicial.

tool_choice
tool_choice

Controla qué herramienta llama el modelo. El valor predeterminado es "auto", lo que permite que el modelo decida. Se puede establecer en "none" para deshabilitar el uso de herramientas.

formato_de_respuesta
response_format object

Especifica el formato de salida. Establecer { 'type': 'json_object' } habilita el modo JSON para respuestas JSON válidas.

Devoluciones

Crear sesión hospedada

Crea una sesión de agente hospedada. Opcionalmente, seleccione una versión específica del agente; De lo contrario, la configuración de enrutamiento del agente hospedado selecciona la versión.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Clave de aislamiento de usuario
x-ms-user-isolation-key string

Clave de partición opcional para agentes hospedados configurados con aislamiento de sesión basado en encabezados. Use el mismo valor para cada operación de la sesión. Esta clave no proporciona autenticación.

Versión del agente
agent_version string

Una versión específica del agente hospedado para la sesión. Deje en blanco para usar la configuración de enrutamiento del agente hospedado.

Devoluciones

Crear subproceso

Crear subproceso

Parámetros

Nombre Clave Requerido Tipo Description
Versión de API
api-version True string

Versión de API

role
role string

Rol de la entidad que está creando el mensaje. Puede ser usuario o asistente. 'user' indica que un usuario real envía el mensaje y se debe usar en la mayoría de los casos para representar mensajes generados por el usuario. 'assistant' indica que el asistente genera el mensaje. Use este valor para insertar mensajes del asistente en la conversación.

contenido
content string

Contenido del mensaje.

nombre
name string

Lista de identificadores de archivo o mensajes que se pueden usar en la ejecución.

metadata
metadata object

Conjunto de 16 pares clave-valor que se pueden adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado. Las claves pueden tener un máximo de 64 caracteres y los valores pueden tener un máximo de 512 caracteres.

metadata
metadata object

Conjunto de 16 pares clave-valor que se pueden adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado. Las claves pueden tener un máximo de 64 caracteres y los valores pueden tener un máximo de 512 caracteres.

tool_resources
tool_resources object

Conjunto de recursos que están disponibles para las herramientas del asistente en este subproceso. Los recursos son específicos del tipo de herramienta. Por ejemplo, la herramienta code_interpreter requiere una lista de identificadores de archivo, mientras que la herramienta file_search requiere una lista de identificadores de almacén de vectores.

Devoluciones

Crear versión del agente hospedado

Crea una nueva versión del agente hospedado a partir de una imagen de contenedor.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Description
description string

Descripción legible de la versión del agente hospedado.

Metadata
metadata object

Metadatos que se van a asociar a la versión del agente hospedado.

Crear como borrador
draft boolean

Si se va a crear una versión de borrador. Las versiones de borrador se excluyen del enrutamiento y las listas normales.

Imagen de contenedor
image True string

Referencia de imagen de contenedor completa, por ejemplo, myregistry.azurecr.io/my-agent:v1.

Id. de conexión del Registro
registry_connection_id string

Identificador de conexión del proyecto Foundry para el registro de contenedor, cuando sea necesario.

Unidad Central de Procesamiento (CPU)
cpu True string

Número de núcleos de CPU solicitados para el contenedor del agente hospedado, por ejemplo 1.

Memory
memory True string

Cantidad de memoria solicitada para el contenedor del agente hospedado, por ejemplo 2Gi.

Protocol
protocol True string

Protocolo expuesto por el agente hospedado. Seleccione Respuestas o invocaciones.

Variables de entorno
environment_variables object

Variables de entorno pasadas al contenedor del agente hospedado.

Configuración de ia responsable
rai_config object

Configuración opcional de filtro de contenido de IA responsable.

Configuración de telemetría
telemetry_config object

Configuración de telemetría opcional.

Configuración de la sesión
session_configuration object

Configuración opcional de la sesión del agente hospedado.

Devoluciones

Descargar archivo de sesión hospedado

Descarga el contenido binario de un archivo desde una sesión hospedada.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Clave de aislamiento de usuario
x-ms-user-isolation-key string

Clave de partición opcional para agentes hospedados configurados con aislamiento de sesión basado en encabezados. Use el mismo valor para cada operación de la sesión. Esta clave no proporciona autenticación.

Identificador de sesión
SessionId True string

Identificador de sesión hospedado.

Ruta del archivo
path True string

Ruta de acceso del archivo o directorio en la sesión hospedada.

Devoluciones

Contenido del archivo de sesión hospedado.

Contenido del archivo
binary

Deshabilitar agente hospedado

Deshabilita un punto de conexión del agente hospedado sin eliminar el agente ni sus versiones.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Eliminar agente

Elimina permanentemente un agente y todas sus versiones. En el caso de los agentes hospedados, las sesiones activas provocan un conflicto a menos que la eliminación forzada esté habilitada.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Forzar eliminación
force boolean

En el caso de los agentes hospedados, elimine las sesiones activas asociadas con el agente o la versión.

Eliminar archivo de sesión hospedado

Elimina un archivo o directorio de una sesión hospedada.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Clave de aislamiento de usuario
x-ms-user-isolation-key string

Clave de partición opcional para agentes hospedados configurados con aislamiento de sesión basado en encabezados. Use el mismo valor para cada operación de la sesión. Esta clave no proporciona autenticación.

Identificador de sesión
SessionId True string

Identificador de sesión hospedado.

Ruta del archivo
path True string

Ruta de acceso del archivo o directorio en la sesión hospedada.

Eliminar sesión hospedada

Elimina una sesión del agente hospedado, finaliza su espacio aislado y libera sus recursos.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Clave de aislamiento de usuario
x-ms-user-isolation-key string

Clave de partición opcional para agentes hospedados configurados con aislamiento de sesión basado en encabezados. Use el mismo valor para cada operación de la sesión. Esta clave no proporciona autenticación.

Identificador de sesión
SessionId True string

Identificador de sesión hospedado.

Eliminar versión del agente

Elimina permanentemente una versión específica del agente. En el caso de los agentes hospedados, las sesiones activas provocan un conflicto a menos que la eliminación forzada esté habilitada.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Versión del agente
AgentVersion True string

Identificador de versión del agente.

Forzar eliminación
force boolean

En el caso de los agentes hospedados, elimine las sesiones activas asociadas con el agente o la versión.

Enumerar agentes (servicio de agente)

Enumerar agentes del servicio del agente

Devoluciones

Enumerar archivos de sesión hospedados

Enumera archivos y directorios en una ruta de acceso en una sesión hospedada.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Clave de aislamiento de usuario
x-ms-user-isolation-key string

Clave de partición opcional para agentes hospedados configurados con aislamiento de sesión basado en encabezados. Use el mismo valor para cada operación de la sesión. Esta clave no proporciona autenticación.

Identificador de sesión
SessionId True string

Identificador de sesión hospedado.

Ruta de acceso del directorio
path string

Ruta de acceso del directorio a la lista. El valor predeterminado es el directorio actual de la sesión.

Devoluciones

Enumerar sesiones hospedadas

Enumera las sesiones hospedadas de un agente al que se puede acceder al autor de la llamada.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Clave de aislamiento de usuario
x-ms-user-isolation-key string

Clave de partición opcional para agentes hospedados configurados con aislamiento de sesión basado en encabezados. Use el mismo valor para cada operación de la sesión. Esta clave no proporciona autenticación.

Devoluciones

Enumerar versiones del agente

Enumera las versiones de un agente.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Incluir versiones de borrador
include_drafts boolean

Si se van a incluir versiones de borrador. El servicio excluye borradores de forma predeterminada.

Limit
limit integer

Número máximo de versiones que se van a devolver.

Order
order string

Ordene por la marca de tiempo created_at.

Después del cursor
after string

Devuelve versiones después de este cursor.

Antes del cursor
before string

Devuelve versiones antes de este cursor.

Devoluciones

Habilitación del agente hospedado

Habilita un punto de conexión del agente hospedado para que pueda atender solicitudes.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Invocar agente hospedado (invocaciones)

Invoca un agente hospedado que expone el protocolo invocaciones. La implementación del agente hospedado define el JSON de solicitud y respuesta.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

object

La carga JSON esperada por el controlador de invocaciones del agente hospedado.

Devoluciones

response
object

Invocar agente hospedado (respuestas)

Invoca un agente hospedado que expone el protocolo De respuestas. La acción usa respuestas JSON que no son de streaming.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Input
input True

Texto, imagen, archivo o entrada estructurada para el agente hospedado.

Id. de respuesta anterior
previous_response_id string

Identificador de respuesta anterior para continuar una interacción de varios turnos.

Instrucciones
instructions string

Instrucciones adicionales para esta respuesta.

Respuesta de la tienda
store boolean

Indica si se va a almacenar la respuesta para la recuperación posterior.

Ejecutar en segundo plano
background boolean

Si se va a ejecutar la respuesta en segundo plano.

Número máximo de tokens de salida
max_output_tokens integer

Número máximo de tokens de salida.

Metadata
metadata object

Metadatos que se van a asociar a la respuesta.

Usuario
user string

Identificador único para el usuario final.

Devoluciones

Invoke Prompt Agent

Invoca un agente de solicitud.

Parámetros

Nombre Clave Requerido Tipo Description
Versión de API
api-version True string

Versión de API

metadata
metadata object

Conjunto de 16 pares clave-valor que se pueden adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en 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.

user
user string

Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos. Más información.

top_logprobs
top_logprobs integer

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.

previous_response_id
previous_response_id string

Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno. Más información sobre el estado de la conversación.

background
background boolean

Si se va a ejecutar la respuesta del modelo en segundo plano. Más información.

max_output_tokens
max_output_tokens integer

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.

max_tool_calls
max_tool_calls integer

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.

type
type True string

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. Obtenga más información en la guía de salidas estructuradas.

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.

type
type True string

Herramienta que se puede usar para generar una respuesta.

tool_choice
tool_choice

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

id
id True string

Identificador único de la plantilla de solicitud que se va a usar.

version
version string

Versión opcional de la plantilla de solicitud.

variables
variables object

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.

truncation
truncation string

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á la respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en medio de la conversación.
  • disabled (valor predeterminado): si una respuesta del modelo superará el tamaño de la ventana de contexto de un modelo, se producirá un error 400 en la solicitud.
entrada
input

Entradas de texto, imagen o archivo al modelo, usadas para generar una respuesta.

Aprende más:

incluír
include string

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).
parallel_tool_calls
parallel_tool_calls boolean

Si se permite que el modelo ejecute llamadas de herramienta en paralelo.

store
store boolean

Si se va a almacenar la respuesta del modelo generada para su recuperación posterior a través de la API.

instructions
instructions string

Mensaje del sistema (o desarrollador) insertado en el contexto del modelo.

Al usar junto con previous_response_id, las instrucciones de una respuesta anterior no se transferirán a la siguiente respuesta. Esto facilita el intercambio de mensajes del sistema (o desarrollador) en nuevas respuestas.

Id. de conversación
id True string

Identificador de conversación. Seleccione "Crear nueva conversación" para crear una nueva conversación.

type
type True string
nombre
name True string

Nombre del agente.

version
version True string

Identificador de versión del agente.

Devoluciones

Mensajes de lista

Mensajes de lista

Parámetros

Nombre Clave Requerido Tipo Description
Versión de API
api-version True string

Versión de API

Identificador del subproceso para el que se va a crear un mensaje.
ThreadId True string

Identificador del subproceso para el que se va a crear un mensaje.

Devoluciones

Obtener agente

Obtiene un agente y su versión más reciente.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Devoluciones

Obtener sesión hospedada

Obtiene una sesión de agente hospedada por su identificador de sesión.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Clave de aislamiento de usuario
x-ms-user-isolation-key string

Clave de partición opcional para agentes hospedados configurados con aislamiento de sesión basado en encabezados. Use el mismo valor para cada operación de la sesión. Esta clave no proporciona autenticación.

Identificador de sesión
SessionId True string

Identificador de sesión hospedado.

Devoluciones

Obtener versión del agente

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

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del agente
AgentName True string

Nombre del agente.

Versión del agente
AgentVersion True string

Identificador de versión del agente.

Devoluciones

Protocolo de actividad del agente externo basado en el identificador del agente

Protocolo de actividad del agente externo basado en el identificador del agente

Parámetros

Nombre Clave Requerido Tipo Description
Identificador del agente al que se va a enviar un mensaje.
AgentId True string

Identificador del agente al que se va a enviar un mensaje.

object

Devoluciones

response
object

Protocolo de actividad del agente externo basado en el identificador del agente con el punto de conexión V2

Protocolo de actividad del agente externo basado en el identificador del agente con el punto de conexión V2

Parámetros

Nombre Clave Requerido Tipo Description
Identificador del agente al que se va a enviar un mensaje.
AgentId True string

Identificador del agente al que se va a enviar un mensaje.

object

Devoluciones

response
object

Protocolo de actividad del agente externo basado en la aplicación

Protocolo de actividad del agente externo basado en la aplicación

Parámetros

Nombre Clave Requerido Tipo Description
Aplicación del agente.
MyApplication True string

Aplicación del agente.

object

Devoluciones

response
object

Definiciones

listAgentsResponse

Nombre Ruta de acceso Tipo Description
objeto
object string

Detalles del tipo de objeto de respuesta.

datos
data array of Data

Lista de mensajes devueltos por el servicio.

first_id
first_id string

Detalles del primer identificador.

last_id
last_id string

Detalles del último identificador.

has_more
has_more boolean

Indica si hay más agentes allí.

listAgentsServiceResponse

Nombre Ruta de acceso Tipo Description
datos
data array of AgentServiceData

Lista de agentes devueltos por el servicio.

AgentServiceData

Nombre Ruta de acceso Tipo Description
id
id string

Identificador único del agente.

nombre
name string

Nombre del agente.

descripción
description string

Descripción del agente.

version
version string

Versión del agente.

createdAt
createdAt date-time

Cuando se creó el agente.

AgentRecord

Nombre Ruta de acceso Tipo Description
objeto
object string

Tipo de objeto.

id
id string

Identificador único del agente.

nombre
name string

Nombre del agente.

state
state string

El estado operativo del agente.

configuration_state
configuration_state string

Estado de configuración del agente.

state_source
state_source string

Origen del estado actual.

versions
versions AgentRecordVersions
agent_endpoint
agent_endpoint object

Configuración del punto de conexión para el agente.

digital_worker_type
digital_worker_type string

Tipo de trabajo digital, cuando sea aplicable.

instance_identity
instance_identity object

Identidad de instancia del agente.

plano
blueprint object

Identidad del plano técnico del agente.

blueprint_reference
blueprint_reference object

La referencia del plano para el agente.

agent_card
agent_card object

La tarjeta del agente, cuando esté disponible.

AgentRecordVersions

Nombre Ruta de acceso Tipo Description
más reciente
latest AgentVersionRecord

AgentVersionRecord

Nombre Ruta de acceso Tipo Description
metadata
metadata object

Metadatos asociados a la versión del agente.

objeto
object string

Tipo de objeto.

id
id string

Identificador único de la versión del agente.

nombre
name string

Nombre del agente.

version
version string

El identificador de versión.

descripción
description string

Descripción legible de la versión del agente.

fecha_de_creación
created_at integer

Marca de tiempo de Unix, en segundos, cuando se creó la versión del agente.

definición
definition object

Definición del agente.

draft
draft boolean

Si se trata de una versión de borrador.

estado
status string

El estado de aprovisionamiento de la versión agente.

instance_identity
instance_identity object

Identidad de instancia de la versión del agente.

plano
blueprint object

Identidad del plano técnico de la versión del agente.

blueprint_reference
blueprint_reference object

Referencia de plano técnico para la versión del agente.

agent_guid
agent_guid string

El identificador GUID único del agente.

AgentVersionListResponse

Nombre Ruta de acceso Tipo Description
objeto
object string

Tipo de objeto.

datos
data array of AgentVersionRecord

Lista de versiones del agente devueltas por el servicio.

first_id
first_id string

El primer identificador de objeto de la página.

last_id
last_id string

El último identificador de objeto de la página.

has_more
has_more boolean

Si hay más resultados disponibles.

HostedSession

Nombre Ruta de acceso Tipo Description
agent_session_id
agent_session_id string

Identificador de sesión hospedado.

version_indicator
version_indicator HostedSessionVersionIndicator
estado
status string

Estado de la sesión actual.

fecha_de_creación
created_at integer

Marca de tiempo de Unix, en segundos, cuando se creó la sesión.

last_accessed_at
last_accessed_at integer

Marca de tiempo de Unix, en segundos, cuando se accedió por última vez a la sesión.

expires_at
expires_at integer

Marca de tiempo de Unix, en segundos, cuando expira la sesión.

stopped_at
stopped_at integer

Marca de tiempo de Unix, en segundos, cuando se detuvo la sesión, cuando corresponda.

HostedSessionVersionIndicator

Nombre Ruta de acceso Tipo Description
type
type string

Tipo de indicador de selección de versión.

agent_version
agent_version string

La versión del agente hospedado asignada a la sesión.

HostedSessionListResponse

Nombre Ruta de acceso Tipo Description
datos
data array of HostedSession

Las sesiones hospedadas devueltas por el servicio.

first_id
first_id string

El primer identificador de sesión hospedado en la página.

last_id
last_id string

El último identificador de sesión hospedado en la página.

has_more
has_more boolean

Si hay más sesiones hospedadas disponibles.

HostedSessionFileUploadResponse

Nombre Ruta de acceso Tipo Description
ruta
path string

Ruta de acceso del archivo cargado.

bytes_written
bytes_written integer

El número de bytes escritos.

éxito
success boolean

Indica si la carga se ha realizado correctamente.

tipo_de_fuente
source_type string

Tipo de origen usado para la carga.

HostedSessionFileListResponse

Nombre Ruta de acceso Tipo Description
ruta
path string

Ruta de acceso del directorio que se ha enumerado.

Entradas
entries array of HostedSessionFileEntry

Archivos y directorios en la ruta de acceso solicitada.

has_more
has_more boolean

Si hay más entradas disponibles.

HostedSessionFileEntry

Nombre Ruta de acceso Tipo Description
nombre
name string

El nombre de archivo o de directorio.

size
size integer

El tamaño del archivo en bytes.

is_directory
is_directory boolean

Si la entrada es un directorio.

modified_time
modified_time integer

Hora de modificación de la entrada según lo notificado por la sesión hospedada.

createThreadResponse

Nombre Ruta de acceso Tipo Description
id
id string

Identificador al que se puede hacer referencia en puntos de conexión de API.

objeto
object string

Tipo de objeto, que siempre es subproceso.

fecha_de_creación
created_at integer

Marca de tiempo Unix (en segundos) para el momento en que se creó el subproceso.

metadata
metadata object

Conjunto de 16 pares clave-valor que se pueden adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado. Las claves pueden tener un máximo de 64 caracteres y los valores pueden tener un máximo de 512 caracteres.

createRunResponse

Nombre Ruta de acceso Tipo Description
id
id string

Identificador al que se puede hacer referencia en puntos de conexión de API.

objeto
object string

Tipo de objeto, que siempre es thread.run.

fecha_de_creación
created_at integer

Marca de tiempo de Unix (en segundos) para cuando se creó la ejecución.

thread_id
thread_id string

Identificador del subproceso en el que se ejecutó como parte de esta ejecución.

assistant_id
assistant_id string

Identificador del asistente usado para la ejecución de esta ejecución.

estado
status string

Estado de la ejecución, que se puede poner en cola, in_progress, requires_action, cancelar, cancelar, cancelar, con errores, completar o expirar.

required_action
required_action object

Detalles sobre la acción necesaria para continuar la ejecución. Será null si no se requiere ninguna acción.

last_error
last_error object

El último error asociado a esta ejecución. Será null si no hay errores.

expires_at
expires_at integer

Marca de tiempo de Unix (en segundos) para cuando expire la ejecución.

started_at
started_at integer

Marca de tiempo de Unix (en segundos) para cuando se inició la ejecución.

fecha_de_cancelación
cancelled_at integer

Marca de tiempo de Unix (en segundos) para cuando se canceló la ejecución.

failed_at
failed_at integer

Marca de tiempo de Unix (en segundos) para cuando se produjo un error en la ejecución.

completado_en
completed_at integer

Marca de tiempo de Unix (en segundos) para cuando se completó la ejecución.

model
model string

Nombre de implementación del modelo que usó el asistente para esta ejecución.

instructions
instructions string

Las instrucciones que el asistente usó para esta ejecución.

herramientas
tools array of tools

Lista de herramientas que el asistente usó para esta ejecución.

identificadores de archivos
file_ids array of fileIds

Lista de identificadores de archivo que usa el asistente para esta ejecución.

metadata
metadata object

Conjunto de 16 pares clave-valor que se pueden adjuntar a un objeto. Las claves pueden tener un máximo de 64 caracteres y los valores pueden tener un máximo de 512 caracteres.

tool_choice
tool_choice

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 herramienta. Especificar una herramienta como {'type': 'file_search'} o {'type': 'function', 'function': {'name': 'my_function'}} obliga al modelo a llamar a esa herramienta.

max_prompt_tokens
max_prompt_tokens number

Número máximo de tokens de solicitud especificados que se usaron durante el transcurso de la ejecución.

max_completion_tokens
max_completion_tokens number

Número máximo de tokens de finalización especificados que se usaron durante el transcurso de la ejecución.

usage
usage object

Estadísticas de uso relacionadas con la ejecución. Este valor será NULL si la ejecución no está en un estado terminal (por ejemplo, in_progress, en cola).

truncation_strategy
truncation_strategy object

Controla cómo se trunca un subproceso antes de la ejecución.

formato_de_respuesta
response_format string

Formato que debe generar el modelo. Compatible con GPT-4 Turbo y todos los modelos GPT-3.5 Turbo desde gpt-3.5-turbo-1106.

getRunResponse

Nombre Ruta de acceso Tipo Description
id
id string

Identificador al que se puede hacer referencia en puntos de conexión de API.

objeto
object string

Tipo de objeto, que siempre es thread.run.

fecha_de_creación
created_at integer

Marca de tiempo de Unix (en segundos) para cuando se creó la ejecución.

thread_id
thread_id string

Identificador del subproceso en el que se ejecutó como parte de esta ejecución.

assistant_id
assistant_id string

Identificador del asistente usado para la ejecución de esta ejecución.

estado
status string

Estado de la ejecución, que se puede poner en cola, in_progress, requires_action, cancelar, cancelar, cancelar, con errores, completar o expirar.

required_action
required_action object

Detalles sobre la acción necesaria para continuar la ejecución. Será null si no se requiere ninguna acción.

last_error
last_error object

El último error asociado a esta ejecución. Será null si no hay errores.

expires_at
expires_at integer

Marca de tiempo de Unix (en segundos) para cuando expire la ejecución.

started_at
started_at integer

Marca de tiempo de Unix (en segundos) para cuando se inició la ejecución.

fecha_de_cancelación
cancelled_at integer

Marca de tiempo de Unix (en segundos) para cuando se canceló la ejecución.

failed_at
failed_at integer

Marca de tiempo de Unix (en segundos) para cuando se produjo un error en la ejecución.

completado_en
completed_at integer

Marca de tiempo de Unix (en segundos) para cuando se completó la ejecución.

model
model string

Nombre de implementación del modelo que usó el asistente para esta ejecución.

instructions
instructions string

Las instrucciones que el asistente usó para esta ejecución.

herramientas
tools array of tools

Lista de herramientas que el asistente usó para esta ejecución.

identificadores de archivos
file_ids array of fileIds

Lista de identificadores de archivo que usa el asistente para esta ejecución.

metadata
metadata object

Conjunto de 16 pares clave-valor que se pueden adjuntar a un objeto. Las claves pueden tener un máximo de 64 caracteres y los valores pueden tener un máximo de 512 caracteres.

tool_choice
tool_choice

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 herramienta. Especificar una herramienta como {'type': 'file_search'} o {'type': 'function', 'function': {'name': 'my_function'}} obliga al modelo a llamar a esa herramienta.

max_prompt_tokens
max_prompt_tokens number

Número máximo de tokens de solicitud especificados que se usaron durante el transcurso de la ejecución.

max_completion_tokens
max_completion_tokens number

Número máximo de tokens de finalización especificados que se usaron durante el transcurso de la ejecución.

usage
usage object

Estadísticas de uso relacionadas con la ejecución. Este valor será NULL si la ejecución no está en un estado terminal (por ejemplo, in_progress, en cola).

truncation_strategy
truncation_strategy object

Controla cómo se trunca un subproceso antes de la ejecución.

formato_de_respuesta
response_format string

Formato que debe generar el modelo. Compatible con GPT-4 Turbo y todos los modelos GPT-3.5 Turbo desde gpt-3.5-turbo-1106.

listMessageResponse

Nombre Ruta de acceso Tipo Description
objeto
object string

Detalles del tipo de objeto de respuesta

datos
data array of Data

Lista de mensajes devueltos por el servicio.

first_id
first_id string

Detalles del primer identificador

last_id
last_id string

Detalles del último identificador

has_more
has_more boolean

Indica si hay más agentes allí

Data

Nombre Ruta de acceso Tipo Description
id
id string

Identificador al que se puede hacer referencia en puntos de conexión de API.

objeto
object string

Tipo de objeto, que siempre es asistente.

fecha_de_creación
created_at integer

Marca de tiempo de Unix (en segundos) para cuando se creó el asistente.

nombre
name string

Nombre del asistente. La longitud máxima es de 256 caracteres.

descripción
description string

Descripción del asistente. La longitud máxima es de 512 caracteres.

model
model string

Nombre del nombre de implementación del modelo que se va a usar.

instructions
instructions string

Las instrucciones del sistema que usa el asistente. La longitud máxima es de 32768 caracteres.

herramientas
tools array of tools

Lista de herramientas habilitadas en el asistente. Puede haber un máximo de 128 herramientas por asistente. Las herramientas pueden ser de tipos code_interpreter o función. Una descripción de función puede tener un máximo de 1024 caracteres.

metadata
metadata object

Conjunto de 16 pares clave-valor que se pueden adjuntar a un objeto. Útil para almacenar información adicional en un formato estructurado. Las claves pueden tener un máximo de 64 caracteres y los valores pueden tener un máximo de 512 caracteres.

temperatura
temperature number

De manera predeterminada, su valor es 1. Determina la temperatura de muestreo que se va a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista.

top_p
top_p number

De manera predeterminada, su valor es 1. Una alternativa al muestreo con temperatura, llamada muestreo de núcleo, donde el modelo considera los resultados de los tokens con masa de probabilidad top_p. Así, 0,1 significa que solo se consideran los tokens que comprenden la masa de probabilidad del 10% superior.

formato_de_respuesta
response_format object

Especifica el formato que debe generar el modelo. Al establecer este parámetro en { 'type': 'json_object' } se habilita el modo JSON, lo que garantiza que el mensaje es json válido.

tool_resources
tool_resources object

Conjunto de recursos que usan las herramientas del asistente. Los recursos son específicos del tipo de herramienta. Por ejemplo, la herramienta code_interpreter requiere una lista de identificadores de archivo, mientras que la herramienta file_search requiere una lista de identificadores de almacén de vectores.

OpenAI.ServiceTier

Especifica el tipo de procesamiento utilizado para atender la solicitud.

  • Si se establece en "auto", la solicitud se procesará con el nivel de servicio configurado en la configuración de Project. A menos que se configure lo contrario, el Project usará "default".
  • Si se establece en "valor predeterminado", la solicitud se procesará con los precios estándar y el rendimiento del modelo seleccionado.
  • Si se establece en "flex" o "priority", la solicitud se procesará con el nivel de servicio correspondiente. 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 .

Especifica el tipo de procesamiento utilizado para atender la solicitud.

  • Si se establece en "auto", la solicitud se procesará con el nivel de servicio configurado en la configuración de Project. A menos que se configure lo contrario, el Project usará "default".
  • Si se establece en "valor predeterminado", la solicitud se procesará con los precios estándar y el rendimiento del modelo seleccionado.
  • Si se establece en "flex" o "priority", la solicitud se procesará con el nivel de servicio correspondiente. 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 .

OpenAI.Reasoning

Solo modelos de la serie o

Opciones de configuración para modelos de razonamiento.

Nombre Ruta de acceso Tipo Description
effort
effort string
summary
summary string

Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno deauto, concise o detailed.

generate_summary
generate_summary string

En desuso: 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 deauto, concise o detailed.

OpenAI.ResponseTextFormatConfiguration

Nombre Ruta de acceso Tipo Description
type
type 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. Obtenga más información en la guía de salidas estructuradas.

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.

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. Obtenga más información en la guía de salidas estructuradas.

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.

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. Obtenga más información en la guía de salidas estructuradas.

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.

OpenAI.Tool

Nombre Ruta de acceso Tipo Description
type
type OpenAI.ToolType

Herramienta que se puede usar para generar una respuesta.

OpenAI.ToolType

Herramienta que se puede usar para generar una respuesta.

Herramienta que se puede usar para generar una respuesta.

OpenAI.Prompt

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

Nombre Ruta de acceso Tipo Description
id
id string

Identificador único de la plantilla de solicitud que se va a usar.

version
version string

Versión opcional de la plantilla de solicitud.

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

OpenAI.Response

Nombre Ruta de acceso Tipo Description
metadata
metadata object

Conjunto de 16 pares clave-valor que se pueden adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en 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.

temperatura
temperature float

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.

top_p
top_p float

Una alternativa al muestreo con temperatura, llamada muestreo de núcleo, donde el modelo considera los resultados de los tokens con masa de probabilidad top_p. Así, 0,1 significa que solo se consideran los tokens que comprenden la masa de probabilidad del 10% superior.

Por lo general, recomendamos modificar esto o temperature, pero no ambos.

user
user string

Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos. Más información.

nivel de servicio
service_tier OpenAI.ServiceTier

Especifica el tipo de procesamiento utilizado para atender la solicitud.

  • Si se establece en "auto", la solicitud se procesará con el nivel de servicio configurado en la configuración de Project. A menos que se configure lo contrario, el Project usará "default".
  • Si se establece en "valor predeterminado", la solicitud se procesará con los precios estándar y el rendimiento del modelo seleccionado.
  • Si se establece en "flex" o "priority", la solicitud se procesará con el nivel de servicio correspondiente. 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 .

top_logprobs
top_logprobs integer

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.

previous_response_id
previous_response_id string

Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno. Más información sobre el estado de la conversación.

model
model string

Implementación del modelo que se va a usar para la creación de esta respuesta.

reasoning
reasoning OpenAI.Reasoning

Solo modelos de la serie o

Opciones de configuración para modelos de razonamiento.

background
background boolean

Si se va a ejecutar la respuesta del modelo en segundo plano. Más información.

max_output_tokens
max_output_tokens integer

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.

max_tool_calls
max_tool_calls integer

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.

format
text.format OpenAI.ResponseTextFormatConfiguration
herramientas
tools array of OpenAI.Tool

Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Puede especificar qué herramienta usar estableciendo el tool_choice parámetro .

Las dos categorías de herramientas que puede proporcionar al modelo son:

tool_choice
tool_choice

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

inmediato
prompt OpenAI.Prompt

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

truncation
truncation string

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á la respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en medio de la conversación.
  • disabled (valor predeterminado): si una respuesta del modelo superará el tamaño de la ventana de contexto de un modelo, se producirá un error 400 en la solicitud.
id
id string

Identificador único de esta respuesta.

objeto
object string

El tipo de objeto de este recurso: siempre se establece en response.

estado
status string

Estado de la generación de respuesta. Uno de estos valores completed, failed, in_progress, cancelled, queued, o incomplete.

fecha_de_creación
created_at unixtime

Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.

error
error OpenAI.ResponseError

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

reason
incomplete_details.reason string

Motivo por el que la respuesta está incompleta.

output
output array of OpenAI.ItemResource

Matriz de elementos de contenido generados por el modelo.

  • La longitud y el orden de los elementos de la output matriz dependen de la respuesta del modelo.
  • En lugar de acceder al primer elemento de la output matriz y suponiendo que sea un assistant mensaje con el contenido generado por el modelo, puede considerar la posibilidad de usar la output_text propiedad donde se admiten en los SDK.
instructions
instructions

Mensaje del sistema (o desarrollador) insertado en el contexto del modelo.

Al usar junto con previous_response_id, las instrucciones de una respuesta anterior no se transferirán a la siguiente respuesta. Esto facilita el intercambio de mensajes del sistema (o desarrollador) en nuevas respuestas.

output_text
output_text string

Propiedad de conveniencia solo para SDK, que contiene la salida de texto agregada de todos los output_text elementos de la matriz output, si hay alguno presente. Se admite en los SDK de JavaScript y Python.

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

parallel_tool_calls
parallel_tool_calls boolean

Si se permite que el modelo ejecute llamadas de herramienta en paralelo.

id
conversation.id string

Identificador de conversación para establecer la conversación para esta respuesta. Si se proporciona "crear nueva conversación", se iniciará una nueva conversación con esta respuesta como primer mensaje.

agent
agent AgentId

OpenAI.ResponseError

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

Nombre Ruta de acceso Tipo Description
código
code OpenAI.ResponseErrorCode

Código de error de la respuesta.

Mensaje
message string

Una descripción legible del error.

OpenAI.ResponseErrorCode

Código de error de la respuesta.

Código de error de la respuesta.

OpenAI.ItemResource

Elemento de contenido usado para generar una respuesta.

Nombre Ruta de acceso Tipo Description
type
type OpenAI.ItemType
id
id string

OpenAI.ItemType

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 Ruta de acceso Tipo Description
input_tokens
input_tokens integer

Número de tokens de entrada.

cached_tokens
input_tokens_details.cached_tokens integer

Número de tokens que se recuperaron de la memoria caché. Más información sobre el almacenamiento en caché de solicitudes.

output_tokens
output_tokens integer

Número de tokens de salida.

reasoning_tokens
output_tokens_details.reasoning_tokens integer

Número de elementos de razonamiento.

total_tokens
total_tokens integer

Número total de tokens usados.

AgentId

Nombre Ruta de acceso Tipo Description
type
type string
nombre
name string

Nombre del agente.

version
version string

Identificador de versión del agente.

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.

Nombre Ruta de acceso Tipo Description
object

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.

herramientas

Nombre Ruta de acceso Tipo Description
nombre
name string

Lista de herramientas que se pueden usar en la ejecución.

fileIds

Nombre Ruta de acceso Tipo Description
nombre
name string

Lista de identificadores de archivo que se pueden usar en la ejecución.

objeto

Este es el tipo 'objeto'.

binary

Este es el tipo de datos básico "binary".