hosting

GET /v1/vector/indexes/{indexId}

One vector index.

所有 hosting 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 vector.view 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

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

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

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

参数

名称类型必填内容简介
indexId (path)stringThe index's id.

响应

名称类型必填内容简介
idstring
namestringLower-case, hyphenated, unique within the organisation.
dimensionintegerThe 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>
vectorsintegerHow many vectors the index holds.
storage_bytesintegerWhat 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