La API de Lince

Todo lo que hace la consola se puede hacer por HTTP: crear agentes, entrenarlos y, sobre todo, conversar con ellos desde tu web o tu aplicación. Todas las rutas reciben y devuelven JSON.

Conversación

Hablar con un agente: lo que usan el widget, tu web o tu aplicación. Si el agente tiene clave de API, envíala en la cabecera X-Api-Key.

• POST /api/agents/{agent_id}/detect · Conversar (enviar un mensaje)
• POST /api/agents/{agent_id}/sessions/{session_id}/reset · Empezar la conversación de cero
• GET /api/agents/{agent_id}/public · Datos públicos del agente

Agentes

Crear, leer, importar, exportar, duplicar y borrar agentes.

• GET /api/agents · Listar agentes
• POST /api/agents · Crear un agente
• POST /api/agents/import · Importar un agente
• GET /api/agents/{agent_id} · Leer un agente
• PATCH /api/agents/{agent_id} · Cambiar nombre, idioma o ajustes
• DELETE /api/agents/{agent_id} · Borrar un agente
• GET /api/agents/{agent_id}/export · Exportar a JSON
• POST /api/agents/{agent_id}/duplicate · Duplicar un agente

Intenciones

Lo que quiere el usuario: frases de entrenamiento, parámetros y respuestas.

• POST /api/agents/{agent_id}/intents · Crear una intención
• PUT /api/agents/{agent_id}/intents/{intent_id} · Guardar una intención
• DELETE /api/agents/{agent_id}/intents/{intent_id} · Borrar una intención
• POST /api/agents/{agent_id}/intents/{intent_id}/phrases · Añadir una frase de entrenamiento

Entidades

Tipos de dato que se reconocen dentro de las frases, con sus valores y sinónimos.

• POST /api/agents/{agent_id}/entities · Crear una entidad
• PUT /api/agents/{agent_id}/entities/{entity_id} · Guardar una entidad
• DELETE /api/agents/{agent_id}/entities/{entity_id} · Borrar una entidad
• POST /api/agents/{agent_id}/entities/{entity_id}/synonyms · Añadir un sinónimo

Nlu

Cómo entiende el motor una frase, sin crear conversación ni guardar nada.

• POST /api/agents/{agent_id}/annotate · Anotar entidades automáticamente
• POST /api/agents/{agent_id}/analyze · Analizar una frase

Entrenamiento

El modelo por dentro, el examen y la revisión de los mensajes reales.

• POST /api/agents/{agent_id}/train · Reentrenar el modelo
• GET /api/agents/{agent_id}/model · Lo que ha aprendido el modelo
• POST /api/agents/{agent_id}/explain · Explicar una frase paso a paso
• POST /api/agents/{agent_id}/evaluate · Examen (validación cruzada)
• GET /api/agents/{agent_id}/status · Estado del modelo
• GET /api/agents/{agent_id}/validate · Avisos de calidad
• GET /api/agents/{agent_id}/logs · Mensajes para revisar
• POST /api/agents/{agent_id}/logs/{log_id}/review · Revisar un mensaje
• POST /api/agents/{agent_id}/logs/clear · Vaciar el registro de mensajes

Historial

Conversaciones guardadas y estadísticas de uso.

• GET /api/agents/{agent_id}/conversations · Listar conversaciones
• GET /api/agents/{agent_id}/conversations/{session_id} · Leer una conversación
• GET /api/agents/{agent_id}/stats · Estadísticas de uso

Compatibilidad Dialogflow

La misma petición y la misma respuesta que detectIntent de la API v2 de Dialogflow ES: tu aplicación puede apuntar aquí sin cambios.

• POST /v2/projects/{agent_id}/agent/sessions/{session_id}:detectIntent · detectIntent (Dialogflow ES v2)

General

Información del servidor.

• GET /api/info · Información del servidor
• GET /api/auth-check · Comprobar el token de administración
• GET /api/system-entities · Entidades del sistema

Ml · proyectos

Machine learning: un proyecto tiene unos datos (una tabla o imágenes), sus entrenamientos y sus modelos.

• GET /api/ml/info · Algoritmos, métricas y ejemplos
• GET /api/ml/projects · Listar proyectos
• POST /api/ml/projects · Crear un proyecto
• GET /api/ml/projects/{pid} · Leer un proyecto
• PATCH /api/ml/projects/{pid} · Cambiar nombre, tipos o clave
• DELETE /api/ml/projects/{pid} · Borrar un proyecto

Ml · datos

Subir la tabla (CSV) o las imágenes de cada clase, verlas y elegir el tipo de cada columna.

• POST /api/ml/projects/{pid}/data · Subir la tabla (CSV)
• GET /api/ml/projects/{pid}/rows · Ver filas de la tabla
• GET /api/ml/projects/{pid}/data.csv · Descargar la tabla
• GET /api/ml/projects/{pid}/images · Ver las imágenes
• POST /api/ml/projects/{pid}/images · Añadir imágenes a una clase
• DELETE /api/ml/projects/{pid}/images/{iid} · Borrar una imagen
• PATCH /api/ml/projects/{pid}/classes/{label} · Renombrar una clase
• DELETE /api/ml/projects/{pid}/classes/{label} · Borrar una clase con sus imágenes
• GET /api/ml/projects/{pid}/images.zip · Descargar las imágenes

Ml · entrenamiento

Lanzar un entrenamiento (automático o personalizado) y seguirlo paso a paso.

• POST /api/ml/projects/{pid}/jobs · Entrenar
• GET /api/ml/projects/{pid}/jobs · Listar entrenamientos
• GET /api/ml/projects/{pid}/jobs/{jid} · Cómo va un entrenamiento
• DELETE /api/ml/projects/{pid}/jobs/{jid} · Borrar un entrenamiento y sus modelos
• POST /api/ml/projects/{pid}/jobs/{jid}/cancel · Cancelar un entrenamiento

Ml · modelos

Los modelos entrenados: cómo han salido, qué han aprendido, su script y predicciones.

• GET /api/ml/projects/{pid}/models · Listar modelos
• GET /api/ml/projects/{pid}/models/{mid} · Leer un modelo
• DELETE /api/ml/projects/{pid}/models/{mid} · Borrar un modelo
• POST /api/ml/projects/{pid}/models/{mid}/predict · Predecir con un modelo
• POST /api/ml/projects/{pid}/models/{mid}/batch · Predecir un CSV entero (por lotes)
• GET /api/ml/projects/{pid}/models/{mid}/code · Script equivalente en Python
• POST /api/ml/projects/{pid}/publish · Publicar un modelo

Ml · predicción

El modelo publicado de un proyecto, desde tu web o tu aplicación (como un punto de conexión de Azure). Si el proyecto tiene clave de API, envíala en X-Api-Key.

• POST /api/ml/{ref}/predict · Predecir con el modelo publicado
• POST /api/ml/{ref}/batch · Predecir un CSV entero con el modelo publicado
• GET /api/ml/{ref}/schema · Qué espera el modelo publicado

Cuentas

Cada persona entra con su usuario y su contraseña y ve solo sus agentes. Al entrar se recibe la llave de su espacio, que va en la cabecera X-Space-Key.

• POST /api/accounts · Crear una cuenta
• POST /api/guest · Entrar sin cuenta
• POST /api/login · Entrar
• GET /api/account · Mi cuenta
• POST /api/account/password · Cambiar la contraseña

Compartir

Un agente se comparte con un enlace: quien lo abre puede guardar una copia en su cuenta o descargarla para una instalación local.

• GET /api/agents/{agent_id}/share · Ver si se comparte
• POST /api/agents/{agent_id}/share · Compartir un agente
• DELETE /api/agents/{agent_id}/share · Dejar de compartir
• GET /api/shared/{code} · Ver un agente compartido
• GET /api/shared/{code}/download · Descargar un agente compartido
• POST /api/shared/{code}/save · Guardar un agente compartido en mi cuenta

El esquema completo, para Postman, Insomnia o tu código, está en /openapi.json.