DescribeKnowledgeBaseAnswer-阿里云帮助中心

Queries the single-turn Q&A results of a 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

polardb:DescribeKnowledgeBaseAnswer

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 identifier of the knowledge base.	pkb-xxxxx
QueryId	string	Yes	The unique identifier of the Q&A task.	R3BGbnBqcXN****.2a5a23c9-****-179970533d30

Response elements

Element	Type	Description	Example
	object	Schema of Response
AgentId	string	Agent ID	******
Answer	string	The content of the answer.	The content of the financial report is summarized as follows: ******
CompletionTokens	integer	The cumulative number of completion tokens generated.	3935
ErrorMessage	string	The error message.	Space not found: pks-xxxx
ErrorType	string	The error type.	not_found
LLMModelId	string	The ID of the large language model.	OO1A6p8B******_xPUC
PromptTokens	integer	The cumulative number of prompt tokens consumed.	2459
QueryId	string	The unique identifier of the Q&A task.	R3BGbnBqcXN****.2a5a23c9-****-179970533d30
RequestId	string	Id of the request	CDB3258F-B5DE-43C4-8935-CBA0CA******
Sources	array<object>	The list of reference sources for the answer.
	array<object>	The reference source information for the answer.
ChunkMetadata	object	The shard metadata.	{}
FileId	string	The file ID.	91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc
FileName	string	The file name.	Financial_Report.pdf
ImageResources	array<object>	The list of image resources associated with the shard referenced in the Q&A.
	object	The image resource.
DocumentIndex	integer	The index of the source document to which the image belongs, starting from 0.	0
Id	string	The unique identifier of the image resource.	document-0/pictures/1
ItemRef	string	The element reference of the image in the Docling source document structure.	#/pictures/1
MimeType	string	The MIME type of the image resource.	image/png
Uri	string	The OSS URI of the image resource.	oss://my-bucket/results/my-space/doc-001/artifacts/image-1.png
KnowledgeBaseId	string	The unique identifier of the knowledge base.	pkb-xxxxx
Metadata	object	The document metadata.	{}
PageNumbers	array	The list of page numbers to which the shard belongs.
	integer	The page number to which the shard belongs.	2
ShardContent	string	The shard content.	Financial report
ShardIndex	integer	The shard ID.	8
SimilarityScore	number	The similarity score.	0.75
SourceId	integer	The source ID.	1
SourceUri	string	The URI of the original document.	https://example.com/source.pdf
Status	string	The status of the Q&A task. Valid values: RUNNING: The task is in progress. COMPLETED: The task is completed.	COMPLETED

Examples

Success response

JSON format

{
  "AgentId": "******",
  "Answer": "The financial report summary is as follows: ******",
  "CompletionTokens": 3935,
  "ErrorMessage": "Space not found: pks-xxxx",
  "ErrorType": "not_found",
  "LLMModelId": "OO1A6p8B******_xPUC",
  "PromptTokens": 2459,
  "QueryId": "R3BGbnBqcXN******.2a5a23c9-******-179970533d30",
  "RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
  "Sources": [
    {
      "ChunkMetadata": {},
      "FileId": "91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc",
      "FileName": "FinancialReport.pdf",
      "ImageResources": [
        {
          "DocumentIndex": 0,
          "Id": "document-0/pictures/1",
          "ItemRef": "#/pictures/1",
          "MimeType": "image/png",
          "Uri": "oss://my-bucket/results/my-space/doc-001/artifacts/image-1.png"
        }
      ],
      "KnowledgeBaseId": "pkb-xxxxx",
      "Metadata": {},
      "PageNumbers": [
        2
      ],
      "ShardContent": "FinancialReport",
      "ShardIndex": 8,
      "SimilarityScore": 0.75,
      "SourceId": 1,
      "SourceUri": "https://example.com/source.pdf"
    }
  ],
  "Status": "COMPLETED"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.