GetKnowledgeRecall - 知识库召回-云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

增加知识库文档

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

adb:GetKnowledgeRecall

get

*全部资源

*

无

请求语法

POST /knowledge/recall HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	ADB MySQL 集群 ID。	am-bp19aaaaaa****
Question	string	是	知识库召回问题	What are the reports for the clothing category this month?
Topk	integer	否	召回关联文件 Top K	5
User	string	否	用户名，只召回这个用户名有权限的文件	user_name1
Path	string	否	文件路径前缀，召回时只召回匹配路径前缀的文件	oss://bucketName/path/prefix/
Tags	string	否	标签列表，JSON 格式	{ "tag_key1": ["tag_key1_value1", "tag_key1_value2"], "tag_key2": ["tag_key2_value"] }
Images	string	否	图片召回时，需要做搜索的图片列表数组，目前只支持 1 张图片，图片需要转为 Base64 编码传入，JSON 格式：base64 key 放入图片转码后的结果， mime_type 设置图片的格式，详见示例	[{"base64": "/9j/4AAQSkZJRgABAQ...", "mime_type": "image/jpeg"}]
SemanticRules	string	否	语义规则，目前只支持 "all" 和 ""	all

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Data	object	返回数据。
Count	integer	总条数	5
Message	string	提示信息	recall 5 files
Results	array<object>	召回结果
	object	单条召回结果
TraceId	string	链路追踪 ID。	qf_c41fc27697d3
RequestId	string	Id of the request	1AD222E9-E606-4A42-BF6D-8A4442913CEF

示例

正常返回示例

JSON格式

{
  "Data": {
    "Count": 5,
    "Message": "recall 5 files",
    "Results": [
      {
        "test": "test",
        "test2": 1
      }
    ],
    "TraceId": "qf_c41fc27697d3"
  },
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}

错误码

HTTP status code	错误码	错误信息	描述
400	MDS.CatalogAlreadyExist	The catalog already exists.	目录已经存在
400	MDS.IllegalArgument	Invalid argument.	用户使用了非法参数
400	MDS.InvalidPrivilege	No permissions.	用户无权限进行操作
400	MDS.MetaSchemaAlreadyExist	The database already exists.	数据库已存在
400	MDS.MetaSchemaNotExist	The database does not exist.	操作的数据库不存在
400	MDS.MetaTableAlreadyExist	The table already exists.	操作的表已经存在
400	MDS.MetaTableNotExist	The table is not found.	操作的表不存在
400	MDS.SemanticViewAlreadyExist	The semantic view already exists.	此语义视图已经存在
500	MDS.InternalError	An internal MDS error occurred.	MDS服务内部错误
500	MDS.MetaVisitError	Failed to access metadata.	访问元数据失败
403	MDS.RamAuthAccessDenied	ram auth access denied.	RAM鉴权失败
404	MDS.InstanceNotExist	ADB instance does not exist.	ADB 实例不存在

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。