# 调用知识检索流
#### 功能介绍
该接口用于调用用户配置的知识检索流。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-appstage/appstage_07_0008.html)。
#### URI
POST https://aiae.appstage.myhuaweicloud.com/v1/workflow-adapter-open/rag-flows/{flow_id}
表1路径参数 
| 参数      | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| flow_id | 是    | String | **参数解释：** 知识检索流ID。进入[AI原生应用引擎](https://support.huaweicloud.com/usermanual-wiseagent/appstage_04_0638.html#section0)，在左侧导航栏选择"知识中心 \> 知识检索流"，在流列表中复制检索流ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字以及"-"组成，且长度为36个字符。 **默认取值：** 不涉及。 |
#### 请求参数
表2请求Header参数 
| 参数            | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                    |
|:---|:---|:---|:---|
| Authorization | 是    | String | **参数解释：** 鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157\*\*\*。API Key获取方法请参见[创建API Key](https://support.huaweicloud.com/usermanual-wiseagent/appstage_04_0704.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
表3请求Body参数 
| 参数   | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                       |
|:---|:---|:---|:---|
| body | 是    | Object | **参数解释：** 结构与知识检索流的起始节点配置相关，如果为GET请求则为非必填，如果为POST请求则为必填。 比如检索流配置了query_param作为查询参数，header_param作为请求头参数，body_param_1与body_param_2作为请求体参数，此时调用本接口只需要将这些参数依次传入，AI原生应用引擎自动按照名称进行分配，并完成检索流的调用。 具体结构请参照本接口的请求示例。 **约束限制：** 不涉及 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数              | 参数类型   | 描述                                  |
|:---|:---|:---|
| responseBody    | String | **参数解释：** 流执行结果的内容。 **取值范围：** 不涉及。  |
| responseHeaders | Object | **参数解释：** 流执行结果的响应头。 **取值范围：** 不涉及。 |
   
**状态码：500**
表5响应Body参数 
| 参数         | 参数类型   | 描述                             |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。  |
| error_msg  | String | **参数解释：** 错误信息。 **取值范围：** 不涉及。 |
   
#### 请求示例
```
{
  "query_param" : "query_example",
  "header_param" : "header_example",
  "body_param_1" : "body_example_1",
  "body_param_2" : "body_example_2"
}
```
#### 响应示例
**状态码：200**
成功。
```
{
  "data" : {
    "responseBody" : "something in response body",
    "responseHeaders" : {
      "Server" : "api-gateway",
      "X-Request-Id" : "787b7740f42e75b007ac3bfb599fcef4",
      "X-Content-Type-Options" : "nosniff",
      "Connection" : "keep-alive",
      "lubanops-nspan-id" : "1",
      "X-Download-Options" : "noopen",
      "Date" : "Tue, 23 Jul 2024 11:38:29 GMT",
      "lubanops-ntrace-id" : "2748112-1721734708992-1130609",
      "Referrer-Policy" : "no-referrer",
      "X-Frame-Options" : "SAMEORIGIN",
      "Strict-Transport-Security" : "max-age=31536000; includeSubdomains;",
      "lubanops-nenv-id" : "28164",
      "Content-Length" : "0",
      "X-XSS-Protection" : "1; mode=block;",
      "Content-Type" : "application/json"
    },
    "statusCode" : 200
  }
}
```
**状态码：500**
服务器内部错误或三方服务器内部错误。
```
{
  "error_code" : "AIAE.22009001",
  "error_msg" : "Internal Server Error."
}
```
#### 状态码
| 状态码 | 描述                 |
|:---|:---|
| 200 | 成功。                |
| 500 | 服务器内部错误或三方服务器内部错误。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-appstage/ErrorCode.html)。