hosting

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

Find the nearest vectors.

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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[]`	Да	—

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422 · 429

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