Merge pull request #57 from eltociear/add-japanese-docs

docs: add Japanese README and TUTORIAL

README.md

@@ -1,4 +1,4 @@
-English | [简体中文](README_zh.md)
+English | [简体中文](README_zh.md) | [日本語](README_ja.md)
 
 [![VectorVein](resources/images/vector-vein-with-text-primary-en.svg)](https://vectorvein.ai)
 
@@ -179,4 +179,4 @@ After packaging, the executable file will be generated in the**backend/dist** di
 
 ## 📄 License
 
-VectorVein is an open-source software that supports personal non-commercial use. Please refer to [LICENSE](LICENSE.md) for specific agreements.
+VectorVein is an open-source software that supports personal non-commercial use. Please refer to [LICENSE](LICENSE.md) for specific agreements.

README_ja.md

@@ -0,0 +1,180 @@
+ [English](README_en.md) | [简体中文](README_zh.md) | 日本語
+
+ [![ベクトル静脈](resources/images/vector-vein-with-text-primary-zh.svg)](https://vectorvein.com)
+
+# 🔀 ベクトル静脈 VectorVein
+
+AIの力を利用して、個人の知識ベースと自動化ワークフローを構築します。
+
+プログラミング不要で、ドラッグ＆ドロップだけで強力なワークフローを作成し、すべてのタスクを自動化します。
+
+ [![オンライン版ベクトル静脈](resources/images/demo-zh.gif)](https://github.com/AndersonBY/vector-vein)
+
+ベクトル静脈は、[LangChain](https://github.com/hwchase17/langchain) および [langflow](https://github.com/logspace-ai/langflow) に触発されて開発されたノーコードAIワークフローソフトウェアであり、大規模言語モデルの強力な能力を組み合わせ、ユーザーが簡単なドラッグ＆ドロップで日常のさまざまなワークフローをインテリジェントかつ自動化することを目的としています。
+
+## 🌐 オンライン体験
+
+[こちら](https://vectorvein.com) でベクトル静脈のオンライン版を体験できます。ダウンロードやインストールは不要です。
+
+公式サイト [オンラインドキュメント](https://vectorvein.com/help/docs/introduction)
+
+## 📦 インストールと設定
+
+### インストール
+
+[リリースページ](https://github.com/AndersonBY/vector-vein/releases/) からVectorVeinをダウンロードし、プログラムを開くと、インストールディレクトリにデータベースと静的ファイルリソースを保存するための「data」フォルダが作成されます。
+
+VectorVeinはpywebviewを使用して構築されており、webview2ランタイムが必要です。ソフトウェアが開かない場合は、webview2ランタイムを手動でダウンロードする必要があるかもしれません。ダウンロードリンク：[https://developer.microsoft.com/ja-jp/microsoft-edge/webview2/](https://developer.microsoft.com/ja-jp/microsoft-edge/webview2/)
+
+### 設定
+
+ソフトウェアのほとんどのワークフローやエージェントはAI大規模言語モデルの使用を伴うため、少なくとも1つの大規模言語モデルの有効な設定を提供する必要があります。ワークフローでは、使用する大規模言語モデルをインターフェースで確認できます。以下の画像のように。
+
+![ワークフローで使用されるLLM](resources/images/workflow-llm-use-zh.jpg)
+
+#### リモート大規模言語モデルインターフェースの設定
+
+ソフトウェアが正常に開いたら、設定ボタンをクリックし、「大規模言語モデル」タブでOpenAI/Moonshot/零一万勿/智谱AI/AnthropicのAPIキーを入力して、ローカル以外のAI機能を使用します。
+
+![LLM設定](resources/images/settings1-zh.jpg)
+
+#### ローカル大規模言語モデルインターフェースの設定
+
+ローカル大規模言語モデルを使用する場合は、「ローカル大規模言語モデル」タブでローカルモデルの設定情報を入力します。現在、OpenAI互換のインターフェース（LM-Studio、Ollama、vLLMなど）をサポートしています。
+
+![ローカルLLM設定](resources/images/settings2-zh.jpg)
+
+> LM-StudioのAPIベースは通常http://localhost:1234/v1/です。
+> 
+> OllamaのAPIベースは通常http://localhost:11434/v1/です。
+>
+> 設定を完了したら、まず「モデルファミリーを保存」をクリックし、その後「設定を保存」をクリックします。
+
+#### 音声認識の設定
+
+現在、OpenAI/Deepgramの音声認識サービスがサポートされています。OpenAIサービスの場合、大規模言語モデルと同じ設定を使用するか、OpenAI API互換の音声認識サービス（Groqなど）を設定できます。
+
+![音声認識設定](resources/images/asr-settings1-zh.jpg)
+
+### 埋め込み設定
+
+ベクトルデータを使用してベクトル検索を実行する必要がある場合、OpenAIが提供する埋め込み（Embedding）サービスを使用するか、「埋め込みモデル」設定でローカルの埋め込みサービスを設定できます。現在、サポートされているローカル埋め込みサービスは、[text-embeddings-inference](https://github.com/huggingface/text-embeddings-inference)を自分でセットアップする必要があります。
+
+![ローカル埋め込み設定](resources/images/embedding-settings1-zh.jpg)
+
+### ショートカット設定
+
+日常の使用を容易にするために、エージェントとの音声会話を迅速に開始するためのショートカットを設定できます。ショートカットを使用して起動すると、音声認識を介してエージェントと直接対話できます。事前に音声認識サービスが正しく設定されていることを確認することが重要です。
+
+**スクリーンショットを含む**とは、会話を開始すると同時に画面のスクリーンショットを撮り、会話に添付ファイルとしてアップロードすることを意味します。
+
+![ショートカット設定](resources/images/shortcut-settings1-zh.jpg)
+
+#### ローカルのStable Diffusion APIについて
+
+自分のローカルで実行しているStable Diffusion APIを使用するには、webui-user.batの起動項目に--apiパラメータを追加する必要があります。つまり、
+
+```
+set COMMANDLINE_ARGS=--api
+```
+
+## 💻 使用方法
+
+### 📖 基本概念
+
+ワークフローは、入力、出力、および入力がどのように処理されて出力結果に到達するかを含む作業タスクプロセスを表します。
+
+いくつかの例：
+
+- **翻訳ワークフロー**：入力は英語のWord文書で、出力もWord文書です。入力された中国語文書を翻訳して中国語文書を生成するワークフローを設計できます。
+- **マインドマップワークフロー**：翻訳ワークフローの出力をマインドマップに変更すると、英語のWord文書を読み取り、中国語のマインドマップに要約するワークフローを取得できます。
+- **ウェブ記事の要約ワークフロー**：マインドマップワークフローの入力をウェブ記事のURLに変更すると、ウェブ記事を読み取り、中国語のマインドマップに要約するワークフローを取得できます。
+- **顧客の苦情の自動分類ワークフロー**：入力は苦情内容を含む表で、分類する必要があるキーワードをカスタマイズできます。苦情を自動的に分類し、分類結果を含むExcel表を自動生成します。
+
+### 🔎 ユーザーインターフェース
+
+各ワークフローには**ユーザーインターフェース**と**エディターインターフェース**があります。ユーザーインターフェースは日常のワークフロー操作に使用され、エディターインターフェースはワークフローの編集に使用されます。通常、ワークフローを設計した後は、ユーザーインターフェースで実行するだけで、エディターインターフェースで変更する必要はありません。
+
+![ユーザーインターフェース](resources/images/user-interface1-zh.jpg)
+
+ユーザーインターフェースは上記のように表示され、入力、出力、およびトリガー（通常は実行ボタン）の3つの部分に分かれています。日常の使用では、直接内容を入力し、実行ボタンをクリックして結果を出力エリアで確認できます。
+
+実行されたワークフローを表示するには、**ワークフロー実行記録**をクリックします。以下の図のように表示されます。
+
+![ワークフロー実行記録](resources/images/workflow-record-zh.jpg)
+
+### ✏️ ワークフローの作成
+
+公式テンプレートを自分のワークフローに追加するか、新しいワークフローを作成できます。最初は公式テンプレートを使用してワークフローの使用方法に慣れることをお勧めします。
+
+![ワークフローエディターインターフェース](resources/images/editor-zh.jpg)
+
+ワークフローエディターインターフェースは上記のように表示されます。上部で名前、タグ、および詳細な説明を編集できます。左側はワークフローのノードリスト、右側はワークフローのキャンバスです。左側から必要なノードをドラッグしてキャンバスに配置し、ノードを接続してワークフローを形成します。
+
+簡単なクローラー+AI要約マインドマップワークフローの作成チュートリアルを[こちら](TUTORIAL_ja.md)で確認できます。
+
+この[オンラインインタラクティブチュートリアル](https://vectorvein.com/workspace/workflow/editor/tutorial)も試してみてください。
+
+## 🛠️ 開発とデプロイ
+
+### 環境要件
+
+- バックエンド
+  - Python 3.8 ~ Python 3.11
+  - [PDM](https://pdm.fming.dev/latest/#installation)のインストール
+
+- フロントエンド
+  - Vue3
+  - Vite
+
+### プロジェクト開発
+
+**backend**ディレクトリで以下のコマンドを実行して依存関係をインストールします：
+
+#### Windows
+```bash
+pdm install
+```
+
+#### Mac
+```bash
+pdm install -G mac
+```
+
+通常、PDMはシステムのPythonを自動的に見つけ、仮想環境を作成して依存関係をインストールします。
+
+インストールが完了したら、以下のコマンドを実行してバックエンド開発サーバーを起動し、実行結果を確認します：
+
+```bash
+pdm run dev
+```
+
+フロントエンドコードを変更する必要がある場合は、**frontend**ディレクトリで以下のコマンドを実行して依存関係をインストールします：
+
+```bash
+pnpm install
+```
+
+> プロジェクトコードを初めてプルする場合も、`pnpm install`を実行してフロントエンド依存関係をインストールする必要があります。
+>
+> フロントエンドコードをまったく開発する必要がない場合は、リリースバージョンから`web`フォルダを`backend`フォルダにコピーするだけで済みます。
+
+フロントエンド依存関係がインストールされたら、フロントエンドコードをバックエンドの静的ファイルディレクトリにコンパイルする必要があります。プロジェクトにはショートカットコマンドが提供されています。**backend**ディレクトリで以下のコマンドを実行してフロントエンドリソースをパッケージングおよびコピーします：
+
+```bash
+pdm run build-front
+```
+
+### ソフトウェアのパッケージング
+
+プロジェクトはpyinstallerを使用してパッケージングされています。**backend**ディレクトリで以下のコマンドを実行して実行可能ファイルにパッケージングします：
+
+```bash
+pdm run build
+```
+
+パッケージングが完了すると、**backend/dist**ディレクトリに実行可能ファイルが生成されます。
+
+## 📄 ライセンス
+
+ベクトル静脈はオープンソースソフトウェアであり、個人の非商用利用をサポートしています。具体的な契約については、[LICENSE](LICENSE.md)を参照してください。

README_zh.md

@@ -1,4 +1,4 @@
- [English](README_en.md) | 简体中文
+ [English](README_en.md) | 简体中文 | [日本語](README_ja.md)
 
  [![向量脉络](resources/images/vector-vein-with-text-primary-zh.svg)](https://vectorvein.com)