hosting

GET /v1/vector/indexes/{indexId}

One vector index.

Semua titik akhir hosting

Autentikasi

Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin vector.view; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.

Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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

Parameter

NamaJenisWajibTentang apa ini
indexId (path)stringYaThe index's id.

Tanggapan

NamaJenisWajibTentang apa ini
idstringYa
namestringYaLower-case, hyphenated, unique within the organisation.
dimensionintegerYaThe width your embedding model emits, and the width reads return. Fixed at creation.
metricstring<cosine, l2, inner_product>YaThe distance function. Fixed at creation.
statusstring<ready, deleting>Ya
vectorsintegerYaHow many vectors the index holds.
storage_bytesintegerYaWhat 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_atstringYa

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 429