Zoekopdracht filteren en verfijnen
Beperk een documentzoekopdracht met filters voor bron, aanbieder en datum, en lees de gerangschikte resultaten.
/documents/search voert een volledige tekstzoekopdracht uit in de titels en inhoud van jouw documenten en retourneert de beste overeenkomsten, elk met een relevantiescore en het brondocument waar het vandaan kwam. Deze handleiding laat zien hoe je die resultaten kunt verfijnen met filters en hoe je het antwoord kunt lezen.
Het verzoek
Alleen query is verplicht. Al het andere beperkt of bepaalt de grenzen van de resultaten.
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"
}'| Veld | Type | Opmerkingen |
|---|---|---|
query | string | Verplicht. 1 tot 500 tekens. |
limit | integer | Optioneel. 1 tot 50. Hoeveel resultaten moeten worden geretourneerd (standaardwaarde wordt toegepast als weggelaten). |
datasource | string | Optioneel. Beperk tot één datasource (maximaal 100 tekens). |
sourceProvider | string | Optioneel. Beperk tot één connectorprovider, bijvoorbeeld de bron waar een document mee gesynchroniseerd is. |
createdAfter | string | Optioneel. ISO 8601-tijdstempel; alleen documenten die op of na deze tijd zijn aangemaakt. |
createdBefore | string | Optioneel. ISO 8601-tijdstempel; alleen documenten die vóór deze tijd zijn aangemaakt. |
Elk filter wordt gecombineerd met AND: een document moet overeenkomen met de zoekopdracht en elk filter dat je opgeeft. Laat een filter weg om de zoekopdracht te verbreden.
Het antwoord
{
"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
}Elk resultaat bevat een snippet met de overeenkomende tekst, een score van 0 tot 1 (hoe hoger, hoe relevanter), en de metadata van het brondocument, zodat je het kunt terugvolgen. totalCount geeft aan hoeveel documenten in totaal overeenkwamen, wat groter kan zijn dan het aantal results dat je hebt aangevraagd met limit.
De resultaten lezen
- Resultaten zijn gerangschikt op relevantie, meest relevant eerst. Gebruik
scoreom een afkapwaarde te bepalen als je alleen sterke overeenkomsten wilt. totalCountvsresults.length:resultsbevat maximaallimititems;totalCountis het totale aantal overeenkomsten. AlstotalCountveel groter is dan jouwlimit, maak dan dequeryspecifieker of voeg een filter toe, in plaats van te verwachten dat elke overeenkomst in één aanroep wordt teruggegeven.- Alleen geïndexeerde documenten zijn doorzoekbaar. Een document met een
statusvanprocessingoffailedis nog niet opvraagbaar; zie Documenten & zoeken voor de levenscyclus.
Zoeken retourneert alleen documenten die de aanroeper mag zien. Toegang wordt afgedwongen op datalaagniveau, niet in de applicatiecode, dus een filter kan jouw zichtbaarheid nooit uitbreiden buiten jouw eigen documenten.