Rajapintapalvelu tarjoaa saman toiminnallisuuden kuin Finto AI:n lomakekäyttöliittymä - itse asiassa lomake perustuu täsmälleen samaan rajapintaan. Rajapinnalle annetaan teksti ja se vastaa antamalla asiasanaehdotuksia. Jokaisesta asiasanaehdotuksesta palautetaan URI-tunniste, termi sekä pistearvo väliltä 0.0-1.0, joka kuvastaa sitä, kuinka osuvaksi algoritmi arvioi asiasanan juuri tälle dokumentille.
Rajapintapalvelun käytössä on huomioitava seuraavaa:
yso-fi
, yso-sv
ja yso-en
./v1/projects/
) sekä asiasanojen suosittelu (/v1/projects/<project_id>/suggest
). Asiasanaehdotusten määrään voi vaikuttaa limit
- ja threshold
-parametreilla. Limit-parametri rajoittaa palautettavien ehdotusten määrää (oletusarvo 10) ja threshold asettaa vähimmäisrajan asiasanaehdotusten pistearvolle.Yksityiskohtaisempi tekninen (OpenAPI/Swagger), interaktiivinen dokumentaatio rajapinnasta löytyy tältä sivulta.
Finto AI:n/Annifin rajapintapalvelu otettiin ensimmäisenä käyttöön Jyväskylän yliopiston JYX-julkaisuarkistossa, jossa se toimii opinnäytetöiden kuvailun apuna. Opinnäytetyönsä järjestelmään jättävä opiskelija saa nähtäväkseen Annifin ehdottamat asiasanat, joita hän voi halutessaan muokata. Lopulliset asiasanat hyväksyy kirjastovirkailija tarkistuksen jälkeen. Vastaavanlainen integraatio on vuoden 2020 jälkeen otettu käyttöön useassa Kansalliskirjaston ylläpitämässä julkaisuarkistossa. Myös Kirjavälitys Oy käyttää rajapintapalvelua tuottaessaan ennakkotietoja tulevista kirjajulkaisuista.
Automaattiset asiasanaehdotukset JYX-julkaisuarkiston syöttölomakkeella