文档首页/ 盘古大模型 PanguLargeModels/ API参考/ API/ 模型推理接口/ 专业大模型/ Embedding模型
更新时间：2025-07-29 GMT+08:00
查看PDF
分享

Embedding模型

功能介绍

Embedding模型服务在创建知识库中，文本处理阶段，用于对文本文档进行前片，转换成向量化表示。在知识检索阶段，根据用户输入的query对切片进行召回。

URI

获取URI方式请参见请求URI。

POST /pangu/search/v1/vector/query

请求参数

使用Token认证方式的请求Header参数见表1。

表1 请求Header参数（Token认证）

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

用于获取操作API的权限。如图4中响应消息头中X-Subject-Token的值即为Token。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

Content-Type

是

String

参数解释：

发送的实体的MIME类型。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

application/json

使用API Key认证方式的请求Header参数见表 请求Header参数（API Key认证）。

表2 请求Header参数（API Key认证）

参数

是否必选

参数类型

描述

X-Apig-AppCode

是

String

参数解释：

API Key值。

用于获取操作API的权限。API Key认证响应消息头中X-Apig-AppCode的值即为API Key。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

Content-Type

是

String

参数解释：

发送的实体的MIME类型。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

application/json
表3 请求Body参数

参数

是否必选

参数类型

描述

query

是

String

参数解释：

query信息；支持在线输入query的embedding。

约束限制：

字符串长度限制：1~1000。

取值范围：。

不涉及

默认取值：

不涉及

embedding_type

否

String

参数解释：

embedding的两种模式query2query和query2doc。

约束限制：

不涉及

取值范围：

query2query和query2doc。

默认取值：

query2doc

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

embedding

List[List[Float]]

参数解释：

embedding的结果。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

ret

String

参数解释：

错误码。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

msg

String

参数解释：

错误信息。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

cost

Float

参数解释：

模型推理耗时。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

状态码： 400

表5 响应Body参数

参数

参数类型

描述

ret

String

参数解释：

错误码。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

msg

String

参数解释：

错误信息。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

embedding

List[List[Float]]

参数解释：

embedding的结果，当错误时，是为空。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

cost

Float

参数解释：

处理时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求示例

POST /pangu/search/v1/vector/query \
--header 'Content-Type: application/json' \
--data '{
    "query": "南京",
    "embedding_type": "query2query"
}'

响应示例

{"embedding": [[0.30784764885902405, -0.0034346922766417265, 0.09973953664302826, -0.46510231494903564,...]], "ret": 0, "cost":
0.03413224220275879, "msg": "success"}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 专业大模型

相关文档