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ä:
| Code Block |
|---|
"service_filters": {
"include_national_services": false,
"municipality_codes": [
"091",
"638"
],
"region_codes": [
"02",
"19"
],
"hospital_district_codes": [
"04",
"12"
],
"service_classes": [
"http://uri.suomi.fi/codelist/ptv/ptvserclass2/code/P1.2",
"http://uri.suomi.fi/codelist/ptv/ptvserclass2/code/P25.3"
]
}, |
Aluerajaukset on siis jatkossa ryhmitelty yhdessä palveluluokkien kanssa service_filters-otsikon alle. Kentät eivät ole pakollisia eli minimimuutoksena rajapintakutsua päivitettäessä voidaan siirtää haluttu kuntakoodi vanhasta service_filter-kentästä uuteen service_filters-listaan. Lisätoimintoja voidaan ottaa käyttöön tarpeen mukaan.
Käytetyt numeromuotoiset koodit kunnille, maakunnille ja sairaanhoitopiireille löydät Yhteentoimivuusalustalta:
Kuntakoodit 2022: https://koodistot.suomi.fi/codescheme;registryCode=jhs;schemeCode=kunta_1_20220101
Maakuntakoodit 2022: https://koodistot.suomi.fi/codescheme;registryCode=jhs;schemeCode=maakunta_1_20220101
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.
...
| Code Block |
|---|
{
"search_text": "nuorten työttömyys",
"service_filters": {
"include_national_services": true,
"service_collections": [
"16f7b099-3ab2-49c8-a646-9b029de85f20"
]
},
"limit": 5
} |
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": {
"only_national_services": false,
"include_national_services": true,
"municipality_codes": [
"091",
"638"
],
"region_codes": [
"02",
"19"
],
"hospital_district_codes": [
"04",
"12"
]
} |
Käytetyt numeromuotoiset koodit kunnille, maakunnille ja sairaanhoitopiireille löydät Yhteentoimivuusalustalta:
Kuntakoodit 2022: https://koodistot.suomi.fi/codescheme;registryCode=jhs;schemeCode=kunta_1_20220101
Maakuntakoodit 2022: https://koodistot.suomi.fi/codescheme;registryCode=jhs;schemeCode=maakunta_1_20220101
Sairaanhoitopiirien koodit 2022: https://koodistot.suomi.fi/codescheme;registryCode=jhs;schemeCode=sairaanhoitop_1_20220101
Aluerajausten yhdistelmät
Taulukossa on esitelty millaisia tuloksia suosittelijat antavat erilaisilla yhdistelmillä aluerajauksia ja muita rajauksia (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
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 | Kansallisia palveluita annetuista palveluluokista |
| true | target_groups | Kansallisia palveluita, joilla annettu kohderyhmätieto |
| true | service_collections | Kansallisia palveluita annetuista palvelukokonaisuuksista |
| true | funding_type | Kansallisia palveluita, joilla annettu rahoitustyyppi |