bge-large-en
更新时间:2025-05-09
bge-large-en是由智源研究院研发的英文版文本表示模型,可将任意文本映射为低维稠密向量,以用于检索、分类、聚类或语义匹配等任务,并可支持为大模型调用外部知识。本文介绍了相关API,本接口不限制商用。
接口描述
根据输入内容生成对应的向量表示。
在线调试
平台提供了 API在线调试平台-示例代码 ,用于帮助开发者调试接口,平台集成快速检索、查看开发文档、查看在线调用的请求内容和返回结果、复制和下载示例代码等功能,简单易用,更多内容请查看API在线调试介绍。
鉴权说明
本文API,支持2种鉴权方式。不同鉴权方式,调用方式不同,请求头域、请求参数的Query参数不同,详见本文请求说明。开发者可以选择以下任一种方式进行鉴权。
- 访问凭证access_token鉴权
- 基于安全认证AK/SK进行签名计算鉴权
请求结构
以访问凭证access_token鉴权方式为例,说明调用API请求结构,示例如下。
Bash
1POST /rpc/2.0/ai_custom/v1/wenxinworkshop/embeddings/bge_large_en?access_token=24.4a3a19b******18992 HTTP/1.1
2Host: aip.baidubce.com
3Content-Type: application/json
4
5
6{
7 "input": ["recommend some delicious food","tell me a story"]
8}
请求头域
除公共头域外,无其它特殊头域。注意:鉴权方式不同,对应请求头域不同。
请求参数
- Query参数
只有访问凭证access_token鉴权方式,需使用Query参数。
访问凭证access_token鉴权
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
access_token | string | 是 | 通过应用API Key和应用Secret Key获取的access_token,参考Access Token获取 |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
input | List(string) | 是 | 输入文本以获取embeddings。说明: (1)文本数量不超过16 (2)每个文本token数不超过512且长度不超过2000个字符 (3)输入文本不能为空,如果为空会报错 |
user_id | string | 否 | 表示最终用户的唯一标识符 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
id | string | 本轮对话的id |
object | string | 回包类型,固定值“embedding_list” |
created | int | 时间戳 |
data | List(embedding_data) | embedding信息,data成员数和文本数量保持一致 |
usage | usage | token统计信息,token数 = 汉字数+单词数*1.3 (仅为估算逻辑) |
embedding_data说明
名称 | 类型 | 描述 |
---|---|---|
object | string | 固定值"embedding" |
embedding | List(float64) | embedding 内容 |
index | int | 序号 |
usage说明
名称 | 类型 | 描述 |
---|---|---|
prompt_tokens | int | 问题tokens数(包含历史QA) |
total_tokens | int | tokens总数 |
请求示例
以访问凭证access_token鉴权方式为例,说明如何调用API,示例如下。
1# 步骤一,获取access_token,替换下列示例中的应用API Key与应用Secret Key
2curl 'https://aip.baidubce.com/oauth/2.0/token?grant_type=client_credentials&client_id=[应用API Key]&client_secret=[应用Secret Key]'
3
4# 步骤二,调用本文API,使用步骤一获取的access_token,替换下列示例中的”调用接口获取的access_token“
5curl -X POST https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/embeddings/bge_large_en?access_token=[步骤一调用接口获取的access_token] -d '{
6 "input": ["recommend some delicious food","tell me a story"]
7}'
1import requests
2import json
3
4def get_access_token():
5 """
6 使用应用API Key,应用Secret Key 获取access_token,替换下列示例中的应用API Key、应用Secret Key
7 """
8
9 url = "https://aip.baidubce.com/oauth/2.0/token?grant_type=client_credentials&client_id=[应用API Key]&client_secret=[应用Secret Key]"
10
11 payload = json.dumps("")
12 headers = {
13 'Content-Type': 'application/json',
14 'Accept': 'application/json'
15 }
16 response = requests.request("POST", url, headers=headers, data=payload)
17 return response.json().get("access_token")
18
19def main():
20
21 url = "https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/embeddings/bge_large_en?access_token=" + get_access_token()
22
23 payload = json.dumps({
24 "input": ["recommend some delicious food","tell me a story"]
25 })
26 headers = {
27 'Content-Type': 'application/json'
28 }
29
30 response = requests.request("POST", url, headers=headers, data=payload)
31
32 print(response.text)
33
34
35if __name__ == '__main__':
36 main()
响应示例
JSON
1HTTP/1.1 200 OK
2Date: Thu, 23 Mar 2023 03:12:03 GMT
3Content-Type: application/json;charset=utf-8
4Statement: AI-generated
5
6{
7 "id": "as-gjs275mj6s",
8 "object": "embedding_list",
9 "created": 1687155816,
10 "data": [
11 {
12 "object": "embedding",
13 "embedding": [
14 0.018314670771360397,
15 0.00942440889775753,
16 ...(1024 float64 in total)
17 -0.36294862627983093
18 ],
19 "index": 0
20 },
21 {
22 "object": "embedding",
23 "embedding": [
24 0.12250778824090958,
25 0.07934671640396118,
26 ...(1024 float64 in total)
27 0
28 ],
29 "index": 1
30 }
31 ],
32 "usage": {
33 "prompt_tokens": 12,
34 "total_tokens": 12
35 }
36}
错误码
如果请求错误,服务器返回的JSON文本包含以下参数。
名称 | 描述 |
---|---|
error_code | 错误码 |
error_msg | 错误描述信息,帮助理解和解决发生的错误 |
例如Access Token失效返回以下内容,需要重新获取新的Access Token再次请求。
Plain Text
1{
2 "error_code": 110,
3 "error_msg": "Access token invalid or no longer valid"
4}
更多相关错误码,请查看错误码说明。