Hopp til hovudinnhald

KI-søk API

KI-søket brukar metadata frå Data.norge.no og hjelper deg med å finne datasett, API-ar, omgrep, informasjonsmodellar, tenester og hendingar ved hjelp av kunstig intelligens. Tenesta som er ansvarleg for å handtere KI-søk er fdk-llm-search-service(Github).

Viktig: Dette API-et er laga for intern bruk på Data.norge.no og kan bli endra over tid. Vi tilrår ikkje å bruke det dersom du er avhengig av stabilitet og konsistens.

Endepunkt i ulike miljø

Dokumentasjon

OpenAPI-spesifikasjon for KI-søkjeendepunktet (Swagger)

Slik får du tilgang

API-et er ope for offentleg bruk og krev ingen autentisering. Du kan byrje å nytte endepunktet med ein gong.

Hastigheitsavgrensing

API-et har hastigheitsavgrensing (rate limiting) konfigurert for å sikre stabil drift. Avgrensningane er:

  • 10 førespurnader per minutt (requests per minute)
  • Burst-grense på 20 førespurnader (2x multiplikator)

Viss du overskrid desse grensene, vil du motta ein HTTP 429 (Too Many Requests) respons.

Utforming av spørjingar

KI-søket let deg stille spurnader i naturleg språk. I eksempelet under har vi stilt spurnaden "Kva område i Noreg er verna?". KI-søket vil tolke spurnaden og finne relevante ressursar basert på metadata. Utan feltet type søkjer det berre i datasett.

query må vere mellom 3 og 255 teikn. Kortare eller lengre spørjingar gjev HTTP 400.

Typisk responstid er rundt 5 sekund. Embeddingsøket er avgrensa til om lag 10 kandidatar; KI-filteret returnerer vanlegvis færre treff.

curl -X POST 'https://aisearch.api.demo.fellesdatakatalog.digdir.no/llm' \ -H 'Content-Type: application/json' \ -d '{"query":"Kva område i Noreg er verna?"}'

Naturleg språk

I motsetning til standard søk, kan du bruka naturleg språk i KI-søket. Du treng ikkje kjenne til spesifikke ressursnamn, fagomgrep eller tekniske format.

Tenesta er primært tilpassa norsk. Metadataoppsummeringane som det vert søkt i, er på norsk, og forklaringane i svara vert gjevne på norsk. Engelske spurnader kan fungere, men svarteksten vil likevel vere på norsk.

Døme på spurnader:

  • "Kva datasett handlar om miljøvern?"
  • "Finn omgrep om sjukefråvær"
  • "Vis meg API-ar om vegtrafikk i Oslo"
curl -X POST 'https://aisearch.api.demo.fellesdatakatalog.digdir.no/llm' \ -H 'Content-Type: application/json' \ -d '{"query":"Finn data om sjukefråvær i offentleg sektor"}'

Ressurstypar

Du kan avgrense søket til éin ressurstype med det valfrie feltet type. Viss type ikkje er oppgitt, er standardverdien DATASET — søket gjeld då berre datasett. Bruk ALL for å søkje på tvers av alle ressurstypar.

VerdiRessurstype
DATASETDatasett (standard)
DATA_SERVICEAPI-ar
CONCEPTOmgrep
INFORMATION_MODELInformasjonsmodellar
SERVICETenester
EVENTHendingar
ALLAlle ressurstypar
curl -X POST 'https://aisearch.api.demo.fellesdatakatalog.digdir.no/llm' \ -H 'Content-Type: application/json' \ -d '{"query":"Finn omgrep om sjukefråvær","type":"CONCEPT"}'

Svarformat

Svaret er eit JSON-objekt med lista hits. Kvart treff har desse felta:

FeltSkildring
idIdentifikatoren til ressursen
titleTittelen på ressursen
descriptionKI-generert forklaring (Markdown) på kvifor ressursen passar — ikkje katalogskildringa
typeRessurstype, til dømes DATASET eller CONCEPT
publisherNamn på utgjevar
publisherIdIdentifikator for utgjevar

Illustrativt døme på svarformat (ikkje ekte katalogdata):

{ "hits": [ { "id": "<resource-id>", "title": "Eksempelressurs", "description": "Denne ressursen passar til spurnaden fordi den handlar om …", "type": "DATASET", "publisher": "Eksempelutgjevar", "publisherId": "<publisher-id>" } ] }

Lagring av spørjingar

Alle spørjingar vert lagra (tekst, tal på treff og om spørjinga er vurdert som sensitiv) for å analysere søkjemønster og forbetre tenesta. Spørjingane vert lagra utan brukar- eller sesjonsidentifikatorar. Unngå å sende personopplysningar i query.

Fann du det du leitte etter?

Ta kontakt med oss her, eller spør om hjelp i Datalandsbyen.