Mallitoteutuksen AuroraAI-palvelusuosittelijat mahdollistavat annettujen suositusten rajaamisen eri metatietojen perusteella. Tässä artikkelissa esitellään miten uusia rajauskenttiä hyödynnetään rajapintakutsuissa.
Aluerajaukset
Aiemmin suosittelukutsuissa on ollut mahdollista rajata tuloksia käyttäen yhtä kuntakoodia:
Code Block |
---|
"municipality_code": "091" |
Kuntakoodeja on mahdollista antaa useampia. Lisäksi voidaan antaa listat maakunnista ja sairaanhoitopiireistä, joita käytetään palautettavien palvelujen rajaamiseen vastaavasti kuin kuntakoodeja. Lisäksi voidaan antaa tieto siitä, halutaanko tuloksiin valtakunnallisia palveluita. Rajapintakutsussa nämä aluerajaukset näyttävät tältä:
Palveluluokkarajaukset
Aluerajausten lisäksi tuloksia voidaan rajata hyödyntäen julkisten palvelujen palveluluokkia. Rajapinta ottaa vastaan listan halutuista pää- ja alaluokista ja palauttaa vain kyseisiin palveluluokkiin kuuluvia palveluita.
Palveluluokat rajataan listalla URI-koodeja, jotka löytyvät Yhteentoimivuusalustalta.
Julkisten palvelujen luokitus: https://koodistot.suomi.fi/codescheme;registryCode=ptv;schemeCode=ptvserclass2
Alla esimerkki tekstihaun rajaamisesta "Nuorten palvelut"-palveluluokkaan, rajaamiseen käytetty URI-koodi on noudettavissa yllä olevasta luokitussivulta (URI-kenttä).
Code Block |
---|
{
"search_text": "harrastustoimintaa nuorille",
"service_filters": {
"include_national_services": true,
"service_classes":["http://uri.suomi.fi/codelist/ptv/ptvserclass2/code/P28"] ]
},
"limit": 5
} |
Palvelukokonaisuudet
Palvelukokonaisuus on Suomi.fi-palvelutietovarannossa hallinnoitava vapaavalintainen kokoelma palveluita. Palvelukokonaisuuksien alle voi niputtaa samaan teemaan liittyviä palveluita ja asiointikanavia omasta tai muiden organisaatioista. Palvelukokonaisuutta hyödynnetään esim. portaaleissa pikavalikoiden käytössä tai teemasivujen sisällön hallinnassa "tässä on kaikki teemaan NN liittyvät palvelut".
Palvelukokonaisuuksia voi hyödyntää myös AuroraAI-palvelusuosittelussa. Suosittelujen tuloksia voidaan rajata käyttäen rajauksena haluttua palvelukokonaisuutta tai -kokonaisuuksia. Tällöin palvelukokonaisuus muodostaa eräänlaisen whitelistin (etukäteen määritettyjen sopivien palveluiden listan), josta varsinainen suosittelu (3x10d tai vapaateksti) tehdään. Palvelukokonaisuuden käyttö PTV:ssä mahdollistaa suosittelun tuloksien tiukemman rajaamisen omavalintaisiin palveluihin. Palvelukokonaisuuksien hallinta edellyttää
Kokonaisuuksia hallinnoidaan Palvelutietovarannossa, jonne tunnukset haetaan Suomi.fi-palveluhallinnasta. Palvelukokonaisuudet eivät muuta alkuperäisiä palvelukuvauksia ja ne voivat sisältää vapaasti eri organisaatioiden palveluja. Huomioitavaa: palvelukokonaisuus (kuten myös PTV:n palvelukuvaukset) tulee olla tilassa Julkaistu, jotta se toimii AuroraAI-suositteluissa.
Rajapintakutsussa palvelukokonaisuutta käytetään vastaavasti kuin muitakin rajauskenttiä. Niitä voidaan myös tarpeen mukaan yhdistää muihin rajauksiin. Esimerkkikutsussa (alla) tekstihaku on rajattu koskemaan tiettyä palvelukokonaisuutta ja lisäksi on sallittu kansalliset palvelut.
Code Block |
---|
{
"search_text": "nuorten työttömyys",
" |
Code Block |
"service_filters": { "include_national_services": falsetrue, "municipalityservice_codescollections": [ "16f7b099-3ab2-49c8-a646-9b029de85f20" ] }, "limit": 5 } |
Huom: PTV voi luoda palvelukokonaisuudelle useamman tunnisteen. Rajaus toimii kiinteällä PTV-tunnisteella.
Aluerajaukset
Suosittelujen tulokset voidaan aluerajauksia hyödyntäen rajata sisältämään vain tietyllä alueella saatavilla olevia palveluita. Aluerajauksia voidaan yhdistellä toisiinsa esimerkiksi hakemalla palveluita tietystä kunnasta ja tietystä maakunnasta. Poikkeuksen muodostaa only_national_services -kenttä, jota ei voi yhdistää muihin aluerajauksiin. Sillä voidaan hakea vain kansallisesti saatavilla olevia palveluita, jos esimerkiksi ei tiedetä käyttäjän sijaintia. Aluerajausten yhdistelmät on kuvattu tarkemmin taulukoissa alla. Rajapinnassa kentät näyttävät seuraavilta:
Code Block |
---|
"service_filters": { 091", "638"only_national_services": false, ] "include_national_services": true, "regionmunicipality_codes": [ "02091", "19638" ], "hospitalregion_district_codes": [ "0402", "1219" ], "servicehospital_district_classescodes": [ "http://uri.suomi.fi/codelist/ptv/ptvserclass2/code/P1.204", "http://uri.suomi.fi/codelist/ptv/ptvserclass2/code/P25.312" ] }, |
...
} |
Käytetyt numeromuotoiset koodit kunnille, maakunnille ja sairaanhoitopiireille löydät Yhteentoimivuusalustalta:
...
Sairaanhoitopiirien koodit 2022: https://koodistot.suomi.fi/codescheme;registryCode=jhs;schemeCode=sairaanhoitop_1_20220101
Palveluluokkarajaukset
Aluerajausten lisäksi tuloksia voidaan rajata hyödyntäen julkisten palvelujen palveluluokkia. Rajapinta ottaa vastaan listan halutuista pää- ja alaluokista ja palauttaa vain kyseisiin palveluluokkiin kuuluvia palveluita. Palveluluokat rajataan listalla URI-koodeja, jotka löytyvät Yhteentoimivuusalustalta.
...
Aluerajausten yhdistelmät
Taulukossa on esitelty millaisia tuloksia suosittelijat antavat aluerajauksen ja muiden rajausten yhdistelmillä
(tässä esimerkissä palveluluokka, kohderyhmät ja palvelukokonaisuudet toimivat vastaavasti).
case | include_national | municipality_codes | service_class | Tulos |
---|---|---|---|---|
1 | ei annettu | ei annettu | ei annettu | Suositteluja kaikista palveluista |
2 | false | ei annettu | ei annettu | Kaikista ei-valtakunnallisista |
3 | true | ei annettu | ei annettu | Suositteluja kaikista palveluista |
4 | false |
| ei annettu | Suositteluja kunnista 1,2,3 |
5 | true |
| ei annettu | Valtakunnallisista ja kunnista 1,2,3 |
6 | ei annettu |
| ei annettu | Valtakunnallisista ja kunnista 1,2,3 |
7 | ei annettu | ei annettu |
| kaikista kunnista ja valtakunnallisista, mutta vain luokasta P1.2 |
8 | true | ei annettu |
| kaikista kunnista ja valtakunnallisista, mutta vain luokasta P1.2 |
9 | false | ei annettu |
| Kaikista ei-valtakunnallisista luokassa P1.2 |
10 | false |
|
| Kuntien 1,2,3 palvelut luokassa P1.2 |
Vain valtakunnallisiin palveluihin rajaaminen
Suosittelija voidaan rajata pelkkiin valtakunnallisiin palveluihin, jolloin muut aluerajaukset eivät ole käytettävissä.
Alla on eritelty Only_national_services -kentän yhdistäminen muihin rajauksiin. Huomaa virheet, jos kenttää yritetään yhdistää muihin aluerajauksiin.
Only_national_services | Toinen annettu rajaus | Tulos |
---|---|---|
true | municipality_codes | 400 virhe only_national_services selected. municipality_codes not allowed. |
true | region_codes | 400 virhe |
true | hospital_district_codes | 400 virhe only_national_services selected. hospital_district_codes not allowed. |
true | wellbeing_service_county_codes | 400 virhe only_national_services selected. wellbeing_service_county_codes not allowed. |
true | include_national_services | 400 virhe only_national_services selected. include_national_services not allowed. |
true | service_classes | Valtakunnallisia palveluita annetuista palveluluokista |
true | target_groups | Valtakunnallisia palveluita, joilla annettu kohderyhmätieto |
true | service_collections | Valtakunnallisiapalveluita annetuista palvelukokonaisuuksista |
true | funding_type | Valtakunnallisia palveluita, joilla annettu rahoitustyyppi |