hosting

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

Find the nearest vectors.

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation vector.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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.

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`indexId (path)`	`string`	Oui	The index's id.

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`values`	`number[]`	Oui	The query vector — exactly `dimension` values.
`top_k`	`integer`	Non	—
`filter`	`object`	Non	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…

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`matches`	`object[]`	Oui	—

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422 · 429

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