向量Embeddings

更新时间：2025-01-21

本文介绍了向量Embeddings V2版本相关API及使用。

功能介绍

根据输入内容生成对应的向量表示。

支持模型列表

模型名称	model 参数值
tao-8k	tao-8k
Embedding-V1	embedding-v1
bge-large-zh	bge-large-zh
bge-large-en	bge-large-en

注意事项

（1）本文API，支持预置服务对应API和平台训练模型调用API。
（2）针对平台训练调用API，调用本文API前，需先经过SFT模型训练后发布服务，相关内容请参考新手指南-平台使用快速开始。

鉴权说明

调用本文API，需使用API Key鉴权方式。使用API Key鉴权调用API流程，具体调用流程，请查看认证鉴权。

请求结构

Bash

POST /v2/embeddings HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
{
   "model": "embedding-v1" 
   "input":["White T-shirt"]
   
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名	类型	必填	描述
model	string	是	模型ID，（1）预置服务，该字段可选值参考本文支持模型列表（2）平台训练模型，可以通过查看服务地址获取该字段值，详情请查看新手指南-平台使用快速开始：model值为在创建服务时对应的API地址，如下图所示：
input	List(string)	是	输入文本以获取embeddings，说明：（1）不能为空List，List的每个成员不能为空字符串（2）针对预置服务，不同模型文本数量等限制如下： · Embedding-V1：文本数量不超过16，每个文本token数不超过384且长度不超过1000个字符 · bge-large-zh或bge-large-en：文本数量不超过16，每个文本token数不超过512且长度不超过2000个字符 · tao-8k：文本数量只能为1，文本token数不超过8192且长度不超过28000个字符
user	string	否	表示最终用户的唯一标识符
encoding_format	string	否	当前只支持float

响应头域

除公共头域外，无其它特殊头域

响应参数

名称	类型	描述
model	string	模型ID
id	string	本轮对话的id
object	string	回包类型“list”
created	int	时间戳
data	List(embedding_data)	embedding信息，data成员数和文本数量保持一致
usage	usage	token统计信息

curl --location 'https://qianfan.baidubce.com/v2/embeddings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer bce-v3/ALTAK-*********/614fb**********' \
--data '{
    "model": "embedding-v1",
    "input":["White T-shirt"]
}'

import requests
import json

def main():
    url = "https://qianfan.baidubce.com/v2/embeddings"
    
    payload = json.dumps({
        "model": "embedding-v1",
        "input":["White T-shirt"]
    })
    headers = {
        'Content-Type': 'application/json',
        'Authorization': 'Bearer bce-v3/ALTAK-*********/614fb**********'
    }
    
    response = requests.request("POST", url, headers=headers, data=payload)
    
    print(response.text)
    

if __name__ == '__main__':
    main()

响应示例

JSON

{
    "id": "as-xz2r36ena8",
    "object": "list",
    "created": 1737030777,
    "data": [
        {
            "object": "embedding",
            "embedding": [
                0.018346669152379036,
                0.009424751624464989,
                -0.009573426097631454,
                ...,
                -0.3628600239753723
            ],
            "index": 0
        }
    ],
    "model": "embedding-v1",
    "usage": {
        "prompt_tokens": 3,
        "total_tokens": 3
    }
}

错误码

如果请求错误，服务器返回的JSON文本包含以下参数。

名称	描述
code	错误码
msg	错误描述信息，帮助理解和解决发生的错误
type	错误类型

更多相关错误码，请查看推理服务V2版本错误码说明。

对话Chat

重排序Reranker

百度智能云

千帆大模型服务与开发平台ModelBuilder