上传知识库文档

围绕已上传资料进行连续问答，并返回可核对的引用来源。
详情页：https://www.gugudata.com/api/details/knowledge-chat

当前接口契约

接口详情：https://www.gugudata.com/api/details/knowledge-chat

请求参数

参数	类型	必填	默认值	说明
appkey	string	否	无	兼容历史客户端的 Query APPKEY。 AppKey 整体必填；在本操作已声明支持的鉴权位置任选一个提供，本位置无需重复填写。多处填写时须一致。
knowledge_base_id	string	是	无	知识库标识。
files	file[]	是	无	PDF、TXT、Markdown、HTML 或 DOCX；单文件最大 20 MiB，单次总大小最大 40 MiB。
tenant_id	string	否	"default"	见接口说明
metadata	string	否	无	JSON 对象字符串。
replace_existing	boolean	否	false	见接口说明

正常响应

HTTP 200，application/json。

字段	类型	说明
DataStatus	object	接口业务状态信息。
DataStatus.RequestParameter	string	不含问题正文与文件内容的请求摘要。
DataStatus.StatusCode	integer	业务状态码，100 表示成功。
DataStatus.StatusDescription	string	业务状态说明。
DataStatus.ResponseDateTime	string	接口响应时间。
DataStatus.DataTotalCount	integer	本次返回的数据数量。
Data	object	文档处理结果。

业务状态说明

业务状态码	业务状态码解释	备注
100	请求成功	接口正常返回
501	参数错误	请检查请求参数、文件大小或文件格式
504	APPKEY 错误	请检查传递的 APPKEY 是否正确
-1	请求失败	知识库处理或问答过程中发生异常

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200

application/json

文档处理结果。

Bodyapplication/json

示例

{
    "DataStatus": {
        "StatusCode": 0,
        "StatusDescription": "string",
        "ResponseDateTime": "string",
        "DataTotalCount": 0,
        "RequestParameter": "string"
    },
    "Data": {
        "knowledge_base_id": "string",
        "documents": [
            {
                "document_id": "string",
                "file_name": "string",
                "file_size": 0,
                "status": "ready",
                "parse_status": "ready",
                "index_status": "ready",
                "chunk_count": 0,
                "token_estimate": 0,
                "checksum": "string",
                "message": "string"
            }
        ],
        "tenant_id": "string",
        "ready_count": 0,
        "failed_count": 0
    }
}

🟠400

🟠401

🟠403

🟠404

🟠405

🟠415

🟠429

🔴500

🔴502

🔴503知识库服务暂时不可用，业务码 901。

当前接口契约#

请求参数#

正常响应#

业务状态说明#

请求参数

请求示例代码

返回响应

当前接口契约

请求参数

正常响应

业务状态说明