# WeKnoraGateway API 接口文档

# 概述

WeKnoraGateway 是一个功能完整的Go语言AI网关服务，提供OpenAI兼容的API接口和丰富的AI功能。本文档按照认证方式将接口分为三个清晰的层级。

# 基础信息

基础URL

http://localhost:8080/api/v1

注意: 本文档中的URL、ID、密钥等均为示例值，实际使用时请替换为真实的环境配置。

# 知识状态说明

# 状态定义与说明

在WeKnoraGateway中，知识文件有三个重要的状态字段，它们控制着知识的处理流程和使用状态：

# 1. parse_status（解析状态）

定义: 控制知识文件的解析处理流程状态

可能值:

• pending - 等待解析
• processing - 正在解析中
• completed - 解析完成
• failed - 解析失败
• deleting - 正在删除

影响: 决定知识文件是否已完成解析处理，只有解析完成的知识才能被启用

# 2. summary_status（摘要状态）

定义: 控制异步摘要生成流程状态

可能值:

• none - 无摘要状态
• pending - 等待生成摘要
• processing - 正在生成摘要
• completed - 摘要生成完成
• failed - 摘要生成失败

影响: 控制知识摘要的生成状态，影响知识检索时的摘要显示

# 3. enable_status（启用状态）

定义: 控制知识是否可用于检索

可能值:

• enabled - 已启用，知识可用于检索
• disabled - 已禁用，知识不可用于检索

影响: 决定知识是否在对话和检索时被使用

# 状态依赖关系

关键逻辑:

• 知识默认创建时：parse_status为pending，enable_status为disabled
• 只有parse_status为completed时，enable_status才能设置为enabled
• 当parse_status为completed且知识包含文本块时，summary_status会设置为pending开始摘要生成
• 知识必须满足：parse_status为completed且enable_status为enabled才能被检索使用

状态转换流程:

创建知识 → parse_status: pending, enable_status: disabled
    ↓
解析处理 → parse_status: processing
    ↓
解析完成 → parse_status: completed
    ↓
启用知识 → enable_status: enabled (可选)
    ↓
摘要生成 → summary_status: pending → processing → completed