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:

  1. Rajapinnalle annetaan raakatekstiä. Jos dokumentti on muussa muodossa, esimerkiksi PDF-, HTML- tai Word-dokumenttina, se on ensin muunnettava UTF-8-merkistön mukaiseksi raakatekstiksi.
  2. Rajapinnassa on tarjolla ns. projekteja ja rajapintakutsu pitää kohdistaa oikeaan projektiin dokumentin kielen mukaisesti. Jos dokumentin kieli ei ole tiedossa, se pitää ensin tunnistaa koneellisesti jollakin muulla työkalulla (kts. esim. SeCon LAS-rajapinta tai Pythonin pycld3- tai langdetect-kirjasto). Projekteja on tällä hetkellä kolme: yso-fi, yso-sv ja yso-en.
  3. Rajapinnassa on useita metodeja, mutta niistä tärkeimmät ovat luettelo projekteista (/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.
  4. Rajapinnan käyttöä ei tällä hetkellä rajoiteta mitenkään. Jotta rajapinta ei ylikuormittuisi, vältä tekemästä useita rinnakkaisia rajapintakutsuja eli odota, että edellinen kutsu valmistuu ennen kuin teet uuden kutsun. Syöte voi olla kooltaan enintään 5 MB.

Yksityiskohtaisempi tekninen (OpenAPI/Swagger), interaktiivinen dokumentaatio rajapinnasta löytyy tältä sivulta.

Rajapintapalvelun käyttäjiä

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

  • No labels