Tabla de contenidos:
1. Introducción
2. Uso de la API de la Base de Conocimientos
3. Cómo funciona la API
4. Configuración de la API
5. Captura de preguntas de usuario
6. Realización de llamadas a la API
7. Análisis de la respuesta de la API
8. Guardado de variables de respuesta de la API
9. Manejo de respuestas no encontradas
10. Formateo del contenido para usuarios
11. Proporcionar el artículo a los usuarios
12. Conclusión
**Uso de la API de la Base de Conocimientos**
En este tutorial, te guiaré sobre cómo utilizar nuestra API de la base de conocimientos para mejorar las funcionalidades de tu sitio web. La API potencia nuestra base de conocimientos y te permite incluir la fuente de la respuesta, proporcionando más contexto a tus usuarios.
**Introducción**
La API de la base de conocimientos de Voice Low es una herramienta poderosa que te permite obtener información de los artículos de tu sitio web. Al integrar esta API en tu proyecto, puedes acceder a información detallada sobre la fuente de la respuesta, haciendo tus respuestas más informativas y confiables.
**Uso de la API de la Base de Conocimientos**
Para utilizar la API de la base de conocimientos, debes utilizar la API de vista previa de la base de conocimientos de Voice Low. Esta API proporciona información más detallada que la propia herramienta de la base de conocimientos. En tu proyecto, puedes agregar artículos a la base de conocimientos y recuperarlos utilizando la API.
**Cómo funciona la API**
Cuando cargas documentos en la base de conocimientos, se dividen en fragmentos más pequeños para un mejor procesamiento. Cuando un usuario hace una pregunta, la API busca en estos fragmentos la información más relevante. Luego envía esta información a tu modelo, ya sea Claude o GPT, para generar una respuesta resumida.
**Configuración de la API**
Para comenzar con la API, debes obtener una clave de API en la sección de integración de tu proyecto. Cada proyecto tiene una clave de API única. Una vez que tengas la clave, puedes usarla en tus llamadas a la API para obtener información de la base de conocimientos.
**Captura de preguntas de usuario**
En tu proyecto, puedes utilizar el paso de captura para capturar la pregunta de un usuario y guardarla como la variable de última intervención. Esta variable se utilizará en la llamada a la API para obtener la información relevante de la base de conocimientos.
**Realización de llamadas a la API**
Para realizar una llamada a la API, debes proporcionar la clave de API y la pregunta del usuario. En el paso de la API de tu proyecto, puedes utilizar la variable de última intervención capturada como entrada de la pregunta. Esto asegura que la API recupere la información basada en la consulta del usuario.
**Análisis de la respuesta de la API**
La respuesta de la API contiene varias piezas de información. El campo de respuesta proporciona la respuesta resumida que mostrarías al usuario. Además, la respuesta incluye los fragmentos de los cuales se derivó la respuesta, junto con las URL correspondientes. Esta información detallada te ayuda a comprender la fuente de la respuesta.
**Guardado de variables de respuesta de la API**
Para almacenar la respuesta de la API, puedes utilizar las funciones de captura de respuesta proporcionadas por Voice Low. Estas funciones te permiten extraer información específica de la respuesta de la API y guardarla en variables. Por ejemplo, puedes guardar el contenido, el nombre de la fuente, el tipo y otros detalles relevantes.
**Manejo de respuestas no encontradas**
En algunos casos, la API puede no encontrar una respuesta adecuada para la pregunta del usuario. En tales situaciones, puedes utilizar un paso lógico para manejar este escenario. Puedes usar un modelo de IA general para proporcionar una respuesta predeterminada o personalizar la respuesta según tus requisitos.
**Formateo del contenido para usuarios**
Cuando se encuentra una respuesta, puedes mejorar la legibilidad del contenido reformateándolo. Este paso asegura que la información se presente de manera amigable para el usuario. Mediante el uso de un paso de configuración, puedes generar un nombre de artículo basado en la URL y proporcionar una experiencia más atractiva para tus usuarios.
**Proporcionar el artículo a los usuarios**
Si la puntuación de confianza de la respuesta está por encima de un umbral determinado, puedes proporcionar al usuario el artículo completo. Esto se puede hacer utilizando un paso de tarjeta, que incluye un enlace al artículo, una breve descripción y un botón de "leer más". Esto permite a los usuarios acceder a la información completa del artículo fuente.
**Conclusión**
En este tutorial, exploramos cómo utilizar la API de la base de conocimientos de Voice Low para mejorar las funcionalidades de tu sitio web. Al aprovechar la API, puedes proporcionar respuestas más detalladas y ricas en contexto a tus usuarios. Si tienes más preguntas o necesitas ayuda, no dudes en unirte a nuestro Discord o contactar a nuestro chat de soporte.
Aspectos destacados:
- Utiliza la API de la base de conocimientos de Voice Low para mejorar las funcionalidades de tu sitio web.
- Recupera información detallada sobre la fuente de la respuesta.
- Captura preguntas de usuario y realiza llamadas a la API para obtener información relevante.
- Analiza la respuesta de la API para comprender la fuente de la respuesta.
- Personaliza la respuesta cuando no se encuentra una respuesta.
- Formatea el contenido para una mejor legibilidad.
- Proporciona el artículo completo a los usuarios para una comprensión integral.
Preguntas frecuentes:
P: ¿Cómo puedo obtener una clave de API para la API de la base de conocimientos?
R: Puedes encontrar la clave de API en la sección de integración de tu proyecto. Cada proyecto tiene una clave de API única.
P: ¿Qué sucede si la API no encuentra una respuesta para la pregunta de un usuario?
R: En esos casos, puedes utilizar un modelo de IA general para proporcionar una respuesta predeterminada o personalizar la respuesta según tus requisitos.
P: ¿Puedo proporcionar el artículo completo a los usuarios?
R: Sí, si la puntuación de confianza de la respuesta está por encima de un umbral determinado, puedes proporcionar al usuario el artículo completo utilizando un paso de tarjeta.
P: ¿Cómo puedo formatear el contenido para una mejor legibilidad?
R: Puedes utilizar un paso de configuración para generar un nombre de artículo basado en la URL y proporcionar una experiencia más atractiva para tus usuarios.
P: ¿Dónde puedo obtener más asistencia o soporte?
R: Puedes unirte a nuestra comunidad de Discord o contactar a nuestro chat de soporte, que está impulsado por Voice Low.
Recursos:
- [Chatbot de IA de Voice Low](https://www.voc.ai/product/ai-chatbot)
