Resumen de métodos de API

En las tablas siguientes se enumeran los métodos disponibles con las API watsonx Assistant API.

Métodos de tiempo de ejecución

Método	Descripción	Versión	Referencia
Crear una sesión	Crear una sesión nueva. Se utiliza una sesión para enviar la entrada del usuario a un conocimiento y recibir respuestas. También mantiene el estado de la conversación.	v2	cURL nodo Java python
Suprimir sesión	Suprimir una sesión de forma explícita antes de que se agote el tiempo de espera.	v2	cURL nodo Java python
Enviar entrada de usuario al asistente (con estado)	Enviar una entrada de usuario a un asistente y recibir una respuesta, con el estado de la conversación (incluidos los datos de contexto) almacenados por watsonx Assistant durante la sesión.	v2	cURL nodo Java python
Enviar entrada de usuario al asistente (sin estado)	Enviar entrada de usuario al asistente y recibir una respuesta, con estado de conversación (incluyendo datos de contexto) gestionado por la aplicación.	v2	cURL nodo Java python

Métodos de creación

Método	Descripción	Versión	Referencia
Listar espacios de trabajo	Enumera los espacios de trabajo asociados a una instancia de servicio watsonx Assistant.	v1	cURL nodo Java python
Crear espacio de trabajo	Crear un espacio de trabajo en función de objetos de componente. Debe proporcionar componentes de espacio de trabajo que definan el contenido del nuevo espacio de trabajo.	v1	cURL nodo Java python
Obtener información sobre un espacio de trabajo	Obtener información sobre un espacio de trabajo, incluido, si se desea, todo el contenido del espacio de trabajo	v1	cURL nodo Java python
Actualizar espacio de trabajo	Actualizar un espacio de trabajo existente con datos nuevos o modificados. Debe proporcionar objetos componentes que definan el contenido del área de trabajo actualizada.	v1	cURL nodo Java python
Suprimir espacio de trabajo	Suprimir un espacio de trabajo de la instancia de servicio.	v1	cURL nodo Java python
Listar intenciones	Listas las intenciones de un espacio de trabajo.	v1	cURL nodo Java python
Crear intención	Crear una nueva intención.	v1	cURL nodo Java python
Obtener intención	Obtener información sobre una intención, incluido, si se desea, todo el contenido de la intención.	v1	cURL nodo Java python
Actualizar intención	Actualizar una intención existente con datos nuevos o modificados. Debe proporcionar objetos componentes que definan el contenido de la intent actualizada.	v1	cURL nodo Java python
Suprimir intención	Suprimir una intención de un espacio de trabajo.	v1	cURL nodo Java python
Listar ejemplos de entrada de usuario	Listar ejemplos de entrada de usuario para una intención, incluidas, si se desea, menciones a entidades contextuales.	v1	cURL nodo Java python
Crear ejemplo de entrada de usuario	Añadir un nuevo ejemplo de entrada de usuario a una intención.	v1	cURL nodo Java python
Obtener ejemplo de entrada de usuario	Obtener información acerca de un ejemplo de entrada de usuario.	v1	cURL nodo Java python
Actualizar ejemplo de entrada de usuario	Actualizar el texto de un ejemplo de entrada de usuario.	v1	cURL nodo Java python
Suprimir ejemplo de entrada de usuario	Suprimir un nuevo ejemplo de entrada de usuario de una intención.	v1	cURL nodo Java python
Listar contraejemplos	Listar los contraejemplos de un espacio de trabajo. Los contraejemplos son ejemplos que se marcan como entrada irrelevante.	v1	cURL nodo Java python
Crear contraejemplo	Añadir un nuevo contraejemplo a un espacio de trabajo. Los contraejemplos son ejemplos que se marcan como entrada irrelevante.	v1	cURL nodo Java python
Obtener contraejemplo	Obtener información sobre un contraejemplo. Los contraejemplos son ejemplos que se marcan como entrada irrelevante.	v1	cURL nodo Java python
Actualizar contraejemplo	Actualizar el texto de un contraejemplo. Los contraejemplos son ejemplos que se marcan como entrada irrelevante.	v1	cURL nodo Java python
Suprimir contraejemplo	Suprimir un contraejemplo de un espacio de trabajo. Los contraejemplos son ejemplos que se marcan como entrada irrelevante.	v1	cURL nodo Java python
Listar entidades	Listar las entidades de un espacio de trabajo.	v1	cURL nodo Java python
Crear entidad	Crear una nueva entidad o habilitar una entidad del sistema.	v1	cURL nodo Java python
Obtener entidad	Obtener información sobre una entidad, incluido, si se desea, todo el contenido de la entidad.	v1	cURL nodo Java python
Actualizar entidad	Actualizar una entidad existente con datos nuevos o modificados. Debe proporcionar objetos componentes que definan el contenido de la entidad actualizada.	v1	cURL nodo Java python
Suprimir entidad	Suprimir una entidad de un espacio de trabajo o inhabilitar una entidad del sistema.	v1	cURL nodo Java python
Listar menciones de entidad	Listar menciones para una entidad contextual. Una mención de entidad es una aparición de una entidad contextual en el contexto de un ejemplo de entrada de usuario de intención.	v1	cURL nodo Java python
Listar valores de entidad	Listar los valores de una entidad.	v1	cURL nodo Java python
Añadir valor de entidad	Crear un nuevo valor para una entidad.	v1	cURL nodo Java python
Obtener valor de entidad	Obtener información sobre un valor de entidad.	v1	cURL nodo Java python
Actualizar valor de entidad	Actualizar un valor de entidad existente con datos nuevos o modificados. Debe proporcionar objetos componentes que definan el contenido del valor de entidad actualizado.	v1	cURL nodo Java python
Suprimir valor de entidad	Suprimir un valor de una entidad.	v1	cURL nodo Java python
Listar sinónimos de valor de entidad	Liste los sinónimos de un valor de entidad.	v1	cURL nodo Java python
Añadir sinónimo de valor de entidad	Añadir un sinónimo nuevo a un valor de entidad.	v1	cURL nodo Java python
Obtener sinónimo de valor de entidad	Obtener información sobre un sinónimo de un valor de entidad.	v1	cURL nodo Java python
Actualizar sinónimo de valor de entidad	Actualizar un sinónimo de valor de entidad existente con texto nuevo.	v1	cURL nodo Java python
Suprimir sinónimo de valor de entidad	Suprimir un sinónimo de un valor de entidad.	v1	cURL nodo Java python
Listar nodos de diálogo	Listar los nodos de diálogo de un espacio de trabajo.	v1	cURL nodo Java python
Crear nodo de diálogo	Crear un nodo de diálogo nuevo.	v1	cURL nodo Java python
Obtener nodo de diálogo	Obtener información sobre un nodo de diálogo.	v1	cURL nodo Java python
Actualizar nodo de diálogo	Actualizar un nodo de diálogo existente con datos nuevos o modificados.	v1	cURL nodo Java python
Suprimir nodo de diálogo	Suprimir un nodo de diálogo de un espacio de trabajo.	v1	cURL nodo Java python
Listar sucesos de registro de un espacio de trabajo	Listar los sucesos de registro de un espacio de trabajo específico.	v1	cURL nodo Java python
Listar sucesos de registro de todos los espacios de trabajo	Listar los sucesos de los registros de todos los espacios de trabajo de la instancia de servicio.	v1	cURL nodo Java python
Suprimir datos etiquetados	Elimina todos los datos asociados a un ID de cliente especificado. Este método no tiene ningún efecto si el ID de cliente no tiene datos asociados.	v1	cURL nodo Java python