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.
Typy kľúčov
Section titled “Typy kľúčov”Pri vytváraní zvolíte, na čo kľúč slúži:
| Typ | Na čo je | Viazaný na |
|---|---|---|
| Nahrávanie dokumentov | Posielať dokumenty do priečinka (REST) | jeden priečinok (typu „dokumenty“) |
| Otázky asistentovi | Položiť otázku a dostať odpoveď s citáciami (REST) | jeden asistent |
Kľúč je vždy viazaný na jeden cieľ (priečinok alebo asistent) a robí len danú jednu vec.
Kde ich spravujete
Section titled “Kde ich spravujete”V konzole /admin otvorte sekciu API kľúče (/admin?section=tokens). Kľúče spravuje
administrátor (alebo superadmin).
Vygenerovanie kľúča
Section titled “Vygenerovanie kľúča”- Zadajte názov kľúča (napr. „ERP nočný export“), nech viete, kam patrí.
- Zvoľte typ a cieľ: priečinok (pri nahrávaní dokumentov) alebo asistenta (pri otázkach).
- Voliteľne nastavte platnosť (počet dní). Bez nej kľúč platí, kým ho nezneplatníte.
- Kliknite na Vytvoriť kľúč.
Rozsah a bezpečnosť
Section titled “Rozsah a bezpečnosť”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 nemožno vydať pre analytických asistentov.
Zneplatnenie
Section titled “Zneplatnenie”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.
Ako kľúč použiť
Section titled “Ako kľúč použiť”Návod na volanie a príklady nájdete v API referencii: