hosting

POST `/v1/vector/indexes/{indexId}/query`

Find the nearest vectors.

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie vector.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

curl -X POST https://api.zinndigital.com/v1/vector/indexes/{indexId}/query \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "values": <number[]> }'

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

Returns the `top_k` nearest vectors, nearest first, optionally restricted to those whose metadata contains `filter`. `distance` is in the index's own metric, so smaller is always nearer whichever metric you chose. ⛔ A query **spends the plan's monthly query allowance**, which is why it requires `vector.manage` rather than `vector.view` — a read that costs money is not a read.

Parametry

Nazwa	Typ	Wymagane	Co to jest
`indexId (path)`	`string`	Tak	The index's id.

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`values`	`number[]`	Tak	The query vector — exactly `dimension` values.
`top_k`	`integer`	Nie	—
`filter`	`object`	Nie	Restrict the search to vectors whose metadata contains these keys and values. Containment, not equality of the whole object, so a filter naming one key matches a vector carrying…

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`matches`	`object[]`	Tak	—

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422 · 429

POST /v1/vector/indexes/{indexId}/query