DescribeKnowledgeBaseAnswer-阿里云帮助中心

Queries the result of a single-round knowledge base question answering task.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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
QueryId	string	Yes	The unique ID 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 answer content.	The financial report summary is as follows: ******
CompletionTokens	integer	The cumulative number of tokens generated for completion.	3935
ErrorMessage	string	The error message.	Space not found: pks-xxxx
ErrorType	string	The error type.	not_found
LLMModelId	string	The large language model ID.	OO1A6p8B******_xPUC
PromptTokens	integer	The cumulative number of tokens consumed by the prompt.	2459
QueryId	string	The unique ID 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 chunk metadata.	{}
FileId	string	The file ID.	91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc
FileName	string	The file name.	FinancialReport.pdf
ImageResources	array<object>	The list of image resources associated with the referenced chunk 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 ID 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 media 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 ID of the knowledge base.	pkb-xxxxx
Metadata	object	The document metadata.	{}
PageNumbers	array	The list of page numbers to which the chunk belongs.
	integer	The page number to which the chunk belongs.	2
ShardContent	string	The chunk content.	FinancialReport
ShardIndex	integer	The chunk ID.	8
SimilarityScore	number	The similarity score.	0.75
SourceId	integer	The source ID.	1
Status	string	The status of the Q&A task. Valid values: RUNNING: In progress. COMPLETED: Completed.	COMPLETED

Examples

Success response

JSON format

{
  "AgentId": "******",
  "Answer": "The financial report is summarized 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": "financial_report.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": "financial_report",
      "ShardIndex": 8,
      "SimilarityScore": 0.75,
      "SourceId": 1
    }
  ],
  "Status": "COMPLETED"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.