Asistentes de OpenAI (publicador independiente) (versión preliminar)
OpenAI Assistants permite crear asistentes de inteligencia artificial dentro de sus propias aplicaciones. Un Asistente tiene instrucciones y puede aprovechar modelos, herramientas y conocimientos para responder a las consultas de usuario. El servicio Assistants admite actualmente tres tipos de herramientas: intérprete de código, recuperación y llamada a funciones.
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 | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| Correo Electrónico | ttaylor@hitachisolutions.com |
| Metadatos del conector | |
|---|---|
| Publicador | Troy Taylor |
| Sitio web | https://openai.com/ |
| Directiva de privacidad | https://openai.com/policies/privacy-policy |
| Categorías | AI |
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
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 |
|---|---|---|---|
| Clave de API (con el formato "Bearer $OPENAI_API_KEY") | securestring | La clave de API (con el formato "Bearer $OPENAI_API_KEY") para esta API | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Asistente para eliminar |
Elimina un asistente. |
| Cancelar una ejecución |
Cancele una ejecución para un subproceso que esté en curso. |
| Creación de subprocesos y ejecución |
Crea un subproceso y lo ejecuta en una solicitud. |
| Creación de una ejecución |
Crea una ejecución para un subproceso. |
| Crear archivo del asistente |
Cree un archivo de asistente adjuntando un archivo a un asistente. |
| Crear asistente |
Cree un asistente con un modelo e instrucciones. |
| Crear conversación |
Crea un subproceso con el que los asistentes pueden interactuar. |
| Crear mensaje |
Cree un mensaje dentro de un subproceso. |
| Ejecuciones de lista |
Recupere una lista de ejecuciones de un subproceso. |
| Eliminar archivo del asistente |
Elimina un archivo de asistente. |
| Eliminar conversación |
Elimina una conversación. |
| Enumeración de modelos |
Enumera los modelos disponibles actualmente y proporciona información básica sobre cada uno de ellos, como el propietario y la disponibilidad. |
| Enumerar archivos de mensajes |
Recupera una lista de archivos de mensajes para un subproceso. |
| Enumerar asistentes |
Recupera una lista de asistentes. |
| Enumerar los pasos de ejecución |
Recupere una lista de los pasos de ejecución de un subproceso. |
| Enumerar mensajes |
Recupere una lista de mensajes para un subproceso determinado. |
| Envío de salidas de herramientas para ejecutar |
Cuando una ejecución tiene el estado "requires_action" y required_action.type es submit_tool_outputs, esta acción se puede usar para enviar las salidas de las llamadas a la herramienta una vez completadas. |
| Modificar ejecución |
Modifica una ejecución para un subproceso. |
| Modificar mensaje |
Modifica un mensaje. |
| Modificar un subproceso |
Modifica un subproceso. |
| Obtener archivos del asistente |
Recupera una lista de archivos de asistente. |
| Obtener conversación |
Recuperar un subproceso. |
| Obtener ejecución |
Recuperar una ejecución de un subproceso. |
| Obtener paso de ejecución |
Recuperar un paso de ejecución para un subproceso. |
| Recuperación del archivo de mensaje |
Recupera un archivo de mensaje de un subproceso. |
| Recuperación del archivo del asistente |
Recupera un archivo de asistente. |
| Recuperar asistente |
Recupera información sobre un asistente. |
Asistente para eliminar
Elimina un asistente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Id. del asistente
|
assistant_id | True | string |
Identificador del asistente. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Borrado
|
deleted | boolean |
Indica si se ha eliminado. |
Cancelar una ejecución
Cancele una ejecución para un subproceso que esté en curso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Identificador de subproceso
|
thread_id | True | string |
Identificador del subproceso. |
|
Id. de ejecución
|
run_id | True | string |
El identificador de ejecución. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
|
Id. del asistente
|
assistant_id | string |
Identificador del asistente. |
|
Identificador de subproceso
|
thread_id | string |
Identificador del subproceso. |
|
Estado
|
status | string |
Estado. |
|
Iniciado en
|
started_at | integer |
Cuando se inicia en. |
|
Expira a las
|
expires_at | integer |
Cuando expira. |
|
Cancelada en
|
cancelled_at | string |
Cuando se cancela en. |
|
Error en
|
failed_at | string |
Cuando se produce un error. |
|
Completado en
|
completed_at | string |
Cuando se complete en. |
|
Último error
|
last_error | string |
Último error. |
|
Modelo
|
model | string |
Modelo. |
|
Instrucciones
|
instructions | string |
Las instrucciones. |
|
Tools
|
tools | array of object | |
|
Tipo
|
tools.type | string |
Tipo de herramientas. |
|
Identificadores de archivo
|
file_ids | array of string |
Identificadores de archivo. |
Creación de subprocesos y ejecución
Crea un subproceso y lo ejecuta en una solicitud.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Id. del asistente
|
assistant_id | string |
Identificador del asistente. |
|
|
Rol
|
role | string |
Rol. |
|
|
Content
|
content | string |
El contenido. |
|
|
Modelo
|
model | string |
Modelo. |
|
|
Instrucciones
|
instructions | string |
Las instrucciones. |
|
|
Tipo
|
type | string |
Tipo de herramientas. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
|
Id. del asistente
|
assistant_id | string |
Identificador del asistente. |
|
Identificador de subproceso
|
thread_id | string |
Identificador del subproceso. |
|
Estado
|
status | string |
Estado. |
|
Iniciado en
|
started_at | string |
Cuando se inicia en. |
|
Expira a las
|
expires_at | integer |
Cuando expira. |
|
Cancelada en
|
cancelled_at | string |
Cuando se cancela en. |
|
Error en
|
failed_at | string |
Cuando se produce un error. |
|
Completado en
|
completed_at | string |
Cuando se complete en. |
|
Último error
|
last_error | string |
Último error. |
|
Modelo
|
model | string |
Modelo. |
|
Instrucciones
|
instructions | string |
Las instrucciones. |
|
Tools
|
tools | array of object | |
|
Tipo
|
tools.type | string |
Tipo de herramientas. |
|
Identificadores de archivo
|
file_ids | array of string |
Identificadores de archivo. |
Creación de una ejecución
Crea una ejecución para un subproceso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Identificador de subproceso
|
thread_id | True | string |
Identificador del subproceso. |
|
Id. del asistente
|
assistant_id | string |
Identificador del asistente. |
|
|
Modelo
|
model | True | string |
Modelo. |
|
Instrucciones
|
instructions | string |
Las instrucciones. |
|
|
Tipo
|
type | string |
Tipo de herramientas. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
|
Id. del asistente
|
assistant_id | string |
Identificador del asistente. |
|
Identificador de subproceso
|
thread_id | string |
Identificador del subproceso. |
|
Estado
|
status | string |
Estado. |
|
Iniciado en
|
started_at | integer |
Cuando se inicia en. |
|
Expira a las
|
expires_at | string |
Cuando expira. |
|
Cancelada en
|
cancelled_at | string |
Cuando se cancela en. |
|
Error en
|
failed_at | string |
Cuando se produce un error. |
|
Completado en
|
completed_at | integer |
Cuando se complete en. |
|
Último error
|
last_error | string |
Último error. |
|
Modelo
|
model | string |
Modelo. |
|
Instrucciones
|
instructions | string |
Las instrucciones. |
|
Tools
|
tools | array of object | |
|
Tipo
|
tools.type | string |
Tipo de herramientas. |
|
Identificadores de archivo
|
file_ids | array of string |
Identificadores de archivo. |
Crear archivo del asistente
Cree un archivo de asistente adjuntando un archivo a un asistente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Id. del asistente
|
assistant_id | True | string |
Identificador del asistente. |
|
Id. de archivo
|
file_id | True | string |
Identificador de archivo. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
|
Id. del asistente
|
assistant_id | string |
Identificador del asistente. |
Crear asistente
Cree un asistente con un modelo e instrucciones.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Modelo
|
model | True | string |
Modelo. |
|
Instrucciones
|
instructions | string |
Las instrucciones. |
|
|
Nombre
|
name | string |
Nombre. |
|
|
Description
|
description | string |
Descripción. |
|
|
Tipo
|
type | string |
Tipo de herramientas. |
|
|
Identificadores de archivo
|
file_ids | array of string |
Identificadores de archivo. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
|
Nombre
|
name | string |
Nombre. |
|
Description
|
description | string |
Descripción. |
|
Modelo
|
model | string |
Modelo. |
|
Instrucciones
|
instructions | string |
Las instrucciones. |
|
Tools
|
tools | array of object | |
|
Tipo
|
tools.type | string |
Tipo de herramienta. |
|
Identificadores de archivo
|
file_ids | array of string |
Identificadores de archivo. |
Crear conversación
Crea un subproceso con el que los asistentes pueden interactuar.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
identificación
|
id | string |
Identificador. |
|
|
Objeto
|
object | string |
Objeto . |
|
|
Creado en
|
created_at | integer |
Cuando se crea en . |
|
|
Identificador de subproceso
|
thread_id | string |
Identificador del subproceso. |
|
|
Rol
|
role | True | string |
Rol. |
|
Content
|
content | True | string |
El contenido. |
|
Identificadores de archivo
|
file_ids | array of string |
Identificadores de archivo. |
|
|
Id. del asistente
|
assistant_id | string |
Identificador del asistente. |
|
|
Id. de ejecución
|
run_id | string |
El identificador de ejecución. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
Crear mensaje
Cree un mensaje dentro de un subproceso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Identificador de subproceso
|
thread_id | True | string |
Identificador del subproceso. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
|
Identificador de subproceso
|
thread_id | string |
Identificador del subproceso. |
|
Rol
|
role | string |
Rol. |
|
Content
|
content | array of object | |
|
Tipo
|
content.type | string |
Tipo de herramientas. |
|
Importancia
|
content.text.value | string |
Valor. |
|
Annotations
|
content.text.annotations | array of string |
Las anotaciones. |
|
Identificadores de archivo
|
file_ids | array of string |
Identificadores de archivo. |
|
Id. del asistente
|
assistant_id | string |
Identificador del asistente. |
|
Id. de ejecución
|
run_id | string |
El identificador de ejecución. |
Ejecuciones de lista
Recupere una lista de ejecuciones de un subproceso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Identificador de subproceso
|
thread_id | True | string |
Identificador del subproceso. |
|
Limit
|
limit | integer |
El límite. |
|
|
Pedido
|
order | string |
Orden. |
|
|
Después
|
after | string |
El después. |
|
|
Antes
|
before | string |
Antes. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Objeto
|
object | string |
Objeto . |
|
Data
|
data | array of object | |
|
identificación
|
data.id | string |
Identificador. |
|
Objeto
|
data.object | string |
Objeto . |
|
Creado en
|
data.created_at | integer |
Cuando se crea en . |
|
Id. del asistente
|
data.assistant_id | string |
Identificador del asistente. |
|
Identificador de subproceso
|
data.thread_id | string |
Identificador del subproceso. |
|
Estado
|
data.status | string |
Estado. |
|
Iniciado en
|
data.started_at | integer |
Cuando se inicia en. |
|
Expira a las
|
data.expires_at | string |
Cuando expira. |
|
Cancelada en
|
data.cancelled_at | string |
Cuando se cancela en. |
|
Error en
|
data.failed_at | string |
Cuando se produce un error. |
|
Completado en
|
data.completed_at | integer |
Cuando se complete en. |
|
Último error
|
data.last_error | string |
Último error. |
|
Modelo
|
data.model | string |
Modelo. |
|
Instrucciones
|
data.instructions | string |
Las instrucciones. |
|
Tools
|
data.tools | array of object | |
|
Tipo
|
data.tools.type | string |
Tipo. |
|
Identificadores de archivo
|
data.file_ids | array of string |
Identificadores de archivo. |
|
Primer identificador
|
first_id | string |
Primer identificador. |
|
Último identificador
|
last_id | string |
Último identificador. |
|
Tiene más
|
has_more | boolean |
Si tiene más. |
Eliminar archivo del asistente
Elimina un archivo de asistente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Id. del asistente
|
assistant_id | True | string |
Identificador del asistente. |
|
Id. de archivo
|
file_id | True | string |
Identificador de archivo. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Borrado
|
deleted | boolean |
Indica si se ha eliminado. |
Eliminar conversación
Elimina una conversación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Identificador de subproceso
|
thread_id | True | string |
Identificador del subproceso. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Borrado
|
deleted | boolean |
Indica si se ha eliminado. |
Enumeración de modelos
Enumera los modelos disponibles actualmente y proporciona información básica sobre cada uno de ellos, como el propietario y la disponibilidad.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Objeto
|
object | string |
Objeto . |
|
Data
|
data | array of object | |
|
identificación
|
data.id | string |
Identificador. |
|
Objeto
|
data.object | string |
Objeto . |
|
Creado
|
data.created | integer |
Cuando se crea. |
|
Propiedad de
|
data.owned_by | string |
Propiedad de . |
Enumerar archivos de mensajes
Recupera una lista de archivos de mensajes para un subproceso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Identificador de subproceso
|
thread_id | True | string |
Identificador del subproceso. |
|
Id. de mensaje
|
message_id | True | string |
Identificador del mensaje. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Objeto
|
object | string |
Objeto . |
|
Data
|
data | array of object | |
|
identificación
|
data.id | string |
Identificador. |
|
Objeto
|
data.object | string |
Objeto . |
|
Creado en
|
data.created_at | integer |
Cuando se crea en . |
|
Id. de mensaje
|
data.message_id | string |
Identificador del mensaje. |
|
Primer identificador
|
first_id | string |
Primer identificador. |
|
Último identificador
|
last_id | string |
Último identificador. |
|
Tiene más
|
has_more | boolean |
Si tiene más. |
Enumerar asistentes
Recupera una lista de asistentes.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Objeto
|
object | string |
Objeto . |
|
Data
|
data | array of object | |
|
identificación
|
data.id | string |
Identificador. |
|
Objeto
|
data.object | string |
Objeto . |
|
Creado en
|
data.created_at | integer |
Cuando se crea en . |
|
Nombre
|
data.name | string |
Nombre. |
|
Description
|
data.description | string |
Descripción. |
|
Modelo
|
data.model | string |
Modelo. |
|
Instrucciones
|
data.instructions | string |
Las instrucciones. |
|
Tools
|
data.tools | array of object | |
|
Tipo
|
data.tools.type | string |
Tipo. |
|
Identificadores de archivo
|
data.file_ids | array of string |
Identificadores de archivo. |
|
Primer identificador
|
first_id | string |
Primer identificador. |
|
Último identificador
|
last_id | string |
Último identificador. |
|
Tiene más
|
has_more | boolean |
Si tiene más. |
Enumerar los pasos de ejecución
Recupere una lista de los pasos de ejecución de un subproceso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Identificador de subproceso
|
thread_id | True | string |
Identificador del subproceso. |
|
Id. de ejecución
|
run_id | True | string |
El identificador de ejecución. |
|
Limit
|
limit | integer |
El límite. |
|
|
Pedido
|
order | string |
Orden. |
|
|
Después
|
after | string |
El después. |
|
|
Antes
|
before | string |
Antes. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Objeto
|
object | string |
Objeto . |
|
Data
|
data | array of object | |
|
identificación
|
data.id | string |
Identificador. |
|
Objeto
|
data.object | string |
Objeto . |
|
Creado en
|
data.created_at | integer |
Cuando se crea en . |
|
Id. de ejecución
|
data.run_id | string |
El identificador de ejecución. |
|
Id. del asistente
|
data.assistant_id | string |
Identificador del asistente. |
|
Identificador de subproceso
|
data.thread_id | string |
Identificador del subproceso. |
|
Tipo
|
data.type | string |
Tipo de herramientas. |
|
Estado
|
data.status | string |
Estado. |
|
Cancelada en
|
data.cancelled_at | string |
Cuando se cancela en. |
|
Completado en
|
data.completed_at | integer |
Cuando se complete en. |
|
Expirado en
|
data.expired_at | string |
Cuando ha expirado. |
|
Error en
|
data.failed_at | string |
Cuando se produce un error. |
|
Último error
|
data.last_error | string |
Último error. |
|
Tipo
|
data.step_details.type | string |
Tipo. |
|
Id. de mensaje
|
data.step_details.message_creation.message_id | string |
Identificador del mensaje. |
|
Primer identificador
|
first_id | string |
Primer identificador. |
|
Último identificador
|
last_id | string |
Último identificador. |
|
Tiene más
|
has_more | boolean |
Si tiene más. |
Enumerar mensajes
Recupere una lista de mensajes para un subproceso determinado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Identificador de subproceso
|
thread_id | True | string |
Identificador del subproceso. |
|
Limit
|
limit | integer |
El límite. |
|
|
Pedido
|
order | string |
Orden. |
|
|
Después
|
after | string |
El después. |
|
|
Antes
|
before | string |
Antes. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Objeto
|
object | string |
Objeto . |
|
Data
|
data | array of object | |
|
identificación
|
data.id | string |
Identificador. |
|
Objeto
|
data.object | string |
Objeto . |
|
Creado en
|
data.created_at | integer |
Cuando se crea en . |
|
Identificador de subproceso
|
data.thread_id | string |
Identificador del subproceso. |
|
Rol
|
data.role | string |
Rol. |
|
Content
|
data.content | array of object | |
|
Tipo
|
data.content.type | string |
Tipo. |
|
Importancia
|
data.content.text.value | string |
Valor. |
|
Annotations
|
data.content.text.annotations | array of string |
Las anotaciones. |
|
Identificadores de archivo
|
data.file_ids | array of string |
Identificadores de archivo. |
|
Id. del asistente
|
data.assistant_id | string |
Identificador del asistente. |
|
Id. de ejecución
|
data.run_id | string |
El identificador de ejecución. |
|
Primer identificador
|
first_id | string |
Primer identificador. |
|
Último identificador
|
last_id | string |
Último identificador. |
|
Tiene más
|
has_more | boolean |
Si tiene más. |
Envío de salidas de herramientas para ejecutar
Cuando una ejecución tiene el estado "requires_action" y required_action.type es submit_tool_outputs, esta acción se puede usar para enviar las salidas de las llamadas a la herramienta una vez completadas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Identificador de subproceso
|
thread_id | True | string |
Identificador del subproceso. |
|
Id. de ejecución
|
run_id | True | string |
El identificador de ejecución. |
|
Id. de llamada de herramienta
|
tool_call_id | string |
Identificador de llamada de peaje. |
|
|
Salida
|
output | string |
Salida. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
|
Id. del asistente
|
assistant_id | string |
Identificador del asistente. |
|
Identificador de subproceso
|
thread_id | string |
Identificador del subproceso. |
|
Estado
|
status | string |
Estado. |
|
Iniciado en
|
started_at | integer |
Cuando se inicia en. |
|
Expira a las
|
expires_at | integer |
Cuando expira. |
|
Cancelada en
|
cancelled_at | string |
Cuando se cancela en. |
|
Error en
|
failed_at | string |
Cuando se produce un error. |
|
Completado en
|
completed_at | string |
Cuando se complete en. |
|
Último error
|
last_error | string |
Último error. |
|
Modelo
|
model | string |
Modelo. |
|
Instrucciones
|
instructions | string |
Las instrucciones. |
|
Tools
|
tools | array of object | |
|
Tipo
|
tools.type | string |
Tipo de herramientas. |
|
Nombre
|
tools.function.name | string |
Nombre. |
|
Description
|
tools.function.description | string |
Descripción. |
|
Tipo
|
tools.function.parameters.type | string |
Tipo. |
|
Identificadores de archivo
|
file_ids | array of string |
Identificadores de archivo. |
Modificar ejecución
Modifica una ejecución para un subproceso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Identificador de subproceso
|
thread_id | True | string |
Identificador del subproceso. |
|
Id. de ejecución
|
run_id | True | string |
El identificador de ejecución. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
|
Id. del asistente
|
assistant_id | string |
Identificador del asistente. |
|
Identificador de subproceso
|
thread_id | string |
Identificador del subproceso. |
|
Estado
|
status | string |
Estado. |
|
Iniciado en
|
started_at | integer |
Cuando se inicia en. |
|
Expira a las
|
expires_at | string |
Cuando expira. |
|
Cancelada en
|
cancelled_at | string |
Cuando se cancela en. |
|
Error en
|
failed_at | string |
Cuando se produce un error. |
|
Completado en
|
completed_at | integer |
Cuando se complete en. |
|
Último error
|
last_error | string |
Último error. |
|
Modelo
|
model | string |
Modelo. |
|
Instrucciones
|
instructions | string |
Las instrucciones. |
|
Tools
|
tools | array of object | |
|
Tipo
|
tools.type | string |
Tipo de herramientas. |
|
Identificadores de archivo
|
file_ids | array of string |
Identificadores de archivo. |
Modificar mensaje
Modifica un mensaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Identificador de subproceso
|
thread_id | True | string |
Identificador del subproceso. |
|
Id. de mensaje
|
message_id | True | string |
Identificador del mensaje. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
|
Identificador de subproceso
|
thread_id | string |
Identificador del subproceso. |
|
Rol
|
role | string |
Rol. |
|
Content
|
content | array of object | |
|
Tipo
|
content.type | string |
Tipo de herramientas. |
|
Importancia
|
content.text.value | string |
Valor. |
|
Annotations
|
content.text.annotations | array of string |
Las anotaciones. |
|
Identificadores de archivo
|
file_ids | array of string |
Identificadores de archivo. |
|
Id. del asistente
|
assistant_id | string |
Identificador del asistente. |
|
Id. de ejecución
|
run_id | string |
El identificador de ejecución. |
Modificar un subproceso
Modifica un subproceso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Identificador de subproceso
|
thread_id | True | string |
Identificador del subproceso. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
Obtener archivos del asistente
Recupera una lista de archivos de asistente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Id. del asistente
|
assistant_id | True | string |
Identificador del asistente. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Objeto
|
object | string |
Objeto . |
|
Data
|
data | array of object | |
|
identificación
|
data.id | string |
Identificador. |
|
Objeto
|
data.object | string |
Objeto . |
|
Creado en
|
data.created_at | integer |
Cuando se crea en . |
|
Id. del asistente
|
data.assistant_id | string |
Identificador del asistente. |
|
Primer identificador
|
first_id | string |
Primer identificador. |
|
Último identificador
|
last_id | string |
Último identificador. |
|
Tiene más
|
has_more | boolean |
Si tiene más. |
Obtener conversación
Recuperar un subproceso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Identificador de subproceso
|
thread_id | True | string |
Identificador del subproceso. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
Obtener ejecución
Recuperar una ejecución de un subproceso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Identificador de subproceso
|
thread_id | True | string |
Identificador del subproceso. |
|
Id. de ejecución
|
run_id | True | string |
El identificador de ejecución. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
|
Id. del asistente
|
assistant_id | string |
Identificador del asistente. |
|
Identificador de subproceso
|
thread_id | string |
Identificador del subproceso. |
|
Estado
|
status | string |
Estado. |
|
Iniciado en
|
started_at | integer |
Cuando se inicia en. |
|
Expira a las
|
expires_at | string |
Cuando expira. |
|
Cancelada en
|
cancelled_at | string |
Cuando se cancela en. |
|
Error en
|
failed_at | string |
Cuando se produce un error. |
|
Completado en
|
completed_at | integer |
Cuando se complete en. |
|
Último error
|
last_error | string |
Último error. |
|
Modelo
|
model | string |
Modelo. |
|
Instrucciones
|
instructions | string |
Las instrucciones. |
|
Tools
|
tools | array of object | |
|
Tipo
|
tools.type | string |
Tipo de herramientas. |
|
Identificadores de archivo
|
file_ids | array of string |
Identificadores de archivo. |
Obtener paso de ejecución
Recuperar un paso de ejecución para un subproceso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Identificador de subproceso
|
thread_id | True | string |
Identificador del subproceso. |
|
Id. de ejecución
|
run_id | True | string |
El identificador de ejecución. |
|
Id. de paso
|
step_id | True | string |
Identificador del paso. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
|
Id. de ejecución
|
run_id | string |
El identificador de ejecución. |
|
Id. del asistente
|
assistant_id | string |
Identificador del asistente. |
|
Identificador de subproceso
|
thread_id | string |
Identificador del subproceso. |
|
Tipo
|
type | string |
Tipo. |
|
Estado
|
status | string |
Estado. |
|
Cancelada en
|
cancelled_at | string |
Cuando se cancela en. |
|
Completado en
|
completed_at | integer |
Cuando se complete en. |
|
Expirado en
|
expired_at | string |
Cuando ha expirado. |
|
Error en
|
failed_at | string |
Cuando se produce un error. |
|
Último error
|
last_error | string |
Último error. |
|
Tipo
|
step_details.type | string |
Tipo. |
|
Id. de mensaje
|
step_details.message_creation.message_id | string |
Identificador del mensaje. |
Recuperación del archivo de mensaje
Recupera un archivo de mensaje de un subproceso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Identificador de subproceso
|
thread_id | True | string |
Identificador del subproceso. |
|
Id. de mensaje
|
message_id | True | string |
Identificador del mensaje. |
|
Id. de archivo
|
file_id | True | string |
Identificador de archivo. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
|
Id. de mensaje
|
message_id | string |
Identificador del mensaje. |
Recuperación del archivo del asistente
Recupera un archivo de asistente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Id. del asistente
|
assistant_id | True | string |
Identificador del asistente. |
|
Id. de archivo
|
file_id | True | string |
Identificador de archivo. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
|
Id. del asistente
|
assistant_id | string |
Identificador del asistente. |
Recuperar asistente
Recupera información sobre un asistente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Encabezado beta
|
OpenAI-Beta | True | string |
Encabezado beta. Es necesario establecer mientras la API está en versión beta. |
|
Id. del asistente
|
assistant_id | True | string |
Identificador del asistente. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
Objeto
|
object | string |
Objeto . |
|
Creado en
|
created_at | integer |
Cuando se crea en . |
|
Nombre
|
name | string |
Nombre. |
|
Description
|
description | string |
Descripción. |
|
Modelo
|
model | string |
Modelo. |
|
Instrucciones
|
instructions | string |
Las instrucciones. |
|
Tools
|
tools | array of object | |
|
Tipo
|
tools.type | string |
Tipo de herramientas. |
|
Identificadores de archivo
|
file_ids | array of string |
Identificadores de archivo. |