Demandez à l’API Eddy AI

Plans prenant en charge l’utilisation de l’API Ask Eddy AI

Le API public Eddy AI est une fonctionnalité inestimable conçue pour améliorer la fonctionnalité et la flexibilité de notre fonction de recherche Eddy AI. L’API publique d’Eddy AI est particulièrement utile pour les entreprises qui cherchent à intégrer en profondeur les capacités de recherche basées sur l’IA directement dans leurs propres plateformes ou services. En intégrant Eddy AI dans votre produit, vous offrez aux utilisateurs la possibilité d’accéder à de puissantes fonctionnalités de recherche sans avoir à visiter votre site de documentation.

Cette API offre une plus grande flexibilité dans la personnalisation de l’interface utilisateur, ce qui vous permet d’adapter des aspects tels que la couleur, le nom et l’emplacement pour s’aligner sur votre marque et votre expérience utilisateur. Grâce à cette intégration transparente, Eddy AI devient une extension naturelle de votre produit, améliorant les interactions avec les utilisateurs et améliorant l’efficacité de la recherche. En exposant les points de terminaison de l’API, vous pouvez les intégrer à vos plateformes, extraire sans effort les réponses d’Eddy AI et créer une expérience de recherche personnalisée.

NOTE

Outre l’anglais (en-US, en-GB), l’API publique d’Eddy AI prend en charge cinq autres langues telles que

Français (fr)

Espagnol (es)

Allemand (de)

Norvégien (non)

Néerlandais (nl)

Utilisation de l’API publique

1. Accédez aux paramètres () > Fonctionnalités AI > Eddy AI dans le portail de la base de connaissances.

2. Dans la recherche assistée par l’IA, cochez la case API publique .

NOTE

1. Assurez-vous qu’au moins une des cases est cochée. Sinon, la bascule de recherche assistée par l’IA sera automatiquement désactivée.

2. Si l’API publique n’est pas activée, vous recevrez une erreur de code de réponse 500 lors de l’utilisation de l’API Ask Eddy AI.

3. Chaque appel d’API réduira votre nombre total de crédits d’une unité.

3. Créez un jeton d’API d’autorisation.

NOTE

1. Dans le portail de la base de connaissances, accédez à Paramètres () > Portail de la base de connaissances > les jetons d’API.

2. Cliquez sur Créer un jeton d’API, entrez le nom du jeton et spécifiez la méthode POST.

3. Cliquez sur Créer et copiez le jeton d’API généré.

4. Vous pouvez trouver la structure de l’API à l' API hub.

Essayez l’API publique d’Eddy AI dans notre documentation sur l’API

1. Accédez à la API documentationDocument360 .

2. Sur le côté droit de la page, cliquez sur la section Essayer .

3. Dans le champ Token , champ, saisissez le token API généré à partir de votre projet Document360.

4. Entrez les valeurs souhaitées dans la section Corps . La boîte de requête par défaut s’affiche comme suit :

   1. Invite : Entrez la question ou la requête.

   2. ID de version : obtenez l’ID de la version actuelle.

   3. Code de langue : spécifiez le code de langue souhaité pour la saisie.

5. Cliquez sur Essayer et voir la réponse et la réponse sera générée.

Essayez l’API publique d’Eddy AI dans Swagger

1. Accédez à l' API hubSwagger . Sous les versions du projet, vous pouvez trouver l’API Ask Eddy AI.

2. En haut à droite du hub de l’API Swagger, cliquez sur Autoriser.

3. Le panneau Autorisations disponibles s’affiche et vous invite à saisir le jeton d’API.

4. Collez le jeton d’API dans la fenêtre Autorisations disponibles et cliquez sur Autoriser.

5. Une fois l’autorisation obtenue, accédez à la > /v2/ProjectVersions/ask-Eddy AI Versions du projet et cliquez sur Essayer.

6. La boîte de requête par défaut s’affiche comme suit :

• Invite : Entrez la question ou la requête.

• ID de version : obtenez l’ID de version actuelle à partir /v2/ProjectVersions du point de terminaison.

  

• Code de langue : spécifiez le code de langue souhaité.

7. Cliquez sur Exécuter pour recevoir une réponse contenant toutes les informations requises.

NOTE

Si vous recevez un message d’indisponibilité du service, assurez-vous que l’API publique est activée dans les paramètres.

{
  "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
}