Kompletní referenční dokumentace pro všechna API platformy Knowledge Base.
Referenci API použijte, když znáte operaci, kterou chcete implementovat, a potřebujete aktuální koncový bod, parametry, schémata požadavků a odpovědí a informace o stavu.
Otevřít referenci API
Použijte referenci Swagger jako autoritativní zdroj pro aktuální definice koncových bodů a podrobnosti implementace.
Co najdete v referenci API
Reference API poskytuje podrobnosti implementace pro dostupné operace, včetně:
- Metody HTTP a cesty koncových bodů.
- Parametry požadavků.
- Schémata požadavků a odpovědí.
- Informace o odpovědích a stavu.
Dostupná API pokrývají funkční oblasti, jako jsou:
- Kolekce a přístup ke kolekcím.
- Dokumenty a zpracování dokumentů.
- Inference AI.
- Přílohy.
- Štítky dokumentů.
- Uživatelé a organizace.
- Zpětná vazba.
- Nastavení.
- Analytics a vytváření sestav.
- Integrace robotů.
Použijte Začínáme s API Knowledge Base, pokud potřebujete úvod do modelu zdrojů API, životního cyklu zpracování dokumentů, chování inference nebo typického toku požadavků.
Řešení problémů s požadavky API
Odpovědi API obsahují hlavičku odpovědi X-Request-ID, která identifikuje požadavek napříč službami Knowledge Base.
Při řešení problémů s neúspěšným požadavkem nebo při kontaktování podpory zachyťte X-Request-ID.Také si ponechte stav HTTP, podrobnosti odpovědi, koncový bod a přibližný čas žádosti.
