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 | Premium | Todas las regiones de 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 - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de 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 | Premium | Todas las regiones de 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 | |
|---|---|
| Publicador | 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 |
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Identidad administrada de Logic Apps | Creación de una conexión mediante una identidad administrada de LogicApps | Solo LOGICAPPS | Compartible |
| Inicio de sesión de usuario de Microsoft Entra ID | Inicio de sesión con credenciales de Id. de Entra de Microsoft | 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 de Logic Apps
Identificador de autenticación: managedIdentityAuth
Aplicable: SOLO LOGICAPPS
Creación de una conexión mediante una identidad administrada de LogicApps
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 más información, consulte introducción a los conectores para aplicaciones de lienzo: Power Apps | Microsoft Docs
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Identidad administrada de LogicApps | managedIdentity | Inicio de sesión con una identidad administrada de Logic Apps | Cierto |
| Punto de conexión del proyecto de Azure AI | cuerda / cadena | Nombre del punto de conexión del proyecto de Azure AI, 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 Id. de Entra de Microsoft
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 del proyecto de Azure AI | cuerda / cadena | Nombre del punto de conexión del proyecto de Azure AI, 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
| Agentes de lista |
Agentes de lista |
| Corre |
Corre |
| Crear ejecución |
Crear ejecución |
| Crear subproceso |
Crear subproceso |
| Invocar agente |
Invocar agente. |
| Mensajes de lista |
Mensajes de lista |
| 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 la aplicación |
Protocolo de actividad del agente externo basado en la aplicación |
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
- Body
- listAgentsResponse
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
- Body
- getRunResponse
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 | object |
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
- Body
- createRunResponse
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
- Body
- createThreadResponse
Invocar agente
Invocar agente.
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.
El formato predeterminado es No se recomienda para los modelos gpt-4o y más recientes: Establecer en |
|
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 |
||
|
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.
|
|
|
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:
|
|
|
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 |
|
|
type
|
type | True | string | |
|
nombre
|
name | True | string |
Nombre del agente. |
|
version
|
version | True | string |
Identificador de versión del agente. |
Devoluciones
- Body
- OpenAI.Response
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
- Body
- listMessageResponse
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 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í. |
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 | object |
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 | object |
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 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 .
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 .
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 de |
|
generate_summary
|
generate_summary | string |
En desuso: use Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo.
Uno de |
OpenAI.ResponseTextFormatConfiguration
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
type | OpenAI.ResponseTextFormatConfigurationType |
Objeto que especifica el formato que debe generar el modelo.
El formato predeterminado es No se recomienda para los modelos gpt-4o y más recientes: Establecer en |
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
|
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 |
|
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.
Cuando se establece el |
|
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 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 |
|
|
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.
|
|
id
|
id | string |
Identificador único de esta respuesta. |
|
objeto
|
object | string |
El tipo de objeto de este recurso: siempre se establece en |
|
estado
|
status | string |
Estado de la generación de respuesta. Uno de estos valores |
|
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.
|
|
instructions
|
instructions |
Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Al usar junto con |
|
|
output_text
|
output_text | string |
Propiedad de conveniencia solo para SDK, que contiene la salida de texto agregada de todos los |
|
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 | |
|
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
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'.