# 知识库召回测试 - CheckRecallKnowledgeLibrary
#### 功能介绍
该接口用于知识库召回测试。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-metastudio/metastudio_02_0002.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-metastudio/metastudio_02_0071.html)。
#### URI
POST /v1/{project_id}/wise-brain-manager/knowledge-library/recall
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                            |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-metastudio/metastudio_02_0006.html)。 |
   
#### 请求参数
表2请求Header参数 
| 参数            | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                               |
|:---|:---|:---|:---|
| X-Auth-Token  | 否    | String | 用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 |
| Authorization | 否    | String | 使用AK/SK方式认证时必选，携带的鉴权信息。                                                                                                                                                                                                          |
| X-Sdk-Date    | 否    | String | 使用AK/SK方式认证时必选，请求的发生时间。                                                                                                                                                                                                          |
| X-Project-Id  | 否    | String | 使用AK/SK方式认证时必选，携带项目ID信息。                                                                                                                                                                                                         |
| X-App-UserId  | 否    | String | 第三方用户ID。不允许输入中文。                                                                                                                                                                                                                 |
   
表3请求Body参数 
| 参数                   | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| knowledge_library_id | 是    | String  | 知识库名称。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| knowledge_type       | 是    | String  | 知识库类型 - QUESTION_ANSWER：问答   - DOCUMENT：文档    |
| query                | 是    | String  | 知识库召回请求文本                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| topk                 | 否    | Integer | 文档库召回topk **取值范围：** 1\~20 **默认取值：** 10                                                                                                                                                                                                                                                                                                                                                                                                                      |
| score                | 否    | Double  | 知识库召回得分 **取值范围：** 0\~1 **默认取值：** 0.7                                                                                                                                                                                                                                                                                                                                                                                                                        |
   
#### 响应参数
**状态码：200**
表4响应Header参数 
| 参数           | 参数类型   | 描述    |
|:---|:---|:---|
| X-Request-Id | String | 请求ID。 |
   
表5响应Body参数 
| 参数       | 参数类型                                                                                                                                          | 描述         |
|:---|:---|:---|
| \[数组元素\] | Array of [RecallKnowledgeLibraryInfo] objects | 知识库召回测试响应。 |
   
 表6RecallKnowledgeLibraryInfo 
| 参数                 | 参数类型   | 描述                                                                                                                                                                             |
|:---|:---|:---|
| document_id        | String | 文档ID。                                                                                                                                                                          |
| file_name          | String | 文档名称。                                                                                                                                                                          |
| file_type          | String | 文档类型。                                                                                                                                                                          |
| question_answer_id | String | 问答对ID。                                                                                                                                                                         |
| content            | String | 召回文本                                                                                                                                                                           |
| score              | Double | 知识库召回得分 **取值范围：** 0\~1 |
   
**状态码：400**
表7响应Body参数 
| 参数         | 参数类型   | 描述    |
|:---|:---|:---|
| error_code | String | 错误码。  |
| error_msg  | String | 错误描述。 |
   
#### 请求示例
```
POST https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/wise-brain-manager/knowledge-library/recall
{
  "knowledge_library_id" : "39b9cedccec1f19b33d8f7ce1a6d35b9",
  "knowledge_type" : "DOCUMENT",
  "topk" : 10,
  "score" : 0.7,
  "query" : "你是谁"
}
```
#### 响应示例
**状态码：400**
请求传参异常，包含错误码及对应描述。
```
{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}
```
#### 状态码
| 状态码 | 描述                 |
|:---|:---|
| 200 | 处理成功返回。            |
| 400 | 请求传参异常，包含错误码及对应描述。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-metastudio/ErrorCode.html)。