hosting

GET /v1/vector/indexes/{indexId}

One vector index.

Усі кінцеві точки hosting

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл vector.view; ключ без нього відхиляється з кодом 403, а не 404.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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

Параметри

НазваТипОбов'язковеЩо це таке
indexId (path)stringТакThe index's id.

Відповідь

НазваТипОбов'язковеЩо це таке
idstringТак
namestringТакLower-case, hyphenated, unique within the organisation.
dimensionintegerТакThe width your embedding model emits, and the width reads return. Fixed at creation.
metricstring<cosine, l2, inner_product>ТакThe distance function. Fixed at creation.
statusstring<ready, deleting>Так
vectorsintegerТакHow many vectors the index holds.
storage_bytesintegerТакWhat 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_atstringТак

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 429