hosting

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

Find the nearest vectors.

Autenticación

Envía una clave de API como token de portador. La clave debe tener el permiso vector.manage; una clave que no lo tenga se rechazará con un código 403, no 404.

Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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.

Parámetros

Nombre	Tipo	Obligatorio	¿Qué es esto?
`indexId (path)`	`string`	Sí	The index's id.

Cuerpo de la solicitud

Nombre	Tipo	Obligatorio	¿Qué es esto?
`values`	`number[]`	Sí	The query vector — exactly `dimension` values.
`top_k`	`integer`	No	—
`filter`	`object`	No	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…

Respuesta

Nombre	Tipo	Obligatorio	¿Qué es esto?
`matches`	`object[]`	Sí	—

Errores que este endpoint puede devolver

401 · 403 · 404 · 422 · 429

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