Preskočiť na obsah

API kľúče

API kľúč umožní externému systému (napr. váš ERP, CRM alebo skript) pracovať s KwargsAI cez REST API, bez prihlásenia používateľa. Kľúč vygenerujete v Administrácii, v sekcii Integrácie na karte API kľúče.

Pri vytváraní zvolíte, na čo kľúč slúži:

Typ Na čo je Viazaný na
Zápis dokumentov Posielať dokumenty do priečinka (REST) jeden priečinok (typu „dokumenty”)
Otázky (API) Položiť otázku a dostať odpoveď s citáciami (REST) jeden asistent
Audit Logs (len čítanie) Čítať záznamy z Audit Logs (REST), balík Enterprise celú inštanciu (len čítanie)

Kľúč na dokumenty alebo otázky je viazaný na jeden cieľ (priečinok alebo asistent) a robí len danú jednu vec. Kľúč typu Audit Logs iba číta auditné záznamy. Vytvorenie aj zrušenie kľúča sa zapíše do Audit Logs.

V konzole /admin otvorte sekciu Integrácie a kartu API kľúče (/admin?section=tokens). Kľúče spravuje administrátor (alebo podpora KwargsAI).

Karta API kľúče v administrácii: zoznam existujúcich kľúčov a tlačidlo Nový kľúč

  1. Kliknite na + Nový kľúč a zadajte názov kľúča (napr. „ERP nočný export”), nech viete, kam patrí.
  2. Zvoľte, na čo bude slúžiť, a cieľ: priečinok (pri zápise dokumentov) alebo agenta (pri otázkach).
  3. Zvoľte platnosť: 30, 90 alebo 180 dní, 1 rok, alebo Bez expirácie (kľúč platí, kým ho nezneplatníte).
  4. Kliknite na Vytvoriť kľúč.

Karta ukazuje tabuľku kľúčov so stĺpcami Kľúč (názov a začiatok kľúča), Použitie (na čo slúži a cieľ), Platnosť a Naposledy (kedy bol naposledy použitý). Pod ňou je rozbaľovacia časť Ako kľúč použiť s ukážkou volania.

Kľúč je zámerne veľmi obmedzený:

  • Robí len jednu vec. Kľúč na nahrávanie iba zapisuje dokumenty; kľúč na otázky sa iba pýta. Cez API sa nedá spravovať inštancia, používatelia ani nastavenia.
  • Len jeden cieľ. Kľúč pracuje výhradne s priečinkom, resp. asistentom, ktorý ste zvolili.
  • Obmedzenia priečinkov. Kľúč na nahrávanie nemožno vydať pre znalostné priečinky (majú povinné schválenie) ani pre priečinky spravované dodávateľom. Kľúč na otázky funguje pre každého asistenta, odpovede cez API však nespúšťajú analýzu dát.

Kľúč môžete kedykoľvek zneplatniť. Systémy, ktoré ho používajú, tým okamžite prestanú fungovať. Záznam o kľúči zostáva (kto ho vytvoril a kedy bol naposledy použitý) ako audit.

Návod na volanie a príklady nájdete v API referencii: