关键词

Confluence知识库搜索RAGLLMFastAPI

使用说明

项目简介

Confluence Gateway 是一个旨在增强 Confluence 知识库的搜索和信息检索能力的开源项目。它通过集成检索增强生成 (RAG) 和大型语言模型 (LLM)，提供更智能的 Confluence 内容搜索和问答功能。项目还计划作为 MCP (Model Context Protocol) 服务器，为 LLM 应用提供上下文服务。

主要功能点

  • 增强型 Confluence 搜索: 提供基于语义的 Confluence 文档检索，超越传统的关键词搜索。
  • RAG 集成: 利用检索增强生成技术，从 Confluence 文档中提取相关信息，为 LLM 提供上下文。
  • LLM 驱动的问答: 使用 LLM 根据检索到的 Confluence 文档内容生成直接、上下文相关的答案。
  • 标准 Confluence API 访问: 支持通过 Confluence API 进行标准的关键词搜索。
  • MCP 服务器 (计划中): 未来将提供 MCP 服务器功能，具体细节待定，旨在为 LLM 应用提供资源、工具和 Prompt 管理等上下文服务。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/IDontHaveBrain/confluence-gateway.git
cd confluence-gateway

  2. 创建并激活虚拟环境 (推荐):

    python3 -m venv venv
source venv/bin/activate  # 或 venv\Scripts\activate for Windows

  3. 安装依赖:

    pip install -r requirements.txt

    如果 'requirements.txt' 文件不存在，根据仓库内容手动安装必要的依赖，例如 'fastapi'、'uvicorn'、'atlassian-python-api' 和 'pydantic'。

  4. 配置 Confluence API 凭据: 设置以下环境变量，用于连接到您的 Confluence 实例：

    • 'CONFLUENCE_URL': 您的 Confluence 实例 URL，例如 'https://your-confluence.atlassian.net'
    • 'CONFLUENCE_USERNAME': 用于访问 Confluence API 的用户名 (通常是邮箱地址)
    • 'CONFLUENCE_API_TOKEN': Confluence API Token (您需要在 Atlassian 账户中生成)

    您还可以选择性地设置以下环境变量：

    • 'CONFLUENCE_TIMEOUT': API 请求超时时间 (秒)，默认为 10 秒
    • 'SEARCH_DEFAULT_LIMIT': 默认搜索结果数量限制，默认为 20
    • 'SEARCH_MAX_LIMIT': 最大搜索结果数量限制，默认为 100
    • 'SEARCH_DEFAULT_EXPAND': 默认展开的 Confluence 内容字段，默认为 'body.view,space'

服务器配置

Confluence Gateway 基于 FastAPI 构建，可以通过 Uvicorn 启动。以下是 MCP 客户端配置 MCP 服务器连接的示例 (JSON 格式):

{
  "serverName": "confluence-gateway",
  "command": "uvicorn",
  "args": [
    "confluence_gateway.api.app:app",
    "--host", "0.0.0.0",
    "--port", "8000",
    "--reload"
  ],
  "description": "Confluence Gateway MCP Server (计划中)"
}

参数注释:

  • 'serverName': 服务器名称，可以自定义。
  • 'command': 启动服务器的命令，这里使用 'uvicorn' (需要已安装)。
  • 'args': 传递给 'uvicorn' 命令的参数列表：
    • 'confluence_gateway.api.app:app': 指定 FastAPI 应用的位置。
    • '--host 0.0.0.0': 监听所有网络接口。
    • '--port 8000': 监听端口为 8000。
    • '--reload': 启用代码更改自动重启 (开发环境推荐，生产环境不建议)。

基本使用方法

  1. 启动服务器: 在项目根目录下运行：

    uvicorn confluence_gateway.api.app:app --reload

    服务器默认将在 'http://127.0.0.1:8000' 启动。

  2. 访问 API 接口: 您可以使用浏览器、curl 或其他 HTTP 客户端访问以下 API 接口：

    • 健康检查: 'http://127.0.0.1:8000/health' (检查服务器运行状态和 Confluence 连接)
    • 文本搜索: 'http://127.0.0.1:8000/api/search?query={搜索关键词}' (GET 请求，进行文本搜索)
    • 高级搜索: 'http://127.0.0.1:8000/api/search/advanced' (POST 请求，支持更多搜索参数，例如内容类型、空间、排序等，请求体为 JSON)
    • CQL 搜索: 'http://127.0.0.1:8000/api/search/cql' (POST 请求，使用 Confluence Query Language (CQL) 进行搜索，请求体为 JSON)

    请参考仓库中的 'api/schemas/requests.py' 和 'api/schemas/responses.py' 文件，了解请求和响应的具体参数和数据结构。

注意: 目前项目仍处于早期开发阶段 (Alpha)，MCP 服务器相关功能可能尚未完全实现。请关注项目仓库的更新，以获取最新的功能和使用说明。

信息

分类

生产力应用

访问项目