Fess API 指南

入门

简介

• 目标读者
• 阅读本文档前
• API使用前提条件
• 在线访问
• 技术支持联系方式
• 关于第三方网站的声明
• 提交意见和建议的方式

API 快速入门

• 5 分钟快速上手
• 使用 Postman
• 各编程语言代码示例
• API 版本对应表
• 故障排除
• 下一步

公共规范

API 概述

• Fess 提供的 API
• 基础 URL
• 响应信封
• 错误响应
• 认证与会话
• 流式响应格式
• API 种类

搜索 API

搜索 API

• 搜索文档
• 全量文档获取（滚动搜索·NDJSON）

标签 API

• 获取标签
• 使用示例
• 错误响应

热门词 API

• 获取热门词列表
• 使用示例
• 错误响应

建议词 API

• 获取建议词列表
• 使用示例
• 错误响应

相关查询与相关内容 API

• 获取相关查询
• 获取相关内容

Health API

• 获取状态
• 使用示例
• 响应与错误响应

认证与 UI

认证与会话 API

• 概述
• 公共用户信息 (UserPayload)
• 获取认证状态
• 登录
• 注销
• 修改密码

UI 配置 API

• 概述
• 获取 UI 配置

用户功能 API

收藏 API

• 获取收藏文档列表
• 获取收藏状态
• 添加收藏

点击日志 API

• 记录点击

缓存 API

• 获取缓存文档

AI 聊天 API

Chat API

• 概述
• 前提条件
• 认证与 CSRF
• 速率限制
• POST /chat
• POST /chat/stream
• DELETE /chat/sessions/{session_id}
• 安全注意事项
• 参考信息

管理 API

Admin API 参考手册

• Admin API 概述
• WebConfig API
• FileConfig API
• DataConfig API
• Documents API
• CrawlingInfo API
• FailureUrl API
• Backup API
• Scheduler API
• JobLog API
• User API
• Role API
• Group API
• AccessToken API
• LabelType API
• KeyMatch API
• BoostDoc API
• ElevateWord API
• BadWord API
• RelatedContent API
• RelatedQuery API
• Suggest API
• General API
• SystemInfo API
• Stats API
• Log API
• Storage API
• Plugin API
• Dict API
• SearchLog API