Ask Eddy AI API

La API Pública de Eddy AI es una función invaluable diseñada para mejorar la funcionalidad y flexibilidad de nuestra función de búsqueda de Eddy AI. La API pública de Eddy AI es especialmente útil para empresas que buscan integrar de forma profunda capacidades de búsqueda impulsadas por IA directamente en sus propias plataformas o servicios. Al integrar Eddy AI en tu producto, ofreces a los usuarios la capacidad de acceder a potentes funcionalidades de búsqueda sin necesidad de visitar tu página de documentación.

Esta API ofrece mayor flexibilidad para personalizar la interfaz de usuario, permitiéndote adaptar aspectos como el color, el nombre y la ubicación para alinearlos con tu marca y experiencia de usuario. Con esta integración fluida, Eddy AI se convierte en una extensión natural de tu producto, mejorando las interacciones con los usuarios y mejorando la eficiencia en las búsquedas. Al exponer los endpoints de la API, puedes incorporarlos a tus plataformas, extraer respuestas de Eddy AI sin esfuerzo y crear una experiencia de búsqueda personalizada.

NOTA

Para saber más sobre los idiomas soportados por Eddy AI, haz clic aquí.

Uso de la API pública

1. Navega a Configuración () en la barra de navegación izquierda del Portal de la base de conocimientos.

2. En el panel de navegación izquierdo, navega a Características de la IA > Eddy AI.

3. Amplía el acordeón de la suite de búsqueda de IA .

4. En la sección de búsqueda asistida por IA , selecciona la casilla de verificación de la API Pública .

NOTA

1. Asegúrate de que al menos una de las casillas esté marcada. De lo contrario, el interruptor de búsqueda asistida por IA se desactivará automáticamente.

2. Si la API pública no está habilitada, recibirás un 'error de código de respuesta 500' o un 'error de acceso deshabilitado a la API 400' al usar la API de Ask Eddy AI.

3. Cada llamada a la API reducirá tu total de créditos en uno.

3. Crear token de API de autorización.

NOTA

1. En el portal de la Base de Conocimiento, navega a Configuración () en la barra de navegación izquierda.

2. En el panel de navegación izquierdo, navega al Portal de la Base de Conocimiento > Tokens de API.

3. Haz clic en Crear Token API, introduce el nombre del token y especifica el método POST.

4. Haz clic en Crear y copia el token de API generado.

4. Puedes encontrar la estructura de la API en el API hub.

Prueba la API pública de Eddy AI en nuestra documentación de API

1. Accede a la documentación de la API de Document360.

2. En el lado derecho de la página, haz clic en la sección Pruébalo .

3. En el campo Token , introduce el token de API generado por tu proyecto Document360.

4. Introduce los valores deseados en la sección Cuerpo . El cuadro de solicitud por defecto aparecerá de la siguiente manera:

   1. Prompt: Introduce la pregunta o consulta.

   2. ID de versión: Obtener el ID de versión actual.

   3. Código de lenguaje: Especifica el código de idioma deseado para la entrada.

5. Haz clic en Pruébalo y ve la respuesta y la respuesta se generará.

Prueba la API pública de Eddy AI en Swagger

1. Accede al hub de la API de Swagger. En las versiones de proyecto, puedes encontrar la API de IA de Ask Eddy.

2. En la esquina superior derecha del hub de la API de Swagger y haz clic en Autorizar.

3. Aparecerá el panel de Autorizaciones Disponibles , que te indicará que introduzcas el token de la API.

4. Pega el token de la API en el panel de Autorizaciones Disponibles y haz clic en Autorizar.

5. Una vez autorizado, navega a versiones > /v2/ProjectVersions/ask-Eddy AI del proyecto y haz clic en Pruébalo.

6. El cuadro de solicitud por defecto aparecerá de la siguiente manera:

• Prompt: Introduce la pregunta o consulta.

• ID de versión: Obtener el ID de versión actual del /v2/ProjectVersions endpoint.

  

• Código de idioma: Especifica el código de idioma deseado.

7. Haz clic en Ejecutar para recibir una respuesta exitosa que contiene toda la información requerida.

NOTA

Si recibes un mensaje de servicio no disponible, asegúrate de que la API Pública esté activada en la configuración.

{
  "category_id": "_categoryid",
  "category_title": "Title",
  "category_slug": "slug",
  "version_name": "v1",
  "version_slug": "v1",
  "article_id": null,
  "article_title": null,
  "article_slug": null,
  "version_display_name": null
}