hosting

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

Find the nearest vectors.

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 vector.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

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 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 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