Det öppna gränssnittet erbjuder samma funktionalitet som Finto AI:s formulärgränssnitt - formuläret använder faktiskt samma API. Man ger API-servicen text och får som svar förslag till ämnesord. Varje förslag innehåller begreppets URI, dess term samt ett poängtal mellan 0.0 och 1.0, som visar hur relevant algoritmen tror att ämnesordet är för dokumentet.
Observera följande om du vill använda vår API:
- API:et kräver rå text. Om dina dokument är i ett annat format, t.ex. PDF, HTML eller Word, måste du först omvandla dem till råtext i UTF-8 kodning.
- API:et innehåller olika projekt. API-begäran måste riktas till rätt projekt beroende av dokumentets språk. Om språket är okänt, måste du först identifiera det med ett annat verktyg (se t.ex. SeCo LAS API och Python-programbiblioteket langdetect)
- API:et består av flera metoder. De viktigaste är listan på projekt (
/v1/projects/) och förslag till ämnesord (/v1/projects/<project_id>/suggest). Du kan kontrollera antalet förslag med parametrarnalimitochthreshold. Limit begränsar totala antalet förslag medan threshold sätter ett minimumvärde för poängtalen. - Vi har inte begränsat tillgången till API:et. För att undvika överbelastning, undvik att göra flera begäran parallellt - vänta tills den tidigare begäran har avslutats innan du gör en ny. Maximumstorleken för en begäran är 5 MB.
Vi har också en detaljerad interaktiv OpenAPI/Swagger-specifikation för API:et.
Användare av gränssnittet
Finto AI/Annif-gränssnittet används redan av Jyväskylä universitets JYX-publikationsarkiv, där det underlättar indexering av avhandlingar. När studerande publicerar sin avhandling i systemet, får de förslag som de sedan kan korrigera och komplettera. De slutliga ämnesorden fastställs av bibliotekspersonal. Motsvarande system är i bruk i flera andra arkiv som upprättshålls av Nationalbiblioteket. Kirjavälitys Oy använder gränssnittet för att skapa metadata för nya boktitlar.
Automatiska ämnesordsförslag i JYX-arkivet
