# Embedding模型
#### 功能介绍
Embedding模型服务在创建知识库中，文本处理阶段，用于对文本文档进行前片，转换成向量化表示。在知识检索阶段，根据用户输入的query对切片进行召回。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/productdesc-pangulm/pangulm_01_0020.html)。
#### URI
获取URI方式请参见[请求URI](https://support.huaweicloud.com/api-pangulm/pangulm_05_0004.html)。
POST /pangu/search/v1/vector/query
#### 请求参数
使用[Token认证](https://support.huaweicloud.com/api-pangulm/pangulm_05_0009.html#pangulm_05_0009__section94702116509)方式的请求Header参数见[表1]。
 表1请求Header参数（Token认证） 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 用于获取操作API的权限。如[图4](https://support.huaweicloud.com/api-pangulm/pangulm_05_0009.html#pangulm_05_0009__fig10797003103)中响应消息头中X-Subject-Token的值即为Token。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
| Content-Type | 是    | String | **参数解释：** 发送的实体的MIME类型。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** application/json                                                                                                                                                                       |
   
使用[API Key认证](https://support.huaweicloud.com/api-pangulm/pangulm_05_0009.html#pangulm_05_0009__section148602501261)方式的请求Header参数见[表 请求Header参数（API Key认证）]。
 表2请求Header参数（API Key认证） 
| 参数             | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| X-Apig-AppCode | 是    | String | **参数解释：** API Key值。 用于获取操作API的权限。[API Key认证](https://support.huaweicloud.com/api-pangulm/pangulm_05_0009.html#pangulm_05_0009__section148602501261)响应消息头中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"}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-pangulm/pangulm_05_0019.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-pangulm/pangulm_05_0020.html)。