本接口在用户选择的文档目录范围内，结合会话内的历史问答作为上下文，提供基于知识库文档的服务。
接口说明
- 接口在会话选择的目录范围内提供问答服务。
- sessionId 信息通过 GetChatSessionList 获取。
- 同时可以通过 CreateChatSession 接口创建新的会话。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| energy:Chat | none | *全部资源 * |
| 无 |
请求语法
POST /api/v2/aidoc/document/chat HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| body | object | 否 | 请求参数。 | |
| sessionId | string | 是 |
| bfce2248-1546-4298-8bcf-70ac26e69646 |
| question | string | 是 | 问答内容。 | 知识库问答文档如何获取 |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
"data": {
"question": "如何使用知识库。",
"answer": "未找到相关内容",
"createTime": 1747280158000,
"refDocList": [
{
"docName": "a.pdf",
"sourceType": "doc",
"docUrl": "https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.pdf",
"docInfo": {
"pages": 23,
"pageListInfo": [
{
"imageWidth": 23,
"imageUrl": 2,
"pageIdCurDoc": 2,
"angle": 0,
"excelParseResult": null,
"wordParseResult": null,
"pdfParseResult": null,
"imageHeight": 22
}
]
},
"originDocName": "a.doc",
"pageNum": [
{
"pos": [
[
{
"x": 22,
"y": 86
}
]
],
"num": 12
}
],
"originDocUrl": "https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.doc"
}
],
"folderName": "默认文件夹",
"folderId": "7708fddb-21dc-4403-a4ea-5b94eccce4c3"
}
}错误码
访问错误中心查看更多错误码。