# 插件：知识库伴侣

**Repository Path**: low-code-dev-lab/knowledge-base-companion

## Basic Information

- **Project Name**: 插件：知识库伴侣
- **Description**: 活字格-知识库伴侣辅助插件
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-01-24
- **Last Updated**: 2026-06-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 知识库伴侣 - 活字格插件工程

本项目是为**活字格 (Forguncy)** 开发的插件工程，旨在将“知识库伴侣”强大的文档处理与 AI 能力集成到活字格应用中。

## 核心依赖

本插件基于 **[知识库伴侣 API 服务](https://gitee.com/low-code-dev-lab/markitdown-api)**。在安装和使用此插件前，您需要先部署该 API 服务。

## 项目结构

工程采用典型的活字格插件结构，包含以下核心模块：

- **`KnowledgeBaseCompanionPlugin/KnowledgeBaseCompanion/`**: 插件主体，包含所有的**服务端命令**实现、设计时元数据及资源文件。
- **`KnowledgeBaseCompanionPlugin/KnowledgeBaseCompanion.Server/`**: 插件的服务器端扩展，包含自定义中间件逻辑（如需）。
- **`KnowledgeBaseCompanionPlugin/PackageTools/`**: 活字格插件打包工具，用于将代码编译并打包为 `.fcp` 插件包。
- **`plans/`**: 项目开发计划与设计文档。

## 主要功能

插件提供了以下服务端命令，方便在活字格逻辑中直接调用：

1.  **文档转文本（访问链接）**: 通过 URL 下载文件并转换为 Markdown，支持智能切块。
2.  **文档转文本（文件内容）**: 直接处理 Data URI 格式的文件内容，无需额外文件存储。
3.  **文本切块**: 基于语义的智能文本切分，适合 RAG 场景。
4.  **文本嵌入**: 将文本转换为 384 维向量。
5.  **文本重排序**: 对检索结果进行语义精排，大幅提升检索准确率。

### 图片处理模式
- **OCR**: 基础文字识别。
- **VL**: Vision API 智能理解。
- **VL-Page**: 增强型页面识别（**需要 API 服务版本 >= 2.5.0**）。

## 使用条件

1.  **API 服务**: 必须拥有一个可访问的 [知识库伴侣 API 服务](https://gitee.com/low-code-dev-lab/markitdown-api) 实例（建议使用 Docker 部署）。
2.  **活字格版本**: 建议使用活字格 **v11.0.103.0** 或更高版本。
3.  **网络连接**: 活字格服务器必须能够访问到 API 服务所在的地址。
4.  **配置**: 在使用命令时，需正确配置 API 服务的 `Host` 地址（默认为 `http://localhost:8300`）。

## 开发与打包

### 编译
使用 IDE 或命令行运行以下命令进行编译：
```bash
dotnet build KnowledgeBaseCompanionPlugin\KnowledgeBaseCompanion.sln
```

---
*注：本项目仅为活字格插件工程，后端服务的获取、部署及模型配置请参考 [原项目仓库](https://gitee.com/low-code-dev-lab/markitdown-api)。*