GetCollectionInfo 用于查询指定数据集 Collection 的详情信息。

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

CollectionInfo

FieldInfo

type FieldInfo =
  | ScalarFieldInfo
  | PrimaryKeyFieldInfo
  | DenseVectorFieldInfo
  | SparseVectorFieldInfo
  | TextFieldInfo
  
enum FieldType {
  Int64 = "int64",
  Float32 = "float32",
  String = "string",
  Boolean = "bool",
  ListString = "list<string>",
  ListInt64 = "list<int64>",
  /** 稠密向量 */
  DenseVector = "vector",
  /** 稀疏向量 */
  SparseVector = "sparse_vector",
  Text = "text",
}

type PipelineName =
  | "text_split_bge_large_zh"
  | "text_bge_large_zh"
  | "text_split_bge_m3"
  | "text_bge_m3"
  | "text_split_bge_large_and_m3"
  | "text_bge_large_and_m3"

ScalarFieldInfo 标量字段

PrimaryKeyFieldInfo 主键字段

DenseVectorFieldInfo 稠密向量字段

SparseVectorFieldInfo 稀疏向量字段

TextFieldInfo 文本字段

Stat

import { vikingdb } from '@volcengine/openapi'

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

const response = await service.collection.GetCollectionInfo({
  CollectionName: 'test_collection_1',
})

console.log(response.CollectionInfo) // 数据集详情信息