向量 Embeddings

千帆 SDK 支持调用千帆大模型平台中的模型，将输入文本转化为用浮点数表示的向量形式。转化得到的语义向量可应用于文本检索、信息推荐、知识挖掘等场景。

注意事项

模型不同，调用SDK时，使用参数不同。请结合具体模型，查看参数使用说明进行调用。

• 默认模型，即Embedding-V1，调用时无需填写model参数，详情见参数说明。
• 指定支持预置服务的模型，使用model参数指定支持预置服务的模型，详情见参数说明。

支持模型列表

• Embedding-V1
• bge-large-zh
• bge-large-eh

默认模型

默认模型，即 Embedding-V1，无需使用参数model，调用示例如下。

调用示例

• Python

# Embedding 基础功能
import qianfan

# 替换下列示例中参数，应用API Key替换your_ak，Secret Key替换your_sk
emb = qianfan.Embedding(ak="your_ak", sk="your_sk")

resp = emb.do(texts=[  # 省略 model 时则调用默认模型 Embedding-V1
    "世界上最高的山"
])
print(resp['data'][0]['embedding'])

返回示例

 [0.062249645590782166, 0.05107472464442253, 0.033479999750852585, ...]

指定支持预置服务的模型

使用model字段，指定千帆平台支持预置服务的模型，调用示例如下。

请求示例

• Python

import qianfan

# 替换下列示例中参数，应用API Key替换your_ak，Secret Key替换your_sk
emb = qianfan.Embedding(ak="your_ak", sk="your_sk")

resp = emb.do(model="bge-large-zh", texts=[  # 非默认模型，需填写 model参数
    "世界上最高的山"
])
print(resp['data'][0]['embedding'])

返回示例

[-0.007796249818056822, 0.024737156927585602, 0.007977624423801899, ...]

参数说明

请求参数

名称	类型	必填	描述
model	str	否	模型名称。说明： （1）不填写此参数，默认模型为Embedding-V1 （2） 如果需指定支持预置服务的模型，此字段必填，支持模型如下： · Embedding-V1 · bge-large-en · bge-large-zh
texts	List[str]	是	填写文本
retry_count	int	否	重试次数，默认1次
request_timeout	float	否	请求超时时间，默认60秒
backoff_factor	float	否	请求重试参数，用于指定重试的策略，默认为0
user_id	str	否	表示最终用户的唯一标识符，可以监视和检测滥用行为，防止接口恶意调用

返回参数

名称	类型	描述
id	str	本轮对话的id
object	str	回包类型，固定值“embedding_list”
created	int	时间戳
data	List[EmbeddingData]	embedding信息，data成员数和文本数量保持一致
usage	Usage	token统计信息，token数 = 汉字数+单词数*1.3 （仅为估算逻辑）

EmbeddingData说明

名称	类型	描述
object	str	固定值"embedding"
embedding	List[float]	embedding 内容
index	int	序号

Usage说明

名称	类型	描述
prompt_tokens	int	问题tokens数（包含历史QA）
total_tokens	int	tokens总数