CreateIndex 用于为指定的数据集 Collection 创建索引 Index。
创建索引可以加速向量的相似度搜索，它根据指定的索引算法和数据结构将向量库中的原始数据进行分组排序，提高相似度搜索的效率和准确性，是驱动向量数据库在短时间内筛选出候选的核心所在。
对于索引的数据集只存在稠密向量（即 Vector 类型字段）的情况，我们称这种索引为纯稠密索引；对于索引的数据集中存在稠密向量和稀疏向量（Vector 和 Sparse_Vector 类型字段）的情况，我们称这种索引为混合索引。

ShardConfig

type ShardConfig =
  | {
      ShardPolicy: ShardPolicy.Custom;
      ShardCount: number;
    }
  | {
      ShardPolicy: ShardPolicy.Auto;
    };

IndexType

enum IndexType {
  Hnsw = "hnsw",
  HnswHybrid = "hnsw_hybrid",
  Flat = "flat",
  Ivf = "ivf",
  Diskann = "diskann",
}

Distance

enum Distance {
  Ip = "ip",
  l2 = "l2",
  Cosine = "cosine",
}

Quant

enum Quant {
  Int8 = "int8",
  Float = "float",
  Fix16 = "fix16",
  PQ = "pq",
}

VectorIndex

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

HnswVector1

HnswVector2

HnswHybridVector1

HnswHybridVector2

FlatVector1

FlatVector2

DiskannVector

IvfVector

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

import { vikingdb } from '@volcengine/openapi'

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

await service.index.CreateIndex({
  CollectionName: 'test_collection_1',
  IndexName: 'test_index_1',
  Description: 'Index Description', // optional
  CpuQuota: 2, // optional
  ShardConfig: {
    ShardPolicy: vikingdb.index.ShardPolicy.Custom,
    ShardCount: 10
  }, // 自定义分片
  ShardConfig: {
    ShardPolicy: vikingdb.index.ShardPolicy.Auto,
  }, // 自动分片
  VectorIndex: {
    IndexType: vikingdb.index.IndexType.Hnsw,
    Distance: vikingdb.index.Distance.Ip,
    Quant: vikingdb.index.Quant.Int8,
    HnswM: 10, // optional
    HnswCef: 10, // optional
    HnswSef: 10, // optional
  }, // optional，HnswVector1
  VectorIndex: {
    IndexType: vikingdb.index.IndexType.Hnsw,
    Distance: vikingdb.index.Distance.l2,
    Quant: vikingdb.index.Quant.Float,
    HnswM: 10, // optional
    HnswCef: 10, // optional
    HnswSef: 10, // optional
  }, // optional，HnswVector2
  VectorIndex: {
    IndexType: vikingdb.index.IndexType.HnswHybrid,
    Distance: vikingdb.index.Distance.Cosine,
    Quant: vikingdb.index.Quant.Int8,
  }, // optional，HnswHybridVector1
  VectorIndex: {
    IndexType: vikingdb.index.IndexType.HnswHybrid,
    Distance: vikingdb.index.Distance.L2,
    Quant: vikingdb.index.Quant.Float,
  }, // optional，HnswHybridVector2  
  VectorIndex: {
    IndexType: vikingdb.index.IndexType.Flat,
    Distance: vikingdb.index.Distance.Ip,
    Quant: vikingdb.index.Quant.Int8,
  }, // optional，FlatVector1    
  VectorIndex: {
    IndexType: vikingdb.index.IndexType.Flat,
    Distance: vikingdb.index.Distance.l2,
    Quant: vikingdb.index.Quant.Float,
  }, // optional，FlatVector2
  VectorIndex: {
    IndexType: vikingdb.index.IndexType.Diskann,
    Distance: vikingdb.index.Distance.Ip,
    Quant: vikingdb.index.Quant.Pq,
    DiskannM: 10, // optional
    DiskannCef: 10, // optional
    CacheRatio: 10, //optional
    PqCodeRatio: 10, //optional
  }, // optional，DiskannVector  
  VectorIndex: {
    IndexType: vikingdb.index.IndexType.Ivf,
    Distance: vikingdb.index.Distance.Ip,
    Quant: vikingdb.index.Quant.Pq,
  }, // optional，IvfVector  
  PartitionBy: 'Id', // optional
  Scalarindexes: ['Name'], // optinal
})