GPT-Brain/Documentation/README_CN.md

🧠 GPT 大脑

中文说明 | 日本語説明書 | English

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

💡此项目由youtuber All About AI 的视频 Second Brain启发。请关注他的频道。

💡本人并非专业程序猿，并且是一个python小白，此项目可能会出现各种bug。如果你遇到bug，请在问题栏里提出，我会尽可能的进行修补。

简介

本程序利用GPT-3和3.5的能力，提供对原子笔记内容的概括，以及针对笔记的特定内容的回答。 该程序扫描指定目录（通常是包含多个笔记的vault），并将所有笔记的内容附加到单个文件中。 该文件随后用作用户查询的上下文。程序能够识别笔记内容之间的关系，并生成一个精炼的回答，概括关键要点。

尽管该程序与使用markdown或txt的其他笔记软件兼容，但它主要是针对Obsidian设计的。

功能

• 使用 OpenAI GPT-3和 GPT-3.5 (ChatGPT) 生成回答。
• 使用 OpenAI embedding 对笔记内容和问题进行对称比较，以增强搜索效果。
• 可配置prompt。
• 可个性化的个人背景信息以获得更贴切的答案。
• 与 Obsidian note 目录相连，以便进行简单的笔记内容更新。
• 笔记内容预览 & 直接修改。
• 使用分隔符对笔记解析，以进行有选择性的文本写入。
• Obsidian YAML frontmatter 过滤。
• OpenAI API 密钥管理。
• 提供4种语言模型选择以适应不同需求。
• 基本和高级参数滑块，以便于调整OpenAI语言模型配置。

未来计划

• 支持PDF笔记格式。
• 支持PDF OCR扫描。
• 支持Word文档格式。

安装

1. 所需条件

• 安装 python 3.11 | python 安装教程(Bilibili)
• OpenAI API 密钥（需要注册OpenAI账号）
• (可选) 安装 GitHub Desktop 或者 Git | GitHub Desktop 安装教程(Bilibili)
• (可选) 安装 Obsidian (黑曜石笔记)

2. 首次设置

1. 下载本仓库
2. 运行 SETUP.bat
3. 输入您的 OpenAI API 密钥

3. 运行

• 运行 RUN.bat

demo

主页

大脑记忆（笔记内容）