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 زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول 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