文档首页/ 应用平台 AppStage/ API参考/ API/ 应用中心/ 调用知识检索流
更新时间：2024-12-11 GMT+08:00
查看PDF
分享

调用知识检索流

功能介绍

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

flow_id

是

String

知识检索流id。
表2 Query参数

参数

是否必选

参数类型

描述

query_example

否

String

按照用户配置的知识检索流请求参数配置，如果用户配置的知识检索流输入存在查询参数，则应该配置对应的参数并在调用时输入特定的值。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

authorization

是

String

AI原生应用引擎鉴权API Key。

1.以管理员身份登录AI原生应用引擎工作台，在左侧导航栏选择“系统管理 > 平台租户鉴权”。

2.在“平台租户鉴权”页面，选择“平台API Key”页签，单击“新增平台API Key”。

3.在“新增平台API Key”对话框中的输入框设置API Key名称，用以区分API Key。

4.在弹出的下载窗口中单击“立即下载”，将API Key下载到本地查看。

5.使用时，需在sk前加上Bearer ，如Bearer sk-xxxxxxxx。

header_example

否

String

按照用户配置的知识检索流请求头参数配置，如果用户配置的知识检索流输入存在请求头输入，则应该配置对应的参数并在调用时输入特定的值。
表4 请求Body参数

参数

是否必选

参数类型

描述

body

否

Object

调用知识检索流请求体，与知识检索流起始节点配置相关，按照知识检索流的配置格式填写即可。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

data

Map<String,Object>

响应体。

error_code

String

错误码。

error_msg

String

错误信息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

请求示例

{
  "object_example" : {
    "string_example" : "abc",
    "boolean_example" : "true",
    "integer_example" : 123
  }
}

响应示例

状态码： 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

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

错误码

请参见错误码。

父主题： 应用中心

相关文档