Ask Eddy AI API

API publique 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 Eddy AI est particulièrement utile pour les entreprises souhaitant intégrer en profondeur les capacités de recherche pilotées par 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 à des fonctionnalités de recherche puissantes sans avoir à consulter votre site de documentation.

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

NOTE

Pour en savoir plus sur les langages pris en charge par Eddy AI, cliquez ici.

Utilisation de l’API publique

1. Naviguez dans () dans la barre de navigation de gauche du Knowledge base portal.

2. Dans le panneau de navigation de gauche, naviguez vers AI features > Eddy AI.

3. Élargissez la suite de recherche IA accordéon.

4. Dans la section recherche assistée par IA , sélectionnez la case à cocher pour l’API publique .

NOTE

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

2. Si l’API publique n’est pas activée, vous recevrez une « erreur de code de réponse 500 » ou une « erreur d’accès à l’API 400 désactivée » lors de l’utilisation de l’API Ask Eddy AI.

3. Chaque appel API réduira votre total de crédits d’un seuil.

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

NOTE

1. Dans le portail de la Base de connaissances, allez dans Paramètres () dans la barre de navigation de gauche.

2. Dans le panneau de navigation de gauche, naviguez vers le portail de la base de connaissances > jetons API.

3. Cliquez sur Créer un jeton API, saisissez le nom du jeton, et spécifiez la méthode POST.

4. Cliquez sur Créer et copiez le jeton API généré.

4. Vous pouvez trouver la structure de l’API dans le hub API.

Essayez l’API publique Eddy AI dans notre documentation API

1. Accédez à la documentation de l’API Document360.

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

3. Dans le champ Token , entrez le jeton API généré par votre projet Document360.

4. Saisissez les valeurs souhaitées dans la section Corps . La boîte de demande par défaut apparaîtra comme suit :

   1. Prompt : Saisissez la question ou la requête.

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

   3. Code de langue : Spécifiez le code de langue souhaité pour l’entrée.

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

Essayez l’API publique Eddy AI dans Swagger

1. Naviguez vers le hub API Swagger. Dans les versions du projet, vous pouvez trouver l’API IA Ask Eddy.

2. En haut à droite du hub API Swagger, cliquez sur Authorise.

3. Le panneau Autorisations disponibles apparaîtra, vous invitant à saisir le jeton API.

4. Collez le jeton API dans le panneau Autorisations disponibles et cliquez sur Autoriser.

5. Une fois autorisé, allez dans les versions > /v2/ProjectVersions/ask-Eddy AI du projet et cliquez sur Essayer.

6. La boîte de demande par défaut apparaîtra comme suit :

• Prompt : Saisissez la question ou la requête.

• ID de version : Obtenir l’ID de version actuel auprès du /v2/ProjectVersions point de terminaison.

  

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

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

NOTE

Si vous recevez un message de service indisponible, 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
}