hosting

GET `/v1/vector/indexes/{indexId}`

One vector index.

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د vector.view اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ

تفصیلات

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

پارامترونه

نوم	ډول	اړین	دا څه شی دی
`indexId (path)`	`string`	هو	The index's id.

ځواب

نوم	ډول	اړین	دا څه شی دی
`id`	`string`	هو	—
`name`	`string`	هو	Lower-case, hyphenated, unique within the organisation.
`dimension`	`integer`	هو	The width your embedding model emits, and the width reads return. Fixed at creation.
`metric`	`string<cosine, l2, inner_product>`	هو	The distance function. Fixed at creation.
`status`	`string<ready, deleting>`	هو	—
`vectors`	`integer`	هو	How many vectors the index holds.
`storage_bytes`	`integer`	هو	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_at`	`string`	هو	—

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404 · 429

GET /v1/vector/indexes/{indexId}