API de IA Ask Eddy

El API público 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 particularmente útil para las empresas que buscan integrar profundamente las capacidades de búsqueda impulsadas por IA directamente en sus propias plataformas o servicios. Al integrar Eddy AI en su producto, proporciona a los usuarios la capacidad de acceder a una potente funcionalidad de búsqueda sin necesidad de visitar su sitio de documentación.

Esta API ofrece una mayor flexibilidad para personalizar la interfaz de usuario, lo que le permite adaptar aspectos como el color, el nombre y la ubicación para alinearse con su marca y experiencia de usuario. Con esta integración perfecta, Eddy AI se convierte en una extensión natural de su producto, mejorando las interacciones de los usuarios y mejorando la eficiencia de la búsqueda. Al exponer los puntos finales de la API, puede incorporarlos a sus plataformas, extraer sin esfuerzo respuestas de Eddy AI y crear una experiencia de búsqueda personalizada.

NOTA

Para saber más sobre los lenguajes compatibles con Eddy AI, click here.

Uso de la API pública

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

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

3. Expanda el acordeón de la suite de búsqueda de IA .

4. En la sección Búsqueda asistida de IA , seleccione la casilla de verificación API pública .

NOTA

1. Asegúrese de que al menos una de las casillas de verificación esté seleccionada. De lo contrario, la opción de búsqueda asistida de IA se desactivará automáticamente.

2. Si la API pública no está habilitada, recibirá un "error de código de respuesta 500" o un "error de acceso deshabilitado a la API 400" mientras usa la API de IA de Ask Eddy.

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

3. Cree un token de API de autorización.

NOTA

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

2. En el panel de navegación izquierdo, vaya a Portal de Knowledge Base > Tokens de API.

3. Haga clic en Crear token de API, introduzca el nombre del token y especifique el método POST.

4. Haga clic en Crear y copie el token de API generado.

4. Puede encontrar la estructura de la API en la API hub.

Pruebe la API pública de Eddy AI en nuestros documentos de API

1. Vaya a la API documentationde Document360 .

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

3. En el campo Token , introduzca el token de API generado a partir del proyecto de Document360.

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

   1. Preguntar: Introduzca la pregunta o consulta.

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

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

5. Haga clic en Pruébelo y vea la respuesta y se generará la respuesta.

Pruebe la API pública de Eddy AI en Swagger

1. Vaya a la API hubSwagger . En las versiones del proyecto, puede encontrar la API de IA de Ask Eddy.

2. En la parte superior derecha del centro de API de Swagger y haga clic en Autorizar.

3. Aparecerá el panel Autorizaciones disponibles , que le pedirá que ingrese el token de API.

4. Pegue el token de API en el panel Autorizaciones disponibles y haga clic en Autorizar.

5. Una vez autorizado, vaya a Versiones de Project > /v2/ProjectVersions/ask-Eddy AI y haga clic en Probar.

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

• Preguntar: Introduzca la pregunta o consulta.

• ID de versión: obtenga el ID de versión actual del punto de /v2/ProjectVersions conexión.

  

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

7. Haga clic en Ejecutar para recibir una respuesta correcta que contenga toda la información necesaria.

NOTA

Si recibe un mensaje de servicio no disponible, asegúrese de que la API pública esté habilitada 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
}