GetKnowledgeRecall-阿里云帮助中心

Adds a document to the knowledge base.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:GetKnowledgeRecall

get

*All Resource

*

None

Request syntax

POST /knowledge/recall HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL cluster.	am-bp19aaaaaa****
Question	string	Yes	The question for knowledge base retrieval.	What are the reports for the clothing category this month?
Topk	integer	No	The top K value for retrieving associated files.	5
User	string	No	The username. Only files that the user has permissions to access are retrieved.	user_name1
Path	string	No	The file path prefix. Only files that match the path prefix are retrieved.	oss://bucketName/path/prefix/
Tags	string	No	The list of tags in JSON format.	{ "tag_key1": ["tag_key1_value1", "tag_key1_value2"], "tag_key2": ["tag_key2_value"] }
Images	string	No	The array of images to search for image retrieval. Currently, only one image is supported. The image must be Base64-encoded and passed in JSON format. Set the base64 key to the encoded image and the mime_type key to the image format. For more information, see the examples.	[{"base64": "/9j/4AAQSkZJRgABAQ...", "mime_type": "image/jpeg"}]
SemanticRules	string	No	The semantic rules. Currently, only "all" and "" are supported.	all

Response elements

Element	Type	Description	Example
	object	Schema of Response
Data	object	The returned data.
Count	integer	The total number of entries.	5
Message	string	The message.	recall 5 files
Results	array<object>	The retrieval results.
	object	A single retrieval result.
TraceId	string	The Tracing Analysis ID.	qf_c41fc27697d3
RequestId	string	Id of the request	1AD222E9-E606-4A42-BF6D-8A4442913CEF

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	MDS.CatalogAlreadyExist	The catalog already exists.	Catalog already exists
400	MDS.IllegalArgument	Invalid argument.	An invalid parameter is used.
400	MDS.InvalidPrivilege	No permissions.	You are not authorized to perform this operation.
400	MDS.MetaSchemaAlreadyExist	The database already exists.	The specified database already exists.
400	MDS.MetaSchemaNotExist	The database does not exist.	The specified database does not exist.
400	MDS.MetaTableAlreadyExist	The table already exists.	The specified table already exists.
400	MDS.MetaTableNotExist	The table is not found.	The specified table does not exist.
400	MDS.SemanticViewAlreadyExist	The semantic view already exists.	Semantic view already exists
500	MDS.InternalError	An internal MDS error occurred.	An internal error occurred.
500	MDS.MetaVisitError	Failed to access metadata.	Failed to access the metadata.
403	MDS.RamAuthAccessDenied	ram auth access denied.	RAM authentication failed
404	MDS.InstanceNotExist	ADB instance does not exist.	ADB instance does not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.