{"info":{"_postman_id":"f9254881-7194-49cb-a2ad-a83778439f05","name":"Dattabot Public API","description":"

API de consulta a los chatbots de Dattabot. Se necesitará una API Key que se puede encontrar en el panel de edición del ChatBOT seleccionado que deberá incluirse en la cabecera de la llamada \"X-API-KEY\".

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"18835941","collectionId":"f9254881-7194-49cb-a2ad-a83778439f05","publishedId":"2sAXqs72TT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-09-19T11:39:25.000Z"},"item":[{"name":"RetrieveResults","id":"37855107-1cc5-417a-b219-66fddf0b3f92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://app.dattabot.es/api/dattabotretrieve?prompt=Para qué sirver Dattabot","description":"

Devuelve los resultados de la base de conocimiento del Chatbot relacionados con el prompt introducido.

Parámetros:

prompt: (requerido) Cadena de texto con la consulta del usuario.

Respuesta:

status_code: 200 si la llamada es exitosa o 400 si se ha producido un error.
\n
message: \"OK\" si la llamada ha sido exitosa o la descripción del error en caso contrario.
\n
data: En caso de llamada exitosa, se incluye un array con los campos de la respuesta.
\n
- chatbot: Nombre del BOT que se ha consultado.
  \n
- query: La consulta que se ha realizado al BOT (el prompt de la llamada pero contextualizado con los datos del BOT).
  \n
- results: Array que incluye los resultados obtenidos al consultar la base de conocimiento.
  \n
  - text: Contenido obtenido.
    \n
  - score: Puntuación de cercanía del resultado (Valores cercanos al 1 se consideran mejores).
    \n
  \n
\n

\n","urlObject":{"protocol":"https","path":["api","dattabotretrieve"],"host":["app","dattabot","es"],"query":[{"key":"prompt","value":"Para qué sirver Dattabot"}],"variable":[]}},"response":[],"_postman_id":"37855107-1cc5-417a-b219-66fddf0b3f92"},{"name":"Chat","id":"693b6f58-ff88-43f6-99ab-73494fc5f254","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"prompt\": \"Hola!\",\n \"system\": \"Este system prompt sobreescribirá al system prompt del chatbot en caso\",\n \"temperature\": 0.5,\n \"conv\": \"\",\n \"username\": \"Dattabot test\",\n \"style\": \"html\",\n \"results\": \"n\",\n \"historic\": \"n\"\n}","options":{"raw":{"language":"text"}}},"url":"https://app.dattabot.es/api/dattabotchat","description":"

Devuelve la respuesta del chatbot a una determinada consulta (prompt).

Parámetros:

prompt: (requerido) Cadena de texto con la consulta del usuario.
\n
system: (opcional) Cadena de texto con el prompt del sistema, el que define el comportamiento del BOT. En caso de estar presente sobreescribirá el valor definido en la configuración del BOT.
\n
temperature: (opcional) Valor entre 0 y 2 que define la creatividad de la respuesta (0 determinista, 2 respuesta más creativa). De estar presente sobreescribirá al valor definido en la configuración del BOT.
\n
conv: (opcional) Con cada llamada la API devuelve el código de la conversación. Si se desea que el BOT sea conversacional (recuerde los mensajes y respuestas anteriores) se debe incluir en este parámetro el código devuelto durante la primera interacción. Si solo se van a realizar consultas independientes, se omite este campo (cada llamda a la API crea una conversación nueva).
\n
username: (opcional) Nombre o nick del usuario que intereactúa con el BOT.
\n
style: (opcional) Formato de la respuesta \"markdown\", \"html\" o \"plain\" (por defecto \"html\").
\n
results: (opcional) Si el valor es \"s\" se incluirá en la respuesta si procede el array con los resultados de la base de conocimiento que se han incorporado al prompt para generar la respuesta (por defecto \"n\").
\n
historic: (opcional) Si el valor es \"s\" se incluirá en la respuesta el array del histórico de conversaciones anteriores (por defecto \"n\").
\n

Respuesta:

status_code: 200 si la llamada es exitosa o 400 si se ha producido un error.
\n
message: \"OK\" si la llamada ha sido exitosa o la descripción del error en caso contrario.
\n
data: En caso de llamada exitosa, se incluye un array con los campos de la respuesta.
\n
- chatbot: Nombre del BOT que se ha consultado.
  \n
- query: La consulta que se ha realizado al BOT (el prompt de la llamada pero contextualizado con los datos del BOT y los mensajes anteriores de la conversación).
  \n
- msg: Respuesta del BOT en el formato que se haya solicitado (html o markdown).
  \n
- modelo: Modelo que se hausado para generar la respuesta.
  \n
- time: Tiempo de ejecución.
  \n
- historic: Array con el histórico de mensajes de la conversación (si procede) en orden cronológico ascendente.
  \n
  - role: De quién es el mensaje (\"assistant\" o \"user\")
    \n
  - content: Contenido del mensaje.
    \n
  \n
- funcionllamada: En caso de que se lleve a cabo una llamada a una función del BOT, se reflejará en este campo
  \n
- conv: ID único de la conversación actual. Cada llamada genera un ID diferente si no se especifica un ID de conversación usando el parámetro \"conv\" del endpoint.
  \n
- temperature: valor utilizado para el parámetro temperatura (entre 0 y 2).
  \n
- results: Array que incluye los resultados obtenidos al consultar la base de conocimiento y que han sido tenidos en cuenta para generar la respuesta.
  \n
  - text: Contenido obtenido.
    \n
  - score: Puntuación de cercanía del resultado (Valores cercanos al 1 se consideran mejores).
    \n
  \n
\n

\n","urlObject":{"protocol":"https","path":["api","dattabotchat"],"host":["app","dattabot","es"],"query":[],"variable":[]}},"response":[],"_postman_id":"693b6f58-ff88-43f6-99ab-73494fc5f254"},{"name":"UploadFile","id":"532a5f60-9bb2-46dc-ac6c-393102abbeb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"file\":\"https://app.dattabot.es/Robots.txt\",\n \"titulo\":\"Documento de ejemplo\",\n \"fuente\":\"Cliente\",\n \"imagen\":\"https://www.dattabot.es/wp-content/uploads/2023/10/versiones.jpg\",\n \"enlace\":\"https://www.dattabot.es\",\n \"idcontenido\": \"452980\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.dattabot.es/api/dattabotuploadfile","description":"

Sube a la base de conocimiento del chatbot el contenido de un archivo proporcionado (tipo admitidos txt, pdf, doc, docx, html).

Parámetros:

file: URL donde está alojado el archivo a subir a la base de conocimiento.
\n
titulo: Título que aparecerá en el listado para identificar el archivo (opcional, por defecto se tomará el nombre del archivo).
\n
fuente: Fuente del archivo (opcional).
\n
imagen: URL de la imagen asociada a este contenido (opcional)
\n
enlace: URL asociada a este contenido que aparecerá como enlace para ampliar la información (opcional).
\n
idcontenido: en caso de ser una edición de un contenido preexistente, se incluye este campo (opcional, por defecto idcontenido vacío, se crea un contenido nuevo).
\n

Respuesta:

status_code: 200 si la llamada es exitosa o 400 si se ha producido un error.
\n
message: \"OK\" si la llamada ha sido exitosa o la descripción del error en caso contrario.
\n
data: En caso de llamada exitosa, se incluye un array con los campos de la respuesta.
\n
- idcontenido: ID del contenido que se ha creado (o actualizado si ha enviado el parámetro idcontenido).
  \n
- titulo: Título asignado al contenido.
  \n
- contenido: Contenido extraido del archivo.
  \n
- fuente: Fuente asignada al contenido.
  \n
- grupo: Grupo asignado al contenido (API)
  \n
- url_contenido_relacionado: Enlace en caso de haber rellenado el parámetro \"enlace\".
  \n
- url_imagen_relacionada: Imagen en caso de haber rellenado el parámetro \"imagen\"
  \n
\n

\n","urlObject":{"protocol":"https","path":["api","dattabotuploadfile"],"host":["app","dattabot","es"],"query":[],"variable":[]}},"response":[],"_postman_id":"532a5f60-9bb2-46dc-ac6c-393102abbeb2"},{"name":"AddFileToChat","id":"ee41774a-3932-4844-8d67-4d3c44124bbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"prompt\":\"Prompt que pone en contexto el archivo\",\n \"file\":\"https://app.dattabot.es/Robots.txt\",\n \"conv\": null,\n \"historic\": \"n\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.dattabot.es/api/dattabotaddfiletochat/","description":"

Extrae el contenido de un archivo facilitado mediante URL (pdf, txt, html, doc, docx, png, jpg). Si se especifica ID conversación, lo añade al contexto de dicha conversación. Si no se especifica, crea una conversación nueva.

Parámetros:

file: URL donde está alojado el archivo que se va a transcribir.
\n
prompt: Pone en contexto dentro de la conversación el contenido del archivo. Ej. \"Esta es mi redacción\", \"Esta es la factura\", \"Mi examen de literatura\" (opcional).
\n
conv: ID de la conversación a la que se le añadirá el contenido del archivo (opcional, si no aparece conv se creará una nueva conversación).
\n
historic: si se marca como \"s\" se devolverá el histórico de mensajes de la conversación (opcional, por defecto \"n\").
\n

Respuesta:

status_code: 200 si la llamada es exitosa o 400 si se ha producido un error.
\n
message: \"OK\" si la llamada ha sido exitosa o la descripción del error en caso contrario.
\n
data: En caso de llamada exitosa, se incluye un array con los campos de la respuesta.
\n
- chatbot: Nombre del chatbot.
  \n
- prompt: en caso de haberlo especificado, el prompt que pone en contexto el contenido del archivo.
  \n
- file: URL del archivo que se ha facilitado en la llamada.
  \n
- contenido: Contenido extraido del archivo.
  \n
- conv: ID de la conversación a la que se ha añadido el contenido (si no se ha especificado \"conv\" en la llamada, devolverá el ID de la nueva conversación creada).
  \n
- historic: Array con el histórico de mensajes de la conversación (si procede) en orden cronológico ascendente.
  \n
  - role: De quién es el mensaje (\"assistant\" o \"user\")
    \n
  - content: Contenido del mensaje.
    \n
  \n
\n

\n","urlObject":{"protocol":"https","path":["api","dattabotaddfiletochat",""],"host":["app","dattabot","es"],"query":[],"variable":[]}},"response":[],"_postman_id":"ee41774a-3932-4844-8d67-4d3c44124bbb"}]}