embedding v2

方法

POST/GET

客户端对Embedding服务请求的操作类型

请求头

Content-Type: application/json

请求消息类型

Authorization: HMAC-SHA256 ***

鉴权

model

model_name

string

是

指定模型名称，当前支持的模型有：

• bge-large-zh：最多能处理 512 个 token，数量超长时会截断，数量不足时会做 padding。 输出 embedding 维度是 1024，类型是 float。
• bge-m3：基于 m3 模型，默认返回稠密向量和稀疏向量。最多能处理 8192 个 token，数量超长时会截断，数量不足时会做 padding。 输出稠密向量维度是 1024，类型是 float。输出稀疏向量为字典类型，k 为 Tokenizer 输出的 token，v 为这个 token 的权重。
• bge-large-zh-and-m3：基于 bge v1.5 和m3 模型，使用混合检索模式。稠密向量由 bge v1.5 抽取，稀疏向量由 bge m3 抽取。最多能处理 512 个 token，数量超长时会截断，数量不足时会做 padding。 输出稠密向量维度是 1024，类型是 float。输出稀疏向量为字典类型，k 为 Tokenizer 输出的 token，v 为这个 token 的权重。
• bge-visualized-m3：基于Visualized-BGE和m3 模型， 可对文本或图片进行单独编码，或者对文本图片对联合编码，输出1024维的稠密向量。文本token限制为8192，数量超长时会截断，数量不足时会做 padding。

params

map

否

模型参数:
return_token_usage - 返回请求消耗的token数, 默认关闭
return_dense - 返回稠密向量, 默认打开
return_sparse - 返回稀疏向量, 支持提取稀疏向量的模型默认打开, 其他模型开启了会报错

data

data_type

string

是

支持如下类型：

• text：文本
• image：图片
• text-image：文本-图片对联合编码

text

string

data_type 为 text 或 text-image时，必选

data_type=text时，直接传入文本string

image

string

data_type 为 image 或 text-image时，必选

data_type=image时，传入图片内容的base64编码

code

状态码

message

返回信息

request_id

标识每个请求的唯一标识符

data

字典类型，现在包含
{
"sentence_dense_embedding":[
[0.23, 0.54, 0.76],
...
],
"sentence_sparse_embedding":[
{'De': 0.05005, 'fin': 0.1368, 'ation': 0.04498, 'of': 0.0633, 'BM': 0.2515, '25': 0.3335},
...
],
"token_usage": {
"prompt_tokens": 8,
"completion_tokens": 0,
"total_tokens": 8 // 消耗的token数
}
}
sentence_dense_embedding 的值为二维向量，形状为[batch_size, embedding_size]
sentence_sparse_embedding 的值为列表，形状为[batch_size]，列表内的元素为字典 {"token": value}
下标一致的稠密向量和稀疏向量对应同一文本
token_usage 请求的消耗的 token 数

0

200

success

请求 Embedding 服务成功。

1000003

400

invalid request：%s

非法参数：

• 缺失必选参数, 如 model_name。
• 字段值与字段类型不匹配。

1000001

401

unauthorized

请求头中缺乏鉴权信息。

1000025

404

failed to calcTextEmbedding

请求模型服务失败：

• 模型名称不对。
• 输入类型和模型对应不上。