embedding_v2--向量数据库VikingDB-火山引擎

文档中心

导航

embedding_v2

最近更新时间：2024.11.07 12:02:39首次发布时间：2024.04.17 14:21:07

概述

embedding_v2是 embedding 接口的较新版本，建议使用此接口进行向量化处理。 embedding用于将非结构化数据向量化，通过深度学习神经网络提取文本、图片、音视频等非结构化数据里的内容和语义，把文本、图片、音视频等变成特征向量。
异步调用使用async_embedding_v2接口，参数不变。

说明

当前 Embedding 服务支持将文本/图片生成向量。
当前 Embedding 服务接口不支持承载高并发请求，请求数量过多时请求会被丢弃。
图片大小：建议图片大小不要超过1MB，因embedding v2接口的请求限制为4M，当图片超过1MB时，我们建议用户压缩图片后再次请求，防止接口截断；
图片压缩尺寸推荐：经过我们的实验，将图片的长和宽分别缩放到自身的0.30-0.35倍，可以得到与原图embedding较为相近的结果。其中，0.30-0.35倍是缩放的拐点，比例再低的话精度劣化会比较明显，缩放比例可以在拐点以上。

请求参数

参数	子参数	类型	是否必选	说明
emb_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。
emb_model	params	map	否	return_token_usage - 返回请求消耗的token数, 默认关闭 return_dense - 返回稠密向量, 默认打开 return_sparse - 返回稀疏向量, 支持提取稀疏向量的模型默认打开, 其他模型开启了会报错
raw_data 说明 RawData 实例或者列表，最大 100 个。	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编码

示例

请求参数

list = [RawData("text", "hello1"), RawData("text", "hello2")]
res = vikingdb_service.embedding_v2(EmbModel("bge-m3", params={"return_token_usage": True}), list)
print(res)

# 异步调用
async def embedding_v2():
    list = [RawData("text", "hello1"), RawData("text", "hello2")]
    res = await vikingdb_service.async_embedding_v2(EmbModel("bge-m3"), list)
    print(res)
asyncio.run(embedding_v2())

返回值

Python 调用执行上面的任务，返回 list<float> 、list<list<float>> 类型的向量。