GetIndexInfo--向量数据库VikingDB-火山引擎

文档中心

导航

GetIndexInfo

最近更新时间：2024.09.06 10:30:14首次发布时间：2024.06.14 11:34:52

概述

GetIndexInfo 用于查询索引 Index 详情。

请求参数

字段名	类型	是否必传	说明
CollectionName	`string`	是	数据集名称
IndexName	`string`	是	索引名称

响应参数

declare class GetIndexInfoResponse {
  readonly IndexInfo: IndexInfo;
  readonly OriginalRequest: string;
  readonly LogId: string;
  constructor(
    IndexInfo: IndexInfo,
    OriginalRequest: string,
    LogId: string
  );
}

IndexInfo

字段名	类型	是否必传	说明
CollectionName	`string`	是	数据集名称
IndexName	`string`	是	索引名称
CpuQuota	`number`	是	索引使用 CPU 用量
Description	`string`	否	索引描述
ShardPolicy	`ShardPolicy`	是	索引分片策略
ShardCount	`number`	是	索引分片数
PartitionBy	`string`	否	子索引划分字段
Partitions	`string[]`	否	子索引，当且仅当配置了子索引划分字段时才存在
VectorIndex	`VectorIndex`	否	向量索引配置
ScalarIndex	`ScalarFieldInfo`	否	标量过滤字段
Stat	`IndexStatus`	是	索引状态
IndexCost	`IndexCost`	是	索引使用资源
CreateTime	`string`	是	索引创建时间
UpdateTime	`string`	是	索引更新时间
UpdatePerson	`string`	是	索引更新人

ShardPolicy

enum ShardPolicy {
  Custom = "custom",
  Auto = "auto",
}

VectorIndex

type VectorIndex = 
    | HnswVector
    | HnswHybridVector 
    | FlatVector 
    | DiskannVector 
    | IvfVector
    
type HnswVector = HnswVector1 | HnswVector2
type HnswHybridVector = HnswHybridVector1 | HnswHybridVector2
type FlatVector = FlatVector1 | FlatVector2

HnswVector1

字段名	类型	是否必传	说明
IndexType	`IndexType.Hnsw`	是	索引类型
Distance	`Distance.Ip` `Distance.Cosine`	是	距离类型
Quant	`Quant.Int8` `Quant.Float` `Quant.Fix16`	是	量化方式
HnswM	`number`	否	Hnsw 索引参数，表示邻居节点个数
HnswCef	`number`	否	Hnsw 索引参数，表示构建图时搜索邻居节点的广度
HnswSef	`number`	否	Hnsw 索引参数，表示线上检索的搜索广度

HnswVector2

字段名	类型	是否必传	说明
IndexType	`IndexType.Hnsw`	是	索引类型
Distance	`Distance.l2`	是	距离类型
Quant	`Quant.Float` `Quant.Fix16`	是	量化方式
HnswM	`number`	否	Hnsw 索引参数，表示邻居节点个数
HnswCef	`number`	否	Hnsw 索引参数，表示构建图时搜索邻居节点的广度
HnswSef	`number`	否	Hnsw 索引参数，表示线上检索的搜索广度

HnswHybridVector1

字段名	类型	是否必传	说明
IndexType	`IndexType.HnswHybrid`	是	索引类型
Distance	`Distance.Ip` `Distance.Cosine`	是	距离类型
Quant	`Quant.Int8` `Quant.Float` `Quant.Fix16`	是	量化方式

HnswHybridVector2

字段名	类型	是否必传	说明
IndexType	`IndexType.HnswHybrid`	是	索引类型
Distance	`Distance.l2`	是	距离类型
Quant	`Quant.Float` `Quant.Fix16`	是	量化方式

FlatVector1

字段名	类型	是否必传	说明
IndexType	`IndexType.Flat`	是	索引类型
Distance	`Distance.Ip` `Distance.Cosine`	是	距离类型
Quant	`Quant.Int8` `Quant.Float` `Quant.Fix16`	是	量化方式

FlatVector2

字段名	类型	是否必传	说明
IndexType	`IndexType.Flat`	是	索引类型
Distance	`Distance.l2`	是	距离类型
Quant	`Quant.Float` `Quant.Fix16`	是	量化方式

DiskannVector

字段名	类型	是否必传	说明
IndexType	`IndexType.Diskann`	是	索引类型
Distance	`Distance`	是	距离类型
Quant	`Quant.Float` `Quant.Pq`	是	量化方式
DiskannM	`number`	否	Diskann 参数，表示邻居节点个数
DiskannCef	`number`	否	Diskann 参数，表示构建图时搜索邻居节点的广度
CacheRatio	`number`	否	Diskann 参数，缓存节点数与原始数据的比率
PqCodeRatio	`number`	否	Diskann 参数，向量维度编码的大小限制

IvfVector

字段名	类型	是否必传	说明
IndexType	`IndexType.Ivf`	是	索引类型
Distance	`Distance.Ip` `Distance.Cosine`	是	距离类型
Quant	`Quant.Pq`	是	量化方式

ScalarFieldInfo 标量字段

字段名	类型	是否必传	说明
FieldName	`string`	是	字段名
FieldType	`FieldType.Int64` `FieldType.Float32` `FieldType.String` `FieldType.Boolean` `FieldType.ListString` `FieldType.ListInt64`	是	字段类型
DefaultValue	`number` `string` `boolean` `string[]` `number[]`	否	字段默认值，类型需要与传入的 FieldType 对齐

IndexStatus

type IndexStatus = "INIT" | "CHANGING" | "READY";

IndexCost

字段名	类型	是否必传	说明
CpuCore	`number`	是	占用 CPU 和数
MemoryGb	`string`	是	占用内存量

参考示例

import { vikingdb } from '@volcengine/openapi'

declare const service: vikingdb.VikingdbService // 替换为你初始化好的实例

const response = await service.index.GetIndexInfo({
  CollectionName: 'test_collection_1',
  IndexName: 'test_index_1',
})

console.log(response.IndexInfo) // 索引详情信息