j9九游会登录/ 应用平台 appstage/ api参考/ / / 调用知识检索流
更新时间：2025-03-12 gmt 08:00

调用知识检索流-j9九游会登录

功能介绍

该接口用于调用用户配置的知识检索流。

调用方法

请参见。

uri

post https://aiae.appstage.myhuaweicloud.com/v1/workflow-adapter-open/rag-flows/{flow_id}

表1 路径参数

参数

是否必选

参数类型

描述

flow_id

是

string

参数解释：

知识检索流id。进入ai原生应用引擎，在左侧导航栏选择“知识中心 > 知识检索流”，在流列表中复制检索流id。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字以及“-”组成，且长度为36个字符。

默认取值：

不涉及。

请求参数

表2 请求header参数

参数

是否必选

参数类型

描述

authorization

是

string

参数解释：

鉴权信息。获取平台api key，并为api key添加前缀bearer，得到标准鉴权信息，例如bearer sk-74e4157***。api key获取方法请参见创建api key。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表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

服务器内部错误或三方服务器内部错误。

错误码

请参见错误码。

父主题：

相关文档

网站地图