bge-large-zh

开发环境

POST

https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/embeddings/bge_large_zh

bge-large-zh是由智源研究院研发的中文版文本表示模型，可将任意文本映射为低维稠密向量，以用于检索、分类、聚类或语义匹配等任务，并可支持为大模型调用外部知识。

Embeddings

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

在线调试

百度智能云千帆提供了 API在线调试平台-示例代码，用于帮助开发者调试接口，平台集成快速检索、查看开发文档、查看在线调用的请求内容和返回结果、复制和下载示例代码等功能，简单易用，更多内容请查看API在线调试介绍。

错误码

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

名称	描述
error_code	错误码
error_msg	错误描述信息，帮助理解和解决发生的错误

例如Access Token失效返回以下内容，需要重新获取新的Access Token再次请求。

{
  "error_code": 110,
  "error_msg": "Access token invalid or no longer valid"
}

千帆大模型平台相关错误码，请查看错误码说明。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/embeddings/bge_large_zh?access_token	=' \
--header 'Content-Type: application/json' \
--data-raw ''

响应示例

{
  "id": "as-gjs275mj6s",
  "object": "embedding_list",
  "created": 1687155816,
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.018314670771360397,
        0.00942440889775753,
        ...（共1024个float64）
        -0.36294862627983093
      ],
      "index": 0
    },
    {
      "object": "embedding",
      "embedding": [
        0.12250778824090958,
        0.07934671640396118,
        ...（共1024个float64）
        0
      ],
      "index": 1
    }
  ],
  "usage": {
    "prompt_tokens": 12,
    "total_tokens": 12
  }
}

请求参数

Query 参数

access_token

string

必需

通过API Key和Secret Key获取的access_token，参考Access Token获取

Body 参数application/json

input

array[string]

必需

输入文本以获取embeddings。说明：（1）文本数量不超过16 （2）每个文本长度不超过 384个token （3）输入文本不能为空，如果为空会报错

user_id

string

可选

表示最终用户的唯一标识符，可以监视和检测滥用行为，防止接口恶意调用

示例

返回响应

🟢200成功

application/json

Body

string

本轮对话的id

必需

object

string

必需

回包类型，固定值“embedding_list”

created

integer

时间戳

必需

data

array [object {3}]

必需

embedding信息，data成员数和文本数量保持一致

object

string

必需

固定值"embedding"

embedding

array [oneOf]

必需

embedding 内容

index

integer

序号

必需

usage

object

必需

token统计信息，token数 = 汉字数+单词数*1.3 （仅为估算逻辑）

prompt_tokens

integer

必需

问题tokens数（包含历史QA）

total_tokens

integer

tokens总数

必需

修改于 2023-11-16 02:31:26

Embedding-V1

bge-large-en

bge-large-zh

Embeddings#

在线调试#

错误码#

请求参数

返回响应

Embeddings

在线调试

错误码