Eddy AI is ingebouwd in je gepubliceerde API-referentie, zodat ontwikkelaars vragen kunnen stellen over een endpoint en antwoorden kunnen krijgen zonder de documentatie te verlaten. In plaats van alleen uit de parameters, het schema en het codevoorbeeld te reconstrueren hoe een endpoint werkt, kan een ontwikkelaar Eddy direct vragen — hoe het endpoint zich gedraagt, welke authenticatie nodig is, of om een codevoorbeeld in een specifieke taal — en een antwoord krijgen dat gebaseerd is op de specificatie van dat endpoint.
Dit artikel legt uit hoe ontwikkelaars Eddy AI gebruiken in de API-referentie, en hoe ze dit kunnen inschakelen voor je API-documentatie. Voor een algemeen overzicht van de lezerservaring, zie API fundamentals.
Waar vind je Eddy AI
Eddy AI is direct beschikbaar via de panelen op een endpointpagina. Let op het Ask Eddy AI-icoon op elk van de volgende modellen:
- Codepaneel — vraag bijvoorbeeld naar het verzoekvoorbeeld, om het uit te leggen of om het om te zetten naar een andere taal.
- Verzoekpaneel — vraag naar het verzoek dat je inbouwt in Try It!.
- Reactiepaneel — vraag naar de reactie, zoals wat een bepaald vakgebied of status betekent.
Door op het pictogram te klikken, opent het Eddy AI-paneel, dat al is gericht op het eindpunt dat je bekijkt.
Een vraag stellen
Wanneer je Eddy AI opent, kun je ofwel een van de voorgestelde prompts kiezen of je eigen vraag typen.
De voorgestelde prompts zijn:
- Leg dit eindpunt uit
- Laat een curl-voorbeeld zien
- Welke authenticatie is hiervoor nodig?
Om iets anders te vragen, typ je je vraag in het veld 'Stel een vraag'... en dien je het in. Eddy antwoordt met de specificatie van het huidige eindpunt, zodat de antwoorden het echte pad, parameters, authenticatie en schema van dat eindpunt weerspiegelen — geen generieke voorbeelden.
Bijvoorbeeld, het vragen naar een verzoekvoorbeeld in een bepaalde taal levert een kant-en-klaar fragment terug dat voor dat eindpunt is gebouwd, inclusief de juiste URL en authenticatie, met een controle om de code te kopiëren.
Eddy AI inschakelen voor je API-documentatie
Eddy AI moet ingeschakeld zijn voor je API-documentatie voordat het in de gepubliceerde referentie verschijnt. Dit wordt geconfigureerd door een beheerder in het kennisbankportaal.
- Ga naar Instellingen > AI-instellingen > Eddy AI-instellingen.
- Selecteer onder het gedeelte Search suite het selectievakje API-documentatie .
- Bewaar je wijzigingen.
Zodra ingeschakeld, verschijnt het Ask Eddy AI-icoon op de eindpuntpanelen in je gepubliceerde API-referentie.
Dingen om in gedachten te houden
- Eddy AI-antwoorden zijn gericht op het eindpunt. Reacties worden gegenereerd vanuit de specificatie van het eindpunt dat je bekijkt, dus ze weerspiegelen de daadwerkelijke details van dat eindpunt in plaats van algemene voorbeelden.
- AI-gebruik verbruikt credits. Afhankelijk van je plan kan het gebruik van Eddy AI meetellen voor de AI-kredietlimiet van je project. Controleer de AI-kredietvoorwaarden van je plan als je veel gebruik verwacht.
FAQ
Waar verschijnt Eddy AI in de API-referentie?
Het Ask Eddy AI-icoon verschijnt op de Code-, Verzoek- en Antwoordpanelen van een endpointpagina. Als je erop klikt, opent het Eddy AI-paneel dat op dat eindpunt is gericht.
Wat kan ik Eddy AI vragen?
Je kunt een van de voorgestelde prompts gebruiken — Leg dit endpoint uit, toon een curl-voorbeeld, of Welke authenticatie heeft dit nodig? — of typ je eigen vraag. Eddy antwoordt met de specificatie van het huidige eindpunt, zodat de antwoorden het echte pad, de parameters en authenticatie van dat eindpunt weerspiegelen.
Waarom zie ik het Ask Eddy AI-icoon niet in mijn API-referentie?
Eddy AI moet eerst ingeschakeld zijn voor API-documentatie. Een beheerder kan het inschakelen onder Instellingen > AI-instellingen > Eddy AI-instellingen door het vakje API-documentatie aan te vinken in het Zoeksuite-gedeelte.