Suodata ja tarkenna hakua
Tarkenna asiakirjahakua lähteen, tarjoajan ja päivämäärän suodattimilla ja lue järjestetyt tulokset.
/documents/search suorittaa täystekstihakuja dokumenttiesi otsikoissa ja sisällöissä ja palauttaa parhaat osumat, joista jokaisessa on relevanssipisteet ja lähdedokumentti, josta se on peräisin. Tämä opas näyttää, miten voit rajata näitä tuloksia suodattimilla ja miten vastaus luetaan.
Pyyntö
Vain query on pakollinen. Kaikki muu rajaa tai määrittää tuloksia.
curl https://nordvec.com/api/v1/documents/search \
-H "Authorization: Bearer $NORDVEC_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "renewal terms",
"limit": 20,
"datasource": "contracts",
"sourceProvider": "google_drive",
"createdAfter": "2026-01-01T00:00:00Z",
"createdBefore": "2026-07-01T00:00:00Z"
}'| Kenttä | Tyyppi | Huomautukset |
|---|---|---|
query | merkkijono | Pakollinen. 1–500 merkkiä. |
limit | kokonaisluku | Valinnainen. 1–50. Kuinka monta tulosta palautetaan (oletusarvoa käytetään, jos jätetään pois). |
datasource | merkkijono | Valinnainen. Rajaa yhteen tietolähteeseen (enintään 100 merkkiä). |
sourceProvider | merkkijono | Valinnainen. Rajaa yhteen liittimen tarjoajaan, esim. lähteeseen, josta dokumentti synkronoitiin. |
createdAfter | merkkijono | Valinnainen. ISO 8601 -aikaleima; vain dokumentit, jotka on luotu aikaleiman jälkeen tai sen hetkellä. |
createdBefore | merkkijono | Valinnainen. ISO 8601 -aikaleima; vain dokumentit, jotka on luotu ennen aikaleimaa. |
Jokainen suodatin yhdistetään AND-operaattorilla: dokumentin on vastattava hakua ja kaikkia antamiasi suodattimia. Jätä suodatin pois laajentaaksesi hakua.
Vastaus
{
"results": [
{
"id": "…",
"title": "Acme Corp Master Services Agreement",
"snippet": "…renews automatically for successive twelve month terms…",
"score": 0.82,
"datasource": "contracts",
"source_provider": "google_drive",
"source_type": "…",
"mime_type": "application/pdf",
"status": "indexed",
"created_at": "2026-02-14T09:00:00Z",
"updated_at": "2026-02-14T09:00:00Z"
}
],
"totalCount": 7
}Jokainen tulos sisältää snippet:n, jossa on osuva teksti, score:n välillä 0–1 (suurempi luku tarkoittaa suurempaa relevanssia) ja lähdedokumentin metatiedot, jotta voit jäljittää sen. totalCount kertoo, kuinka monta dokumenttia vastasi hakua yhteensä, mikä voi olla suurempi kuin results:iden määrä, jonka pyysit limit:lla.
Tulosten lukeminen
- Tulokset on järjestetty relevanssin mukaan, tärkeimmät ensin. Käytä
score:tä päättääksesi katkaisukohdan, jos haluat vain vahvat osumat. totalCountvsresults.length:resultssisältää enintäänlimitkohdetta;totalCounton täydellinen osumamäärä. JostotalCounton paljon suurempi kuinlimit, tiukennaquery:tä tai lisää suodatin sen sijaan, että odottaisit kaikkien osumien palautuvan yhdellä kutsulla.- Vain indeksoidut dokumentit ovat haettavissa. Dokumenttia, jonka
statusonprocessingtaifailed, ei ole vielä haettavissa. Katso lisätietoja dokumenttien elinkaarestä kohdasta Dokumentit ja haku.
Haku palauttaa aina vain dokumentit, joihin sinulla on oikeus nähdä. Pääsyoikeuksia valvotaan tietokerroksessa, ei sovelluskoodissa, joten suodatin ei voi koskaan laajentaa näkyvyyttäsi omiin dokumentteihisi laajemmaksi.