Eddy AI est intégré dans votre référence API publiée, permettant aux développeurs de poser des questions sur un endpoint et obtenir des réponses sans quitter la documentation. Plutôt que de reconstituer le fonctionnement d’un point de terminaison uniquement à partir des paramètres, du schéma et de l’exemple de code, un développeur peut demander directement à Eddy — comment le terminateur se comporte, quelle authentification il nécessite, ou un exemple de code dans un langage spécifique — et obtenir une réponse fondée sur la propre spécification de ce terminaison.
Cet article explique comment les développeurs utilisent Eddy AI dans la référence de l’API, et comment l’activer dans votre documentation API. Pour un aperçu général de l’expérience du lecteur, voir API fundamentals.
Où trouver Eddy AI
Eddy AI est disponible directement depuis les panneaux sur une page de point final. Cherchez l’icône Ask Eddy AI sur chacun des éléments suivants :
- Panneau de code — demandez à propos de l’exemple de requête, par exemple pour l’expliquer ou le convertir dans un autre langage.
- Panneau de demandes — demandez à propos de la demande que vous développez dans Try It !.
- Panel de réponse — demandez ce que signifie un champ ou un statut particulier.
Cliquer sur l’icône ouvre le panneau Eddy AI, déjà porté au point de terminaison que vous voyez.
Poser une question
Lorsque vous ouvrez Eddy AI, vous pouvez soit choisir l’une des suggestions suggérées, soit taper votre propre question.
Les suggestions sont :
- Expliquez ce point final
- Montre un exemple de curl
- Quelle authentification cela nécessite-t-il ?
Pour poser autre chose, tapez votre question dans le champ Poser une question... et soumettez-la. Eddy répond en utilisant la spécification du point de terminaison actuel, donc ses réponses reflètent le chemin réel, les paramètres, l’authentification et le schéma de ce point de terminaison — et non des exemples génériques.
Par exemple, demander un échantillon de requête dans un langage particulier renvoie un extrait prêt à être utilisé conçu pour ce point de terminaison, incluant son URL correcte et son authentification, avec un contrôle pour copier le code.
Activer Eddy AI pour votre documentation API
Eddy AI doit être activé pour la documentation de votre API avant d’apparaître dans la référence publiée. Cela est configuré par un administrateur dans le portail de la base de connaissances.
- Va dans Paramètres > réglages IA > Eddy Réglages IA.
- Dans la section suite de recherche , cochez la case documentation de l’API .
- Sauvegardez vos modifications.
Une fois activée, l’icône Ask Eddy AI apparaît sur les panneaux de terminaison dans votre référence API publiée.
Choses à garder en tête
- Les réponses d’Eddy AI sont orientées vers le point final. Les réponses sont générées à partir de la spécification du point de terminaison que vous voyez, ce qui reflète les détails réels de ce point plutôt que des exemples génériques.
- L’utilisation de l’IA consomme des crédits. Selon votre forfait, l’utilisation d’Eddy AI peut compter dans la provision de crédit IA de votre projet. Consultez les conditions de crédit IA de votre plan si vous prévoyez une utilisation intensive.
FAQ
Où apparaît Eddy AI dans la référence de l’API ?
L’icône Ask Eddy AI apparaît dans les panneaux Code, Requête et Réponse d’une page endpoint. En cliquant dessus, le panneau Eddy AI est orienté vers ce point de départ.
Que puis-je demander à Eddy AI ?
Vous pouvez utiliser l’une des invites suggérées — Expliquez ce point de terminaison, Affichez un exemple de curl, ou Quelle authentification nécessite ? — ou taper ta propre question. Eddy répond en utilisant la spécification du point de terminaison actuel, donc ses réponses reflètent le chemin réel, les paramètres et l’authentification de ce terminaison.
Pourquoi ne vois-je pas l’icône Ask Eddy AI dans ma référence API ?
Eddy AI doit d’abord être activé pour la documentation de l’API. Un administrateur peut l’activer dans Paramètres > paramètres IA > Eddy en cochant la case documentation API dans la section Search suite.