Annifin testirajapinta ja lomake osoitteessa annif.org
Annifin testirajapintapalvelu löytyy osoitteesta api.annif.org, ja tätä rajapintaa hyödyntävä testilomake osoitteesta annif.org. Testirajapintapalvelu käyttää uusinta Annifin ohjelmistoversiota sekä sen tarjoamia algoritmeja, mm. omikuji, jotka on koulutettu laajoilla opetusaineistoilla. Rajapinta api.annif.org toimii HTTP-protokollan lisäksi myös suojatulla HTTPS-yhteydellä.
Api.annif.org on päivittynyt isommin 17.1.2020, pienempi päivitys seurasi maaliskuussa 2020. Päivityksen myötä rajapinnan käyttämä YSO:n versio vaihdettiin uudempaan. Lisäksi mukana ovat nyt myös YSO-paikat, joten Annifin rajapintapalvelu voi ehdottaa myös paikannimiä aiheiksi. (Huom! Otamme säännöllsesti käyttöön uusia versioita YSO:sta.)
Rajapinnan tarjoamat projektit
Annifin rajapinnassa on tarjolla useita projekteja, jotka tukevat tiettyä sanastoa ja kieltä. Tarjolla ovat tällä hetkellä nämä projektit:
- yso-fi / yso-sv / yso-en: Yleisprojektit YSO:n käyttöön kolmella kielellä, toteutettu neuroverkkopohjaisesti
- wikidata-en: Wikidata-aiheita englanninkielisen tekstin pohjalta ehdottava projekti
- hogwarts: Tylypahkan tupia nimen perusteella ehdottava projekti
Tulevaisuuden näkymiä - kohti tuotantokäyttöä
Rajapintaan on suunniteltu lisättäväksi myös uusi learn-metodi, jota voidaan käyttää Annifin opettamiseen esimerkiksi sen jälkeen, kun kuvailija on tarkistanut Annifin ehdottamat aiheet ja korjaillut niitä. Tämän metodin käyttö testirajapinnassa ei tässä vaiheessa kuitenkaan ole sallittua, koska haluamme ensin selvittää huolellisesti, miten palautteesta oppiminen käytännössä vaikuttaa Annifin ehdotusten laatuun ja sitten päättää, miten laajaan käyttöön learn-metodi voidaan avata.
Testirajapinnan uudistus tammikuussa 2020 oli ensimmäinen askel kohti tuotantokäyttöön soveltuvaa automaattisen sisällönkuvailun rajapintaa, joka tarjotaan Finto-palvelun kautta kevätkesästä 2020 alkaen nimellä Finto AI. Tekniikaltaan uusi rajapinta on lähes identtinen api.annif.org-testirajapinnan kanssa, mutta se on tarkoitettu tuotantokäyttöön ja tarjolla on vain rajallinen joukko projekteja, ensi vaiheessa YSO:lle (kolmella kielellä) mutta tulevaisuudessa myös muille sanastoille. Finto AI:n rajapinnan käyttöön käyttöön tarjotaan tarkempaa ohjeistusta sen omalla sivulla tässä wikissä. Jatkossa testaamme uusia algoritmeja jne. Annifin puolella ja siirrämme hyväksi havaitsemamme Finto AI:n puolelle.
Huomioitavaa rajapinnan käyttäjille
Muutoksia rajapinnan metodinimissä
Annifin rajapinnan keskeisin metodi, jolle annetaan tekstiä ja joka ehdottaa aiheita, on alkuperäiseltä nimeltään “analyze”. Tämän nimen kuitenkin todettiin olevan harhaanjohtava ja nykyisin metodi tunnetaan nimellä “suggest”. Suosittelemme sovellusten siirtyvän käyttämään uutta metodinimeä. Vanhakin nimi kuitenkin toimii jatkossakin, vaikka sitä ei uudistuksen jälkeen enää mainita rajapinnan dokumentaatiossa. Huom., tuotantokäyttöön suosittelemme Finto AI:n rajapintaa.
Annif-prototyypin rajapinta v0 poistunut käytöstä
Osoitteessa api.annif.org/v0/ on ollut jo vuoden 2017 keväästä asti tarjolla Annifin alkuperäisen prototyypin rajapinta, joka poistui käytöstä rajapintauudistuksen myötä tammikuussa 2020.
