AI RAG 文档知识库问答

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

当前接口契约

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

功能说明

上传企业制度、产品说明、协议和帮助文档即可构建专属知识库；

支持 PDF、TXT、Markdown、HTML 和 DOCX 常见文档格式；

支持按知识库与业务分组管理资料，适合多产品和多项目使用；

支持连续追问并保持会话上下文，便于构建自然的问答体验；

回答同步提供引用来源与内容片段，便于核对信息依据；

支持标准 JSON 与 SSE 流式返回，兼顾完整结果和实时展示；

兼容 OpenAI Chat Completions 调用方式，便于现有应用接入；

返回文档处理状态与内容片段数量，便于确认资料是否可用于问答；

支持删除指定文档和会话，方便维护知识库资料与对话记录；

适合智能客服、开发者门户、内部制度查询和企业资料检索；

请求参数

参数	类型	必填	默认值	说明
knowledge_base_id	string	是	default	知识库标识，路径参数，最长 80 个字符。
appkey	string	否	无	APPKEY，可通过 Query、JSON Body、Header 或 Bearer 传递。 AppKey 整体必填；在本操作已声明支持的鉴权位置任选一个提供，本位置无需重复填写。多处填写时须一致。
model	string	否	gugudata-knowledge-chat	固定为 gugudata-knowledge-chat。
messages	array	是	无	消息数组，最多 20 条；最后一条必须为 user 消息。
thread_id	string	否	无	会话标识，不传时创建新会话，最长 120 个字符。
tenant_id	string	否	default	客户侧业务分组标识，默认 default，最长 80 个字符。
stream	boolean	否	false	是否使用 SSE 流式响应，默认 false。
top_k	integer	否	6	引用片段数量，范围 1 至 12，默认 6。

正常响应字段

字段	类型	说明
id	string	当前回答消息标识。
object	string	OpenAI 兼容响应对象类型。
thread_id	string	当前对话会话标识。
choices[0].message.content	string	基于知识库资料生成的回答。
sources	array	回答引用的文档来源与内容片段。
usage	object	本次请求的使用量摘要。

业务状态说明

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

请求参数

Path 参数

Query 参数

Body 参数application/json必填

示例

{
    "model": "gugudata-knowledge-chat",
    "messages": [
        {
            "role": "user",
            "content": "有哪些接口？"
        }
    ],
    "thread_id": "",
    "tenant_id": "default",
    "stream": false,
    "top_k": 6
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200

application/json

非流式请求返回 JSON；流式请求返回 SSE，并在完整成功后发送 [DONE]。

Bodyapplication/json

示例

{
    "id": "string",
    "object": "chat.completion",
    "thread_id": "string",
    "choices": [
        {
            "message": {
                "content": "string",
                "role": "assistant"
            },
            "finish_reason": "stop",
            "index": 0
        }
    ],
    "sources": [
        {
            "snippet": "string",
            "score": 0,
            "document_id": "string",
            "location": "string",
            "chunk_id": "string",
            "source_name": "string"
        }
    ],
    "usage": {
        "total_tokens": 0,
        "completion_tokens": 0,
        "prompt_tokens": 0
    },
    "knowledge_base_id": "string",
    "model": "gugudata-knowledge-chat",
    "created": 0,
    "query": "string"
}

🟠400

🟠401

🟠403

🟠404

🟠405

🟠415

🟠429

🔴500

🔴502

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

当前接口契约#

功能说明#

请求参数#

正常响应字段#

业务状态说明#

请求参数

请求示例代码

返回响应

当前接口契约

功能说明

请求参数

正常响应字段

业务状态说明