Stel een vraag aan de Eddy AI API

De Eddy AI Public API is een functie van onschatbare waarde die is ontworpen om de functionaliteit en flexibiliteit van onze Eddy AI-zoekfunctie te verbeteren. De Eddy AI Public API is met name handig voor bedrijven die AI-gestuurde zoekmogelijkheden rechtstreeks in hun eigen platforms of services willen integreren. Door Eddy AI in uw product in te bedden, biedt u gebruikers de mogelijkheid om toegang te krijgen tot krachtige zoekfunctionaliteit zonder dat ze uw documentatiesite hoeven te bezoeken.

Deze API biedt meer flexibiliteit bij het aanpassen van de gebruikersinterface, zodat u aspecten zoals kleur, naamgeving en plaatsing kunt afstemmen op uw merk en gebruikerservaring. Met deze naadloze integratie wordt Eddy AI een natuurlijke uitbreiding van uw product, waardoor gebruikersinteracties worden verbeterd en de zoekefficiëntie wordt verbeterd. Door de API-eindpunten bloot te leggen, kunt u ze opnemen in uw platforms, moeiteloos antwoorden uit Eddy AI halen en een aangepaste zoekervaring bouwen.

NOTITIE

Om meer te weten te komen over de talen die door Eddy AI worden ondersteund, click here.

De openbare API gebruiken

1. Navigeer naar () in de linkernavigatiebalk in de Knowledge base portal.

2. Navigeer in het linkernavigatiedeelvenster naar AI features > Eddy AI.

3. Breid de AI-zoeksuite accordeon uit.

4. Schakel in het gedeelte AI-ondersteunend zoeken het selectievakje Openbare API in.

NOTITIE

1. Zorg ervoor dat ten minste één van de selectievakjes is ingeschakeld. Anders wordt de AI-ondersteunende zoekschakelaar automatisch uitgeschakeld.

2. Als de openbare API niet is ingeschakeld, ontvangt u een '500 response code-fout' of een '400 API-toegang uitgeschakelde fout' tijdens het gebruik van Ask Eddy AI API.

3. Elke API-aanroep vermindert uw totale aantal kredietpunten met één.

3. Maak een autorisatie-API-token.

NOTITIE

1. Navigeer in de Knowledge Base-portal naar Instellingen () in de linkernavigatiebalk.

2. Navigeer in het linkernavigatiedeelvenster naar Knowledge Base Portal > API-tokens.

3. Klik op API-token maken, voer de tokennaam in en geef de POST-methode op.

4. Klik op Het gegenereerde API-token maken en kopiëren .

4. De API-structuur vind je op de API hub.

Probeer de Eddy AI Public API in onze API-documentatie

1. Navigeer naar de Document360- API documentation.

2. Klik aan de rechterkant van de pagina op het gedeelte Proberen .

3. Voer in het veld Token het API-token in dat is gegenereerd op basis van uw Document360-project.

4. Voer de gewenste waarden in de sectie Lichaam in. Het standaardaanvraagvak wordt als volgt weergegeven:

   1. Prompt: voer de vraag of vraag in.

   2. Versie-ID: Verkrijg de huidige versie-ID.

   3. Taalcode: Geef de gewenste taalcode op voor de invoer.

5. Klik op Probeer het en bekijk het antwoord en het antwoord wordt gegenereerd.

Probeer de Eddy AI Public API in Swagger

1. Navigeer naar de Swagger- API hub. Onder projectversies vind je de Ask Eddy AI API.

2. Klik in de rechterbovenhoek van de Swagger API-hub en klik op Autoriseren.

3. Het deelvenster Beschikbare autorisaties wordt weergegeven, waarin u wordt gevraagd het API-token in te voeren.

4. Plak het API-token in het deelvenster Beschikbare autorisaties en klik op Autoriseren.

5. Zodra geautoriseerd, navigeert u naar > /v2/ProjectVersions/ask-Eddy AI Projectversies en klikt u op Uitproberen.

6. Het standaardaanvraagvak wordt als volgt weergegeven:

• Prompt: voer de vraag of vraag in.

• Versie-ID: Verkrijg de huidige versie-ID van het /v2/ProjectVersions eindpunt.

  

• Taalcode: Geef de gewenste taalcode op.

7. Klik op Uitvoeren om een succesvol antwoord te ontvangen dat alle vereiste informatie bevat.

NOTITIE

Als u een bericht ontvangt dat de service niet beschikbaar is, controleert u of de openbare API is ingeschakeld in de instellingen.

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