hosting

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

Find the nearest vectors.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл vector.manage; ключ без нього відхиляється з кодом 403, а не 404.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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[]> }'

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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.

Параметри

Назва	Тип	Обов'язкове	Що це таке
`indexId (path)`	`string`	Так	The index's id.

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`values`	`number[]`	Так	The query vector — exactly `dimension` values.
`top_k`	`integer`	Ні	—
`filter`	`object`	Ні	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…

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`matches`	`object[]`	Так	—

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 422 · 429

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