身份验证
请将 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) | 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