查询知识库单轮问答结果
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID |
cn-beijing |
| KnowledgeBaseId |
string |
是 |
知识库唯一标识 |
pkb-xxxxx |
| QueryId |
string |
是 |
问答任务唯一标识 |
R3BGbnBqcXN******.2a5a23c9-******-179970533d30 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
CDB3258F-B5DE-43C4-8935-CBA0CA****** |
| QueryId |
string |
问答任务唯一标识 |
R3BGbnBqcXN******.2a5a23c9-******-179970533d30 |
| Status |
string |
问答任务状态：
|
COMPLETED |
| Answer |
string |
回答内容 |
财报的内容总结如下：****** |
| Sources |
array<object> |
回答参考来源列表 |
|
|
array<object> |
回答参考来源信息 |
||
| SourceId |
integer |
来源 ID |
1 |
| FileId |
string |
文件 ID |
91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc |
| KnowledgeBaseId |
string |
知识库唯一标识 |
pkb-xxxxx |
| FileName |
string |
文件名 |
财报.pdf |
| ShardIndex |
integer |
分片 id |
8 |
| SimilarityScore |
number |
相似度 |
0.75 |
| PageNumbers |
array |
分片所属的页码列表 |
|
|
integer |
分片所属的页码 |
2 |
|
| ShardContent |
string |
分片内容 |
财报 |
| Metadata |
object |
文档元数据 |
{} |
| ChunkMetadata |
object |
分片元数据 |
{} |
| PromptTokens |
integer |
Prompt 消耗 token 数累计 |
2459 |
| CompletionTokens |
integer |
Completion 生成 token 数累计 |
3935 |
| AgentId |
string |
Agent ID |
****** |
| LLMModelId |
string |
大语言模型 id |
OO1A6p8B******_xPUC |
| ErrorType |
string |
错误类型 |
not_found |
| ErrorMessage |
string |
错误信息 |
Space not found: pks-xxxx |
示例
正常返回示例
JSON格式
{
"RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
"QueryId": "R3BGbnBqcXN******.2a5a23c9-******-179970533d30",
"Status": "COMPLETED",
"Answer": "财报的内容总结如下：******",
"Sources": [
{
"SourceId": 1,
"FileId": "91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc",
"KnowledgeBaseId": "pkb-xxxxx",
"FileName": "财报.pdf",
"ShardIndex": 8,
"SimilarityScore": 0.75,
"PageNumbers": [
2
],
"ShardContent": "财报",
"Metadata": {},
"ChunkMetadata": {}
}
],
"PromptTokens": 2459,
"CompletionTokens": 3935,
"AgentId": "******",
"LLMModelId": "OO1A6p8B******_xPUC",
"ErrorType": "not_found",
"ErrorMessage": "Space not found: pks-xxxx"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。