hosting

GET /v1/vector/indexes/{indexId}

One vector index.

Lahat ng hosting endpoint

Pagpapatotoo

Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na vector.view; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.

Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

curl -X GET https://api.zinndigital.com/v1/vector/indexes/{indexId} \
  -H "Authorization: Bearer zdk_live_…"

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

One index belonging to this organisation. Requires `vector.view`.

Mga Parameter

PangalanUriKailanganAno ito
indexId (path)stringOoThe index's id.

Tugon

PangalanUriKailanganAno ito
idstringOo
namestringOoLower-case, hyphenated, unique within the organisation.
dimensionintegerOoThe width your embedding model emits, and the width reads return. Fixed at creation.
metricstring<cosine, l2, inner_product>OoThe distance function. Fixed at creation.
statusstring<ready, deleting>Oo
vectorsintegerOoHow many vectors the index holds.
storage_bytesintegerOoWhat the index counts for against `vector_index_gb`. A published formula rather than a physical table size, so it is reproducible: 96 bytes of row overhead, plus the stored widt…
created_atstringOo

Mga error na maibabalik ng endpoint na ito

401 · 403 · 404 · 429