Tekoälyavusteinen luonnollisen kielen haku API-dokumentaatiossa
Rautiainen, Aleksis (2025)
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:amk-2025052214792
https://urn.fi/URN:NBN:fi:amk-2025052214792
Tiivistelmä
Tässä toiminnallisessa opinnäytetyössä kehitettiin tekoälyavusteinen hakutyökalu, jonka tarkoituksena on parantaa API-dokumentaation käytettävyyttä luonnollisen kielen haun avulla. Työn tavoitteena oli rakentaa järjestelmä, joka auttaa ohjelmoijia esittämään kysymyksiä dokumentaatiosta vapaamuotoisesti ja antaa takaisin relevantteja, ymmärrettäviä vastauksia. Työ keskittyi erityisesti Swagger-muotoisten dokumentaatiotiedostojen käsittelyyn ja GPT-3.5-Turbo -mallin hyödyntämiseen vastauksien tuottamisessa.
Tietoperustassa käsiteltiin API-dokumentaation käytettävyyteen liittyviä haasteita, tekoälyn soveltamista tiedonhakuun sekä luonnollisen kielen käsittelyn ja hakualgoritmien perusperiaatteita. Menetelmäosuudessa toteutettiin Python-ohjelmointiympäristössä paikallisesti toimiva järjestelmä, jossa Swagger JSON -tiedostoa jäsennettiin ja analysoitiin tekoälyn avulla.
Prototyyppi testattiin Swaggerin PetStore-esimerkkidokumentaatiolla, ja sen arviointi tehtiin itsearvioinnin kautta. Tulokset osoittivat, että järjestelmä pystyy antamaan täsmällisiä vastauksia ja helpottaa dokumentaation käyttöä erityisesti silloin, kun käyttäjällä ei ole tarkkaa tietoa endpointien nimistä tai rakenteesta. Järjestelmä osoittautui toimivaksi ratkaisuksi kohdennettuun API-dokumentaation hakuun luonnollisella kielellä.
Tietoperustassa käsiteltiin API-dokumentaation käytettävyyteen liittyviä haasteita, tekoälyn soveltamista tiedonhakuun sekä luonnollisen kielen käsittelyn ja hakualgoritmien perusperiaatteita. Menetelmäosuudessa toteutettiin Python-ohjelmointiympäristössä paikallisesti toimiva järjestelmä, jossa Swagger JSON -tiedostoa jäsennettiin ja analysoitiin tekoälyn avulla.
Prototyyppi testattiin Swaggerin PetStore-esimerkkidokumentaatiolla, ja sen arviointi tehtiin itsearvioinnin kautta. Tulokset osoittivat, että järjestelmä pystyy antamaan täsmällisiä vastauksia ja helpottaa dokumentaation käyttöä erityisesti silloin, kun käyttäjällä ei ole tarkkaa tietoa endpointien nimistä tai rakenteesta. Järjestelmä osoittautui toimivaksi ratkaisuksi kohdennettuun API-dokumentaation hakuun luonnollisella kielellä.