Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění vector.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
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[]> }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
indexId (path) | string | Ano | The index's id. |
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
values | number[] | Ano | The query vector — exactly `dimension` values. |
top_k | integer | Ne | — |
filter | object | Ne | 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… |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
matches | object[] | Ano | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 422 · 429