Embedding用于将非结构化数据向量化，通过深度学习神经网络提取文本、图片、音视频等非结构化数据里的内容和语义，把文本、图片、音视频等变成特征向量。
说明
Embedding 有两个参数，分别是 ModelParams 和 DataParams[]。
字段名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
ModelName |
| 是 | 使用模型名称 |
ReturnTokenUsage |
| 否 | 是否返回消耗 token 数 |
ReturnDense |
| 否 | 是否返回稠密向量 |
ReturnSparse |
| 否 | 是否返回稀疏向量 |
type ModelName = "bge-large-zh" | "bge-m3" | "bge-large-zh-and-m3" | "bge-visualized-m3"
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", }
字段名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
DataType |
| 是 | 数据类型 |
Text |
| 是 | 文本数据 |
字段名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
DataType |
| 是 | 数据类型 |
Image |
| 是 | 图片 base64 编码 |
字段名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
DataType |
| 是 | 数据类型 |
Image |
| 是 | 图片 base64 编码 |
Text |
| 是 | 文本数据 |
declare class EmbeddingResponse { readonly Result: EmbeddingResult[]; readonly OriginalRequest: string; readonly LogId: string; constructor( Result: EmbeddingResult[], OriginalRequest: string, LogId: string ); }
字段值根据传入的 ModelParams 决定。
字段名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
SentenceDenseEmbedding |
| 否 | 稠密向量 |
SentenceSparseEmbedding |
| 否 | 稀疏向量 |
TokenUsage |
| 否 | 资源用量 |
字段名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
PromptTokens |
| 是 | |
CompletionTokens |
| 是 | |
TotalTokens |
| 是 |
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 结果