Ask Eddy AI API

De Eddy AI Public API is een onschatbare functie die is ontworpen om de functionaliteit en flexibiliteit van onze Eddy AI-zoekfunctie te verbeteren. De Eddy AI Public API is vooral nuttig voor bedrijven die AI-gedreven zoekmogelijkheden diepgaand willen integreren direct in hun eigen platforms of diensten. Door Eddy AI in je product te integreren, bied je gebruikers de mogelijkheid om krachtige zoekfunctionaliteit te gebruiken zonder je documentatiesite te hoeven bezoeken.

Deze API biedt meer flexibiliteit bij het aanpassen van de gebruikersinterface, waardoor je aspecten als kleur, naamgeving en plaatsing kunt aanpassen aan je merk en gebruikerservaring. Met deze naadloze integratie wordt Eddy AI een natuurlijke verlenging van uw product, wat de gebruikersinteracties verbetert en de zoekefficiëntie verhoogt. Door de API-eindpunten bloot te stellen, kun je ze integreren in je platforms, moeiteloos antwoorden uit Eddy AI halen en een op maat gemaakte zoekervaring opbouwen.

OPMERKING

Wil je meer weten over de talen die door Eddy AI worden ondersteund, klik hier.

Gebruik van de publieke API

1. Navigeer naar () in de linker navigatiebalk in het Knowledge base portal.

2. Navigeer in het linker navigatiepaneel naar AI features > Eddy AI

3. Breid de AI-zoeksuite uit als accordeon.

4. Selecteer in de sectie AI assistieve zoekopdrachten het selectievakje Public API .

OPMERKING

1. Zorg ervoor dat ten minste één van de selectievakjes is aangevinkt. Anders wordt de AI-hulpzoekschakelaar automatisch uitgeschakeld.

2. Als de publieke API niet is ingeschakeld, krijg je een '500 response code error' of een '400 API access disabled error' terwijl je de Ask Eddy AI API gebruikt.

3. Elke API-aanroep verlaagt je totale credit-aantal met één.

3. Maak een autorisatie-API-token aan.

OPMERKING

1. Navigeer in het Knowledge Base-portaal naar Instellingen () in de linker navigatiebalk.

2. Ga in het linker navigatiepaneel naar Knowledge Base Portal > API Tokens.

3. Klik op Create API Token, voer de tokennaam in en geef de POST-methode op.

4. Klik op Create en kopieer het gegenereerde API-token.

4. Je kunt de API-structuur vinden op de API-hub.

Probeer de Eddy AI Public API in onze API-documentatie

1. Navigeer naar de document360 API-documentatie.

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

3. In het Token-veld voer je het API-token in dat is gegenereerd door je Document360-project.

4. Voer de gewenste waarden in in de sectie Lichaam . Het standaardaanvraagvakje verschijnt als volgt:

   1. Prompt: Voer de vraag of query in.

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

   3. Taalcode: Specificeer de gewenste taalcode voor de invoer.

5. Klik op Try it en zie de reactie en de reactie 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. Rechtsboven in de Swagger API-hub en klik op Autoriseren.

3. Het paneel Beschikbare autorisaties verschijnt, waarin je wordt gevraagd het API-token in te voeren.

4. Plak het API-token in het paneel Beschikbare Autorisaties en klik op Autoriseren.

5. Zodra geautoriseerd, ga je naar Projectversies > /v2/ProjectVersions/ask-Eddy AI en klik je op 'Probeer het uit'.

6. Het standaardaanvraagvakje verschijnt als volgt:

• Prompt: Voer de vraag of query in.

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

  

• Taalcode: Specificeer de gewenste taalcode.

7. Klik op Uitvoeren om een succesvol antwoord te ontvangen met alle benodigde informatie.

OPMERKING

Als je een bericht over dienst onbeschikbaar ontvangt, zorg dan dat de publieke 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
}