AI 文档知识库问答

AI 文档知识库问答
接口详情官网地址: https://www.gugudata.com/api/details/knowledge-chat

私有文档 AI 知识库问答

请求方法: POST
接口路径: /ai/knowledge-bases/{knowledge_base_id}/chat/completions
调试地址: https://api.gugudata.com/ai/knowledge-bases/default/chat/completions
OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json
OpenAI 兼容: Chat Completions JSON 与 SSE 流式响应

请求参数:

knowledge_base_id (string, 必填): URL 路径中的知识库标识，默认可使用 default

appkey (string, 必填): 付费后获取的 APPKEY；也可通过 Authorization: Bearer 传入

model (string, 可选): OpenAI Chat Completions 兼容模型名称，默认 gugudata-knowledge-chat

messages (array, 必填): OpenAI Chat Completions 兼容消息数组

tenant_id (string, 可选): 客户侧业务分组标识，不传时使用 default

thread_id (string, 可选): 对话线程 ID，不传时自动创建新线程

stream (boolean, 可选): 是否使用 SSE 流式响应，默认 false

top_k (int, 可选): 检索引用片段数量，默认 6

返回字段:

id: 当前回答消息 ID

object: OpenAI 兼容响应对象类型

created: 当前回答创建时间戳

model: 本次使用的模型名称

thread_id: 当前对话线程 ID

choices[0].message.content: 基于已上传文档生成的回答

sources: 回答引用的文档来源片段

usage: 本次请求的使用量摘要

流式事件:

chat.completion.chunk: 回答增量内容

sources: 回答引用来源

answer_done: 回答完成

end: 流式输出结束

HTTP 状态码:

200 接口正常响应: 业务状态码请结合响应体中的状态字段判断。

400 请求参数错误: 参数缺失、格式错误或非法组合。

401 鉴权失败: 缺少 APPKEY 或 APPKEY 无效。

403 无权限或额度不可用: 订单到期、权限不足或剩余额度不可用。

404 资源不存在: 请求路径不存在。

405 请求方法不允许: 请求方法与接口定义不匹配。

415 请求内容类型不支持: 文件上传或请求体格式不符合要求。

429 请求频率超限: 触发接口或网关限流策略。

500 服务内部异常: 服务执行异常，请联系技术支持。

502 上游依赖异常: 上游服务响应异常或暂不可用。

业务状态码:

100 正常返回: 请求成功

101 参数错误: 请求参数不完整或无效

102 请求频率受限: 默认每个来源 IP 对同一接口最多 5 QPS。

104 APPKEY 错误: APPKEY 无效或未授权

接口特性:

兼容 OpenAI Chat Completions 请求与响应格式；

支持基于已上传文档进行语义检索和引用问答；

支持 thread_id 多轮对话，适合客服、文档助手和站内搜索场景；

支持 stream=true 使用 SSE 流式响应；

支持按知识库标识组织不同业务文档；

全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；

全面兼容 Apple ATS；

全国多节点 CDN 部署；

接口调用状态与状态监控：https://www.gugudata.com/status。

请求参数

Header 参数

Body 参数application/json

示例

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

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

请求参数

请求示例代码

返回响应