Filtrowanie i doprecyzowanie wyszukiwania
Zawęż wyszukiwanie dokumentów za pomocą filtrów źródła, dostawcy i daty, a następnie przeczytaj wyniki uszeregowane pod względem trafności.
/documents/search przeszukuje pełnotekstowo tytuły i treść twoich dokumentów, a następnie zwraca najlepsze dopasowania, każde z wynikiem trafności oraz dokumentem źródłowym, z którego pochodzi. Ten przewodnik pokazuje, jak zawęzić te wyniki za pomocą filtrów oraz jak odczytać odpowiedź.
Żądanie
Wymagany jest tylko query. Wszystko inne zawęża lub ogranicza wyniki.
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"
}'| Pole | Typ | Uwagi |
|---|---|---|
query | string | Wymagane. Od 1 do 500 znaków. |
limit | integer | Opcjonalne. Od 1 do 50. Ilość wyników do zwrócenia (domyślna wartość, jeśli pominięte). |
datasource | string | Opcjonalne. Ogranicza do jednego źródła danych (do 100 znaków). |
sourceProvider | string | Opcjonalne. Ogranicza do jednego dostawcy konektora, np. źródła, z którego zsynchronizowano dokument. |
createdAfter | string | Opcjonalne. Znacznik czasu ISO 8601; tylko dokumenty utworzone w tym czasie lub później. |
createdBefore | string | Opcjonalne. Znacznik czasu ISO 8601; tylko dokumenty utworzone przed tym czasem. |
Każdy filtr jest łączony za pomocą AND: dokument musi pasować do zapytania oraz każdego dostarczonego filtra. Pominięcie filtra poszerza wyszukiwanie.
Odpowiedź
{
"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
}Każdy wynik zawiera snippet z pasującym tekstem, score od 0 do 1 (wyższa wartość oznacza większą trafność) oraz metadane dokumentu źródłowego, dzięki którym możesz go prześledzić. totalCount to całkowita liczba dopasowanych dokumentów, która może być większa niż liczba results, o którą poprosiłeś za pomocą limit.
Odczytywanie wyników
- Wyniki są sortowane według trafności, najbardziej trafne jako pierwsze. Użyj
score, aby ustalić próg odcięcia, jeśli zależy ci tylko na silnych dopasowaniach. totalCountvsresults.length:resultszawiera dolimitelementów;totalCountto pełna liczba dopasowań. JeślitotalCountjest znacznie większe niż twójlimit, zaostrzquerylub dodaj filtr, zamiast oczekiwać wszystkich dopasowań w jednym wywołaniu.- Tylko zindeksowane dokumenty są przeszukiwalne. Dokument z
statuso wartościprocessinglubfailednie jest jeszcze dostępny; zobacz Dokumenty i wyszukiwanie, aby poznać cykl życia.
Wyszukiwanie zwraca tylko dokumenty, do których masz uprawnienia. Kontrola dostępu odbywa się na poziomie warstwy danych, a nie w kodzie aplikacji, więc filtr nigdy nie poszerzy twojej widoczności poza własne dokumenty.