# 星穹智库

**Repository Path**: xcpcn/Astral-Archives

## Basic Information

- **Project Name**: 星穹智库
- **Description**: 星穹智库是一个基于Python开发的星穹铁道资料智能查询分析系统。系统集成了现代向量数据库、大规模语言模型等技术，为玩家提供准确、快速的游戏资料检索服务。
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-05
- **Last Updated**: 2025-05-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 星穹智库 (Astral Archives)
# 星穹铁道智能资料查询系统

星穹智库是一个基于Python开发的星穹铁道资料智能查询分析系统。系统集成了现代向量数据库、大规模语言模型等技术，为玩家提供准确、快速的游戏资料检索服务。

## 🌟 特色功能

- 海量资料：收录超过800万字符的BWiki权威资料
- 智能检索：基于语义的相似度搜索，而非简单的关键词匹配
- 高性能：采用FAISS向量数据库，毫秒级的查询响应
- 友好界面：简洁的命令行交互界面，支持丰富的结果展示
- MCP服务：支持作为微服务集成到其他系统

## 🛠 技术栈

- Python 3.8+
- FAISS向量数据库
- BGE-M3 Embedding模型
- Rich CLI界面库
- FastMCP微服务框架

## 🚀 快速开始

### 安装依赖

```bash
pip install -r requirements.txt
```

### 配置

1. 在项目根目录创建 `api_key.py` 文件
2. 添加您的API密钥：
```python
API_KEY = "your_api_key_here"
```

### 运行

```bash
# 构建索引（首次运行需要）
python wiki_search.py

# 启动交互式搜索
python wiki_search.py

# 启动MCP服务
python wiki_mcp.py
```

## 📖 使用示例

```python
from wiki_api import WikiSearchAPI

# 初始化API
wiki_api = WikiSearchAPI()

# 执行搜索
success, message, results, timestamp = wiki_api.search(
    query="星穹列车成员",
    top_k=3,
    min_score=0.4
)

# 处理搜索结果
if success:
    for result in results:
        print(f"相关度: {result['score']:.3f}")
        print(f"内容: {result['text'][:200]}...")
```

## 📝 API文档

### WikiSearchAPI

主要的搜索API接口，提供以下方法：

- `search(query, top_k=5, min_score=0.3)`: 执行文本搜索
- `save_search_results(results, output_file)`: 保存搜索结果

### MCP服务

通过 `wiki_mcp.py` 提供的HTTP接口：

- `POST /tool/search_wiki`: 执行Wiki搜索
  - 参数：query, top_k, min_score, save_results

## 📄 开源协议

MIT License

## 🤝 贡献指南

欢迎提交Issue和Pull Request来完善项目。在提交PR之前，请确保：

1. 代码风格符合PEP 8规范
2. 添加了必要的测试用例
3. 更新了相关文档

## 🙏 致谢

- [BWiki](https://wiki.biligame.com/sr/) - 提供了丰富的游戏资料
- [FAISS](https://github.com/facebookresearch/faiss) - 高性能向量检索库
- [BGE-M3](https://huggingface.co/BAAI/bge-m3) - 优秀的中文Embedding模型