Embedding用于将非结构化数据向量化，通过深度学习神经网络提取文本、图片、音视频等非结构化数据里的内容和语义，把文本、图片、音视频等变成特征向量。

Embedding 有两个参数，分别是 ModelParams 和 DataParams[]。

ModelParams

ModelName

type ModelName = "bge-large-zh" | "bge-m3" | "bge-large-zh-and-m3" | "bge-visualized-m3"

DataParams

type DataParams = TextDataParams | ImageDataParams | TextImageDataParams

enum DataType {
  Text = "text",
  Image = "image",
  TextImage = "text-image",
}

type DataParams = TextDataParams | ImageDataParams | TextImageDataParams

enum DataType {
  Text = "text",
  Image = "image",
  TextImage = "text-image",
}

TextDataParams

ImageDataParams

TextImageDataParams

declare class EmbeddingResponse {
  readonly Result: EmbeddingResult[];
  readonly OriginalRequest: string;
  readonly LogId: string;
  constructor(
    Result: EmbeddingResult[],
    OriginalRequest: string,
    LogId: string
  );
}

EmbeddingResult

字段值根据传入的 ModelParams 决定。

TokenUsage

import { vikingdb } from '@volcengine/openapi'

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

const response await service.embedding.Embedding({
  ModelName: 'bge-large-zh',
  ReturnTokenUsage: true, // optional，传入该字段则返回值类型也会有该字段
  ReturnDense: true, // optional，传入该字段则返回值类型也会有该字段
  ReturnSparse: true, // optional，传入该字段则返回值类型也会有该字段
})

console.log(response.Result) // 获取 Embedding 结果