GPT-Brain/Documentation/README_JP.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)の[セカンドブレイン](https://www.youtube.com/watch?v=1k2JpJRIoAA&ab_channel=AllAboutAI)の動画にインスパイアされています。ぜひ応援をご検討ください！*。

*💡私はプロのプログラマーではなく、Pythonにもかなり慣れていないため、このプロジェクトにはバグが含まれているかもしれません。もし何か問題があれば、[Issues section](https://github.com/sean1832/GPT-Brain/issues)で提案してください。*

### フィーチャー
- [x] [OpenAI GPT-3](https://platform.openai.com/docs/models/gpt-3)を使って、レスポンスを生成します。
- [x] [OpenAIエンベッディング](https://platform.openai.com/docs/guides/embeddings/what-are-embeddings)を使用して、質問とノートの内容を意味的に比較し、検索を強化します。
- [x] 設定可能なプロンプト。
- [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] ニーズに応じた言語モデルの選択。
- [x] OpenAI言語モデルの構成に対する基本的および高度なパラメータースライダー。。

### Todo
- [x] ~~ライブラリの更新を行うバッチスクリプト。~~
- [x]　~~バージョニング。~~
- [x] ~~パラメータに関するヒント。~~
- [x] ~~多言語UI。~~
- [x] ~~多言語検索に対応。~~
- [ ] ユーザー向けの詳細なドキュメントを提供する。
- [ ] 新バージョンの自動アップデート
- [ ] Windows用をリリース。

## 設置
### 1. 必要なもの
- **[python 3.11](https://www.python.org/downloads)** をインストール | [Pythonインストール方法解説 (YouTube)](https://youtu.be/HBxCHonP6Ro?t=105)
- OpenAI **[APIキー](https://platform.openai.com/account/api-keys)**
### 2. 初めてのセットアップする
1. `setup.bat`を起動する。
2. OpenAI API キーを入力る。

### 3. プロジェクトを起動する
- `run-webUI.bat`を起動する。


## デモ
![](images/demo_menu_jp.gif)
### メインページ
![screenshot1](images/menu_jp.png)
### 脳内記憶
![screenshot2](images/memory_jp.png)