Lehmus AI:n kielimalleja voidaan käyttää omista sovelluksista OpenAI-yhteensopivien ohjelmointirajapintojen kautta.
Lehmus AI:n Model Gateway toimii mallien yhteisenä rajapintana ja reitittää pyynnöt oikealle mallille.
Mitä tarvitset ennen aloitusta
Tarvitset:
- Lehmus AI -käyttöoikeuden
- API-avaimen
- API URL –osoitteen
- Käytettävän mallin Public Model ID:n
API-osoite
Voit kopioida Lehmus AI:n API-osoitteen suoraan portaalin vasemman sivupalkin API URL –kohdasta tai https://api.lehmus-ai.oulu.fi
OpenAI-yhteensopivia palveluita käytettäessä Model Gatewayn base URL muodostetaan lisäämällä API URL –osoitteeseen /v1.
Tuetut rajapinnat
Model Gateway tarjoaa seuraavat rajapinnat:
- POST /v1/chat/completions – Chat Completions
- POST /v1/responses – Responses API
- POST /v1/embeddings – tekstin embeddings-esitykset
- POST /v1/audio/transcriptions – puheen muuttaminen tekstiksi
- GET /v1/models – käytettävissä olevien mallien listaaminen
Model Gateway tukee dokumentoitua osajoukkoa OpenAI-yhteensopivista API-toiminnoista, ei automaattisesti kaikkia OpenAI API:n operaatioita tai parametrejä.
Tunnistautuminen
Jokaisessa Model Gateway -pyynnössä käytetään Lehmus AI:ssa luotua API-avainta bearer-tokenina. API-avaimella täytyy olla invoke-oikeus käytettävään malliin.
Katso Lehmus AI: API-avainten luominen ja hallinta.
Mallin tunniste
Anna käytettävä malli pyynnön model-kentässä. Käytä mallin Public Model ID:tä, jonka voit kopioida esimerkiksi Lehmus AI –portaalin Models-välilehdeltä.
Chat completions
Perinteinen OpenAI-yhteensopiva chat-rajapinta on:
POST /v1/chat/completions
Sitä voidaan käyttää esimerkiksi OpenAI-yhteensopivissa sovelluksissa ja kehitystyökaluissa.
Responses API
Uudempi Responses API käyttää endpointia:
POST /v1/responses
Responses API tukee tekstintuottoa, suoratoistoa (streaming), keskusteluja ja mallien työkalun käyttöä.
Responses API voi käyttää myös Model Gatewayn tarjoamia RAG- ja MCP-työkaluja. Gateway voi suorittaa työkalukutsun ja palauttaa tuloksen mallille saman pyynnön aikana.
Mallien listaaminen
Käytettävissä olevat chat-mallit voi hakea:
GET /v1/models
Oletuksena lista sisältää chat-tyyppiset mallit, joihin kutsujalla on käyttöoikeus.
Jo olemassa olevia ohjesivuja Lehmus AI:n kielimallien hyödyntämiseen
Löydät ohjeita Lehmus AI:n kielimallien yhdistämisestä muihin sovelluksiin:
Esimerkki API-kutsusta
Voit testata yhteyttä esimerkiksi curl-komennolla (Command prompt yhteensopiva):
curl -sS "https://api.lehmus-ai.oulu.fi/v1/chat/completions" -H "Authorization: Bearer OMA_API_AVAIMESI" -H "Content-Type: application/json" -d "{\"model\":\"PUBLIC_MODEL_ID\",\"messages\":[{\"role\":\"user\",\"content\":\"Hello\"}]}"Korvaa OMA_API_AVAIMESI omalla API-avaimellasi, ja PUBLIC_MODEL_ID haluamallasi Lehmus AI:n kielimallilla, jonka olet liittänyt API-avaimeesi.
Virhetilanteet
Model Gateway käyttää muun muassa seuraavia HTTP-virhekoodeja:
- 400: pyyntö on virheellinen tai sisältää tuntemattoman toiminnon
- 401/403: tunnistautuminen epäonnistui tai API-avaimelta puuttuu käyttöoikeus
- 404: mallia ei löydy tai se ei ole käyttövalmis
- 413: pyyntö ylittää 32 Mt:n rajan
- 501: pyydettyä ominaisuutta ei ole toteutettu
- 502: mallin taustapalvelu epäonnistui tai siihen ei saatu yhteyttä
Ongelmatilanteet
Jos rajapintakutsu ei onnistu, tarkista ensin seuraavat asiat:
- OpenAI-yhteensopivan sovelluksen base URL on https://api.lehmus-ai.oulu.fi/v1.
- Pyynnössä käytetään Lehmus AI:ssa luotua API-avainta bearer-tokenina, ja avaimella on invoke-oikeus käytettävään malliin.
- Pyynnön model-kentässä on mallin oikea Public Model ID.
- Käyttämäsi rajapinta ja parametrit kuuluvat tuettuihin toimintoihin.
Katso myös tämän ohjeen Virhetilanteet-osio, jossa kuvataan tavallisimpien HTTP-virhekoodien merkitykset.
Lisätietoa ja tuki
Jos ongelma ei ratkea, ota yhteyttä osoitteeseen ai@oulu.fi tai ict@oulu.fi. Kerro tukipyynnössä käyttämäsi sovellus, mallin Public Model ID, kutsuttu rajapinta, virhekoodi ja ongelman ajankohta. Älä liitä tukipyyntöön API-avainta tai luottamuksellista aineistoa.
Tarkemmat rajapintakuvaukset ja käyttöesimerkit löydät ConfidentialMindin Model Gateway -dokumentaatiosta. Tarkista, että käyttämäsi toiminto on tuettu myös Lehmus AI:n ympäristössä.