AnswerKnowledgeBase-阿里云帮助中心

Performs a single-turn knowledge base question answering.

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

polardb:AnswerKnowledgeBase

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-beijing
KnowledgeBaseId	string	Yes	The unique ID of the knowledge base.	pkb-xxxxx
QueryText	string	Yes	The user question.	Summarize this year's financial report
TopK	integer	No	The number of recall results to retrieve.	10
ScoreThreshold	number	No	The similarity score threshold.	0.7
RerankEnabled	boolean	No	Specifies whether to enable reranking. Disabled by default.	false
SearchMode	string	No	The search mode. Valid values: knn, rrf, precise, semantic, and balanced.	semantic
ReturnSources	boolean	No	Specifies whether to return citation sources. Enabled by default.	true
SystemPrompt	string	No	The system prompt.	This is a minimal test prompt for security verification.
UserInstructions	string	No	The user supplementary instructions.	Return a short summary and test result.
MaxContextChars	integer	No	The maximum number of context characters. Valid values: 1000 to 32000.	16000

Response elements

Element	Type	Description	Example
	object	Schema of Response
QueryId	string	The unique ID of the Q&A task.	R3BGbnBqcXN****.2a5a23c9-****-179970533d30
RequestId	string	Id of the request	A7E6A8FD-C50B-46B2-BA85-D8B8D3******
Status	string	The status of the Q&A task.	Running

Examples

Success response

JSON format

{
  "QueryId": "R3BGbnBqcXN******.2a5a23c9-******-179970533d30",
  "RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
  "Status": "Running"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.