API-avaimen avulla voit käyttää Lehmus AI:n kielimalleja, RAG-resursseja ja valmiita agentteja ohjelmointirajapintojen sekä niitä hyödyntävien sovellusten kautta.
API-avaimelle määritellään sitä luotaessa tarkat käyttöoikeudet. Avaimelle voidaan antaa oikeus käyttää kielimallia, lukea tai kirjoittaa RAG-resurssia tai kutsua valmista agenttia.
Mitä tarvitset ennen aloitusta
Tarvitset:
- Lehmus AI -käyttöoikeuden
- Oikeuden niihin Lehmus AI –resursseihin, joita haluat käyttää avaimella
- Yliopiston verkko- tai VPN-yhteyden
API-avaimelle voi antaa vain sellaisia käyttöoikeuksia, jotka käyttäjällä jo itsellään on.
Valitse API-avaimen tyyppi
Lehmus AI:ssa on kaksi API-avaintyyppiä
Personal key
Personal key toimii käyttäjäidentiteetilläsi. Käytä henkilökohtaista avainta omissa skripteissäsi ja integraatioissasi.
Henkilökohtainen avain on sidottu käyttäjän omiin käyttöoikeuksiin ja lakkaa toimimasta niihin resursseihin, joihin käyttäjä menettää käyttöoikeuden. Tenantin eli projektin jäsen voi luoda henkilökohtaisen avaimen.
Service-account key
Service-account key on yksittäisestä käyttäjästä riippumaton avain. Se on tarkoitettu esimerkiksi projektin yhteisiin integraatioihin ja tuotantokäytön työkuormiin.
Service-account-avaimen voi luoda vain projektin ylläpitäjä.
Luo API-avain
- Avaa Lehmus AI –portaalin API Keys.
- Valitse Create key
- Anna avaimelle kuvaava nimi
- Valitse avaimen tyyppi (Personal/Service Account)
- Lisää avaimelle tarvittavat käyttöoikeudet haluamillesi kielimalleille, jo luoduille RAG-endpointeille tai Preset Agenteille
- Klikkaa Create ja luo avain
- Kopioida luotu API avain heti ja laittaa se talteen turvalliseen paikkaan.
API-avain näytetään kokonaisuudessaan vain luomisen yhteydessä. Tämän jälkeen portaalissa säilytetään vain avaimen tunnistamiseen käytettävä lyhyt alkuosa.
Palvelun, kuten mallin tai RAGin, omalta sivulta voidaan myös avata Create API key –toiminto, jolloin kyseistä resurssia vastaava käyttöoikeus on valmiiksi täytetty lomakkeelle.
Huomioithan, että avaimen käyttöoikeuksia ei voi muuttaa jälkikäteen. Jos tarvitset eri käyttöoikeudet, luo uusi API-avain.
Säilytä API-avain turvallisesti
API-avain toimii tunnistautumistietona. Säilytä se salaisuutena.
- Älä jaa API-avainta toiselle käyttäjälle
- Älä tallenna avainta lähdekoodiin
- Älä lisää avainta versionhallintaan
- Älä liitä avainta tukipyyntöön
- Syötä avain vain sitä varten tarkoitettuun sovelluksen asetukseen
Vaihda avain
Jos avaimen salainen osa täytyy vaihtaa, avaa avain Lehmus AI –portaalissa ja käytä Rotate –toimintoa.
Rotate luo uuden salaisen osan siten, että vanha säilyy toimivana lyhyen päällekkäisen jakson ajan. Tämä mahdollistaa uuden avaimen vaihtamisen integraatioon ennen vanhan lakkaamasta toiminnasta.
API-avaimen peruuttaminen
Jos API-avainta ei enää tarvita tai se on vaarantunut, avaa avain Lehmus AI –portaalissa ja valitse Revoke.
Revoke poistaa avaimen käytöstä välittömästi ja pysyvästi.
Tarkista API-avaimen käyttö
API-avaimen sivulla on Usage-välilehti, jolla voit tarkastella avaimen tokenien käyttöä valitulla ajanjaksolla. Näkymässä eritellään muun muassa input-, output-, embedding- ja rerank-tokenit. Käyttäjä näkee omien henkilökohtaisten avaimiensa käytön. Projektin ylläpitäjä voi lisäksi tarkastella projektin service-account-avainten käyttöä.
API-avaimen käyttäminen
Model Gateway –kutsuissa API-avain lähetetään bearer-tokenina Authorization-otsakkeessa. Jokainen pyyntö tarvitsee API-avaimen, jolla on invoke-oikeus käytettävään malliin.
Lisää esimerkkejä löydät ohjeesta Lehmus AI: Ohjelmointirajapintojen käyttö – ict.oulu.fi.