DescribeKnowledgeBaseAnswer - 查询知识库单轮问答结果-云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

查询知识库单轮问答结果

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeKnowledgeBaseAnswer

get

*全部资源

*

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID	cn-beijing
KnowledgeBaseId	string	是	知识库唯一标识	pkb-xxxxx
QueryId	string	是	问答任务唯一标识	R3BGbnBqcXN****.2a5a23c9-****-179970533d30

返回参数

名称	类型	描述	示例值
	object	Schema of Response
AgentId	string	Agent ID	******
Answer	string	回答内容	财报的内容总结如下：******
CompletionTokens	integer	Completion 生成 token 数累计	3935
ErrorMessage	string	错误信息	Space not found: pks-xxxx
ErrorType	string	错误类型	not_found
LLMModelId	string	大语言模型 id	OO1A6p8B******_xPUC
PromptTokens	integer	Prompt 消耗 token 数累计	2459
QueryId	string	问答任务唯一标识	R3BGbnBqcXN****.2a5a23c9-****-179970533d30
RequestId	string	Id of the request	CDB3258F-B5DE-43C4-8935-CBA0CA******
Sources	array<object>	回答参考来源列表
	array<object>	回答参考来源信息
ChunkMetadata	object	分片元数据	{}
FileId	string	文件 ID	91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc
FileName	string	文件名	财报.pdf
ImageResources	array<object>	问答引用分片关联的图片资源列表
	object	图片资源
DocumentIndex	integer	图片所属源文档的序号，从 0 开始	0
Id	string	图片资源唯一标识	document-0/pictures/1
ItemRef	string	图片在源文档结构中的元素引用	#/pictures/1
MimeType	string	图片资源的媒体类型	image/png
Uri	string	图片资源的 OSS URI	oss://my-bucket/results/my-space/doc-001/artifacts/image-1.png
KnowledgeBaseId	string	知识库唯一标识	pkb-xxxxx
Metadata	object	文档元数据	{}
PageNumbers	array	分片所属的页码列表
	integer	分片所属的页码	2
ShardContent	string	分片内容	财报
ShardIndex	integer	分片 id	8
SimilarityScore	number	相似度	0.75
SourceId	integer	来源 ID	1
SourceUri	string	原始文档地址	https://example.com/source.pdf
Status	string	问答任务状态： RUNNING：进行中 COMPLETED：已完成	COMPLETED

示例

正常返回示例

JSON格式

{
  "AgentId": "******",
  "Answer": "财报的内容总结如下：******",
  "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": "财报.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": "财报",
      "ShardIndex": 8,
      "SimilarityScore": 0.75,
      "SourceId": 1,
      "SourceUri": "https://example.com/source.pdf"
    }
  ],
  "Status": "COMPLETED"
}

错误码

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

变更历史

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