GPT-Brain/Documentation/README_CN.md

# 🧠 GPT 大脑
[![python](https://img.shields.io/badge/python-3.11-blue)](https://www.python.org/downloads/release/python-3112/)

>**[中文说明](./README_CN.md)** | **[日本語説明書](README_JP.md)** | **[English](../README.md)**

*⭐️ 喜欢这个仓库? 请给个星!*

*💡此项目由youtuber [All About AI](https://www.youtube.com/@AllAboutAI) 的视频 [Second Brain](https://www.youtube.com/watch?v=1k2JpJRIoAA&ab_channel=AllAboutAI)启发。请关注他的频道。*

*💡本人并非专业程序猿，并且是一个python小白，此项目可能会出现各种bug。如果你遇到bug，请在[问题栏](https://github.com/sean1832/GPT-Brain/issues)里提出，我会尽可能的进行修补。*

### 功能
- [x] 使用 [OpenAI GPT-3](https://platform.openai.com/docs/models/gpt-3) 生成回答。
- [x] 使用 [OpenAI embedding](https://platform.openai.com/docs/guides/embeddings/what-are-embeddings) 对笔记内容和问题进行对称比较，以增强搜索效果。
- [x] 可配置prompt。
- [x] 可个性化的个人背景信息以获得更贴切的答案。
- [x] 与 [Obsidian note](https://obsidian.md/) 目录相连，以便进行简单的笔记内容更新。
- [x] 笔记内容预览 & 直接修改。
- [x] 使用分隔符对笔记解析，以进行有选择性的文本写入。
- [x] [Obsidian YAML frontmatter](https://help.obsidian.md/Editing+and+formatting/Metadata) 过滤。
- [x] OpenAI API 密钥管理。
- [x] 提供4种语言模型选择以适应不同需求。
- [x] 基本和高级参数滑块，以便于调整OpenAI语言模型配置。

### 未来计划
- [x] ~~batch脚本更新库。~~
- [x] ~~版本控制。~~
- [x] ~~参数提示。~~
- [x] ~~支持多语言UI~~。
- [x] ~~支持多语言检索。~~
- [ ] 提供详细操作指南。
- [ ] 自动更新。
- [ ] 发布windows版本。

## 安装
### 1. 所需条件
- 安装 **[python 3.11](https://www.python.org/downloads)** | [python 安装教程(Bilibili)](https://www.bilibili.com/video/BV1f3411t73m/?spm_id_from=333.337.search-card.all.click&vd_source=f96c4c534fe9f3ff6591942502d9d3a7)
- OpenAI **[API 密钥](https://platform.openai.com/account/api-keys)**（需要注册OpenAI账号）
### 2. 首次设置
1. 运行 `setup.bat`
2. 输入您的 OpenAI API 密钥

### 3. 运行
- 运行 `run-webUI.bat`


## demo
### 主页
![screenshot1](images/menu_zh.png)
### 大脑记忆（笔记内容）
![screenshot2](images/memory_zh.png)