hosting

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

One vector index.

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението vector.view; ключ без него се отхвърля с 403, а не с 404.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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`	Да	—

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 429

GET /v1/vector/indexes/{indexId}