From b13fe9a128a6f643e2c36c6a07bf6317b3e363b0 Mon Sep 17 00:00:00 2001 From: Yoichiro Hasebe Date: Fri, 29 Nov 2024 18:50:41 +0900 Subject: [PATCH] Documentation internal link problem addressed --- docs/README.md | 2 +- docs/basic-apps.md | 58 +++++++++---------- docs/basic-architecture.md | 4 +- docs/console-panel.md | 8 +-- docs/develop_apps.md | 4 +- docs/docker-access.md | 4 +- docs/faq-extra-features.md | 2 +- docs/faq-user-interface.md | 4 +- docs/ja/README.md | 2 +- docs/ja/_sidebar.md | 2 +- docs/ja/basic-apps.md | 58 +++++++++---------- docs/ja/basic-architecture.md | 4 +- docs/ja/console-panel.md | 8 +-- docs/ja/develop_apps.md | 2 +- docs/ja/docker-access.md | 4 +- ...xtra-features.md => faq-extra-features.md} | 2 +- docs/ja/faq-media-files.md | 4 +- docs/ja/faq-user-interface.md | 4 +- docs/ja/jupyterlab.md | 4 +- docs/ja/language-models.md | 14 ++--- docs/ja/message-input.md | 4 +- docs/ja/monadic-mode.md | 2 +- docs/ja/python-container.md | 4 +- docs/ja/recipe-examples.md | 8 +-- docs/ja/setting-items.md | 4 +- docs/ja/shared-folder.md | 4 +- docs/ja/syntax-highlighting.md | 32 +++++----- docs/jupyterlab.md | 4 +- docs/language-models.md | 14 ++--- docs/message-input.md | 2 +- docs/monadic-mode.md | 2 +- docs/python-container.md | 4 +- docs/recipe-examples.md | 10 ++-- docs/setting-items.md | 4 +- docs/shared-folder.md | 4 +- docs/syntax-highlighting.md | 32 +++++----- docs/web-interface.md | 2 +- 37 files changed, 165 insertions(+), 165 deletions(-) rename docs/ja/{extra-features.md => faq-extra-features.md} (84%) diff --git a/docs/README.md b/docs/README.md index ddc50928..4f111a3d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # Monadic Chat -![Monadic Chat Architecture](/assets/images/monadic-chat-architecture.svg ':size=800') +![Monadic Chat Architecture](./assets/images/monadic-chat-architecture.svg ':size=800') ## Overview diff --git a/docs/basic-apps.md b/docs/basic-apps.md index e455f827..e556e984 100644 --- a/docs/basic-apps.md +++ b/docs/basic-apps.md @@ -1,6 +1,6 @@ # Basic Apps -Currently, the following basic apps are available. You can select any of the basic apps and adjust the behavior of the AI agent by changing parameters or rewriting the initial prompt. The adjusted settings can be exported/imported to/from an external JSON file. For information on how to develop your own apps, refer to the [App Development](/develop_apps.md) section. +Currently, the following basic apps are available. You can select any of the basic apps and adjust the behavior of the AI agent by changing parameters or rewriting the initial prompt. The adjusted settings can be exported/imported to/from an external JSON file. For information on how to develop your own apps, refer to the [App Development](./develop_apps.md) section. > Click the dropdown to see the recipe file of each app. The files are the same as the ones in the `main` branch of the Monadic Chat's [GitHub repository](https://github.com/yohasebe/monadic-chat). @@ -8,7 +8,7 @@ Currently, the following basic apps are available. You can select any of the bas ### Chat -![Chat app icon](/assets/icons/chat.png ':size=40') +![Chat app icon](./assets/icons/chat.png ':size=40') This is a standard chat application. The AI responds to the text input by the user. Emojis corresponding to the content are also displayed. @@ -21,7 +21,7 @@ This is a standard chat application. The AI responds to the text input by the us ### Chat Plus -![Chat app icon](/assets/icons/chat.png ':size=40') +![Chat app icon](./assets/icons/chat.png ':size=40') This is a chat application that is "monadic" and has additional features compared to the standard chat application. The AI responds to the user's text input and while doing so, it also provides additional information as follows: @@ -39,15 +39,15 @@ This is a chat application that is "monadic" and has additional features compare ### Voice Chat -![Voice Chat app icon](/assets/icons/voice-chat.png ':size=40') +![Voice Chat app icon](./assets/icons/voice-chat.png ':size=40') This application allows you to chat using voice, utilizing OpenAI's Whisper voice recognition API and the browser's speech synthesis API. The initial prompt is basically the same as the Chat app. A web browser that supports the Text to Speech API, such as Google Chrome or Microsoft Edge, is required. -![Voice input](/assets/images/voice-input-stop.png ':size=400') +![Voice input](./assets/images/voice-input-stop.png ':size=400') While the user is speaking, a waveform is displayed. When the user stops speaking, the probability value (p-value, 0 - 1) of the voice recognition result is displayed. -![Voice p-value](/assets/images/voice-p-value.png ':size=400') +![Voice p-value](./assets/images/voice-p-value.png ':size=400')
voice_chat_app.rb @@ -58,7 +58,7 @@ While the user is speaking, a waveform is displayed. When the user stops speakin ### Wikipedia -![Wikipedia app icon](/assets/icons/wikipedia.png ':size=40') +![Wikipedia app icon](./assets/icons/wikipedia.png ':size=40') This is basically the same as Chat, but for questions about events that occurred after the language model's cutoff date, which GPT cannot answer, it searches Wikipedia for answers. If the query is in a language other than English, the Wikipedia search is conducted in English, and the results are translated back into the original language. @@ -71,7 +71,7 @@ This is basically the same as Chat, but for questions about events that occurred ### Math Tutor -![Math Tutor app icon](/assets/icons/math.png ':size=40') +![Math Tutor app icon](./assets/icons/math.png ':size=40') This application responds using mathematical notation with [MathJax](https://www.mathjax.org/). It is suitable for math-related questions and answers. @@ -86,7 +86,7 @@ This application responds using mathematical notation with [MathJax](https://www ### Second Opinion -![Second Opinion app icon](/assets/icons/second-opinion.png ':size=40') +![Second Opinion app icon](./assets/icons/second-opinion.png ':size=40') This app generates an answer to your question. To verify the validity of that answer, it also asks the same question to the same LLM model and compares the answers. This application can be used to prevent hallucinations or misunderstandings in AI responses. @@ -101,7 +101,7 @@ This app generates an answer to your question. To verify the validity of that an ### Language Practice -![Language Practice app icon](/assets/icons/language-practice.png ':size=40') +![Language Practice app icon](./assets/icons/language-practice.png ':size=40') This is a language learning application where the conversation starts with the assistant's speech. The assistant's speech is played back using speech synthesis. The user starts speech input by pressing the Enter key and ends it by pressing the Enter key again. @@ -114,7 +114,7 @@ This is a language learning application where the conversation starts with the a ### Language Practice Plus -![Language Practice Plus app icon](/assets/icons/language-practice-plus.png ':size=40') +![Language Practice Plus app icon](./assets/icons/language-practice-plus.png ':size=40') This is a language learning application where the conversation starts with the assistant's speech, played back using speech synthesis. The user starts and ends speech input by pressing the Enter key. In addition to the usual response, the assistant includes linguistic advice, presented as text, not speech. @@ -128,7 +128,7 @@ This is a language learning application where the conversation starts with the a ### Translate -![Translate app icon](/assets/icons/translate.png ':size=40') +![Translate app icon](./assets/icons/translate.png ':size=40') This app translates the user's input text into another language. First, the assistant asks for the target language. Then, it translates the input text into the specified language. If you want to specify how a particular phrase should be translated, enclose the relevant part of the input text in parentheses and provide the desired translation within the parentheses. @@ -141,7 +141,7 @@ This app translates the user's input text into another language. First, the assi ### Voice Interpreter -![Voice Interpreter app icon](/assets/icons/voice-chat.png ':size=40') +![Voice Interpreter app icon](./assets/icons/voice-chat.png ':size=40') This app translates the user's voice input into another language and speaks the translation using speech synthesis. First, the assistant asks for the target language. Then, it translates the input text into the specified language. @@ -156,7 +156,7 @@ This app translates the user's voice input into another language and speaks the ### Novel Writer -![Novel Writer app icon](/assets/icons/novel.png ':size=40') +![Novel Writer app icon](./assets/icons/novel.png ':size=40') This application is for co-writing novels with the assistant. The story unfolds based on the user's prompts, maintaining consistency and flow. The AI agent first asks for the story's setting, characters, genre, and target word count. The user can then provide prompts, and the AI agent will continue the story based on those prompts. @@ -169,7 +169,7 @@ This application is for co-writing novels with the assistant. The story unfolds ### Image Generator -![Image Generator app icon](/assets/icons/image-generator.png ':size=40') +![Image Generator app icon](./assets/icons/image-generator.png ':size=40') This application generates images based on descriptions. If the prompt is not specific or is written in a language other than English, it returns an improved prompt and asks whether to proceed with the improved prompt. It uses the Dall-E 3 API internally. @@ -184,7 +184,7 @@ Images are saved in the `Shared Folder` and also displayed in the chat. ### Mail Composer -![Mail Composer app icon](/assets/icons/mail-composer.png ':size=40') +![Mail Composer app icon](./assets/icons/mail-composer.png ':size=40') This application is for drafting emails in collaboration with the assistant. The assistant drafts emails based on the user's requests and specifications. @@ -197,7 +197,7 @@ This application is for drafting emails in collaboration with the assistant. The ### Mermaid Grapher -![Mermaid Grapher app icon](/assets/icons/diagram-draft.png ':size=40') +![Mermaid Grapher app icon](./assets/icons/diagram-draft.png ':size=40') This application visualizes data using [mermaid.js](https://mermaid.js.org/). When you input any data or instructions, the agent generates Mermaid code for a flowchart and renders the image. @@ -210,7 +210,7 @@ This application visualizes data using [mermaid.js](https://mermaid.js.org/). Wh ### Music Composer -![Music Composer app icon](/assets/icons/music.png ':size=40') +![Music Composer app icon](./assets/icons/music.png ':size=40') This application creates simple sheet music using [ABC notation](https://en.wikipedia.org/wiki/ABC_notation) and plays it in Midi. Specify the instrument and the genre or style of music to be used. @@ -223,7 +223,7 @@ This application creates simple sheet music using [ABC notation](https://en.wiki ### Speech Draft Helper -![Speech Draft Helper app icon](/assets/icons/speech-draft-helper.png ':size=40') +![Speech Draft Helper app icon](./assets/icons/speech-draft-helper.png ':size=40') This application helps you draft speeches. You can ask the assistant to draft a speech based on a specific topic or provide a speech draft (plain text, Word, PDF) and ask the assistant to improve it. It can also generate an MP3 file of the speech. @@ -238,7 +238,7 @@ This application helps you draft speeches. You can ask the assistant to draft a ### Video Describer -![Video Describer app icon](/assets/icons/video.png ':size=40') +![Video Describer app icon](./assets/icons/video.png ':size=40') This application analyzes video content and describes what is happening. The app extracts frames from the video, converts them into base64 PNG images, and extracts audio data, saving it as an MP3 file. Based on this information, the AI provides a description of the visual and audio content. @@ -253,17 +253,17 @@ To use this app, store the video file in the `Shared Folder` and provide the fil ### PDF Navigator -![PDF Navigator app icon](/assets/icons/pdf-navigator.png ':size=40') +![PDF Navigator app icon](./assets/icons/pdf-navigator.png ':size=40') This application reads PDF files and allows the assistant to answer user questions based on the content. Click the `Upload PDF` button to specify the file. The content of the file is divided into segments of the length specified by `max_tokens`, and text embeddings are calculated for each segment. Upon receiving input from the user, the text segment closest to the input sentence's text embedding value is passed to GPT along with the user's input, and a response is generated based on that content. ?> The PDF Navigator app uses [PyMuPDF](https://pymupdf.readthedocs.io/en/latest/) to extract text from PDF files and the text data and its embeddings are stored in [PGVector](https://github.com/pgvector/pgvector) database. -![PDF button](/assets/images/app-pdf.png ':size=700') +![PDF button](./assets/images/app-pdf.png ':size=700') -![Import PDF](/assets/images/import-pdf.png ':size=400') +![Import PDF](./assets/images/import-pdf.png ':size=400') -![PDF DB Panel](/assets/images/monadic-chat-pdf-db.png ':size=400') +![PDF DB Panel](./assets/images/monadic-chat-pdf-db.png ':size=400')
pdf_navigator_app.rb @@ -274,7 +274,7 @@ This application reads PDF files and allows the assistant to answer user questio ### Content Reader -![Content Reader app icon](/assets/icons/document-reader.png ':size=40') +![Content Reader app icon](./assets/icons/document-reader.png ':size=40') This application features an AI chatbot that examines and explains the content of provided files or web URLs in a clear, beginner-friendly manner. Users can upload files or URLs containing various text data, including programming code. If a URL is mentioned in the prompt message, the app automatically retrieves and integrates the content into the conversation with GPT. @@ -304,7 +304,7 @@ Supported file formats: ### Code Interpreter -![Code Interpreter app icon](/assets/icons/code-interpreter.png ':size=40') +![Code Interpreter app icon](./assets/icons/code-interpreter.png ':size=40') This application allows the AI to create and execute program code. The execution of the program uses a Python environment within a Docker container. Text data and images obtained as execution results are saved in the `Shared Folder` and also displayed in the chat. If you have a file (such as Python code or CSV data) that you want the AI to read, save the file in the `Shared Folder` and specify the file name in the User message. If the AI cannot find the file location, please verify the file name and inform the message that it is accessible from the current code execution environment. @@ -317,7 +317,7 @@ This application allows the AI to create and execute program code. The execution ### Coding Assistant -![Coding Assistant app icon](/assets/icons/coding-assistant.png ':size=40') +![Coding Assistant app icon](./assets/icons/coding-assistant.png ':size=40') This application is designed for writing computer program code. You can interact with an AI configured as a professional software engineer. It answers various questions, writes code, makes appropriate suggestions, and provides helpful advice through user prompts. @@ -332,12 +332,12 @@ This application is designed for writing computer program code. You can interact ### Jupyter Notebook -![Jupyter Notebook app icon](/assets/icons/jupyter-notebook.png ':size=40') +![Jupyter Notebook app icon](./assets/icons/jupyter-notebook.png ':size=40') This application allows the AI to create Jupyter Notebooks, add cells, and execute code within the cells based on user requests. The execution of the code uses a Python environment within a Docker container. The created Notebook is saved in the `Shared Folder`. > You can start or stop JupyterLab by asking the AI agent. Alternatively, you can use the `Start JupyterLab` or `Stop JupyterLab` menu items in the `Console Panel` menu bar. -

![Action menu](/assets/images/action-menu.png ':size=150') +

![Action menu](./assets/images/action-menu.png ':size=150')
jupyter_notebook_app.rb diff --git a/docs/basic-architecture.md b/docs/basic-architecture.md index 17f6080d..65145b2b 100644 --- a/docs/basic-architecture.md +++ b/docs/basic-architecture.md @@ -6,7 +6,7 @@ Both users and AI agents can access the Docker container, allowing them to colla It also provides a mechanism for sharing data between the host computer and individual Docker containers. This allows users to seamlessly collaborate with the virtual environment, providing necessary files to the AI agent and retrieving files generated by the AI agent. -![Basic Architecture](/assets/images/basic-architecture.svg ':size=800') +![Basic Architecture](./assets/images/basic-architecture.svg ':size=800') # Standard Docker Containers @@ -22,7 +22,7 @@ This container is used to run Python scripts that extend the functionality of Mo This container is used to operate a virtual web browser using Selenium for web scraping. **pgvector Container** (`monadic-chat-pgvector-container`) -This container is used to store text embedding vector data on PostgreSQL for using pgvector. For more information on adding Docker containers, see [Adding Docker Containers](/adding-containers.md). +This container is used to store text embedding vector data on PostgreSQL for using pgvector. For more information on adding Docker containers, see [Adding Docker Containers](./adding-containers.md). You can install new software on a Docker container or edit files to extend the functionality of Monadic Chat. diff --git a/docs/console-panel.md b/docs/console-panel.md index 67c62147..4d8cac8f 100644 --- a/docs/console-panel.md +++ b/docs/console-panel.md @@ -2,7 +2,7 @@ ## Console Button Items -![Monadic Chat Console](/assets/images/monadic-chat-console.png ':size=700') +![Monadic Chat Console](./assets/images/monadic-chat-console.png ':size=700') **Start** Launch Monadic Chat. The initial startup may take some time due to environment setup on Docker. @@ -23,9 +23,9 @@ Exit the Monadic Chat Console. ## Console Menu Items -![Console Menu](/assets/images/console-menu.png ':size=300') +![Console Menu](./assets/images/console-menu.png ':size=300') -![Action Menu](/assets/images/action-menu.png ':size=150') +![Action Menu](./assets/images/action-menu.png ':size=150') **Rebuild All**
Rebuild all Docker images and containers for Monadic Chat. @@ -56,7 +56,7 @@ Import PDF document data exported by Monadic Chat's export feature into the PGVe ## API Token Settings Panel -![Settings Panel](/assets/images/settings-panel.png ':size=600') +![Settings Panel](./assets/images/settings-panel.png ':size=600') All settings here are saved in the `~/monadic/data/.env` file. diff --git a/docs/develop_apps.md b/docs/develop_apps.md index 03d23bb9..ee9d8755 100644 --- a/docs/develop_apps.md +++ b/docs/develop_apps.md @@ -108,7 +108,7 @@ Specify the text of the system prompt. Specify the group name for grouping the app on the Base App selector on the web settings screen. Though optional, it is recommended to specify some group name to distinguish custom apps from the base apps. -There are many optional settings. See [Setting Items](/setting-items.md) for details. +There are many optional settings. See [Setting Items](./setting-items.md) for details. ## Calling Functions in the App @@ -131,7 +131,7 @@ The ways to specify the function name and arguments in `tools` are somewhat diff ### Execute Commands or Shell Scripts -You can execute commands or shell scripts in the app. The `send_command` method is used to execute commands or shell scripts. The `send_command` method is defined in the `MonadicApp` module, which is the base class for all additional apps. Commands or shell scripts are executed with the shared folder (`/monadic/data`) as the current working directory in each container. Shell scripts saved in the `scripts` directory in the shared folder on the host computer are executable in the container, and you can execute them by specifying the script name. +You can execute commands or shell scripts in the app. The `send_command` method is used to execute commands or shell scripts. The `send_command` method is defined in the `MonadicApp` module, which is the base class for all additional apps. Commands or shell scripts are executed with the shared folder (./monadic/data`) as the current working directory in each container. Shell scripts saved in the `scripts` directory in the shared folder on the host computer are executable in the container, and you can execute them by specifying the script name. The `send_command` method takes the following arguments: the name of the command or shell script to execute (`command`), the container name (`container`), and an optional message to display when the command is executed successfully (`success`). The `container` argument uses short string notation; for example, `python` represents `monadic-chat-python-container`. diff --git a/docs/docker-access.md b/docs/docker-access.md index daec15e8..b6f76a5d 100644 --- a/docs/docker-access.md +++ b/docs/docker-access.md @@ -12,10 +12,10 @@ docker exec -it monadic-chat-python-container bash When you click the Start button on the Monadic Chat console, all containers will start. Once the startup is complete, commands to access each container will be displayed. You can copy and paste these commands into the terminal to execute them. -![Start JupyterLab](/assets/images/docker-commands.png ':size=600') +![Start JupyterLab](./assets/images/docker-commands.png ':size=600') ## JupyterLab By using the `Actions/Start JupyterLab` menu in the Monadic Chat console, you can start JupyterLab, which will launch with `/monadic/data` as the current directory on the Python container. By clicking `Terminal` on the JupyterLab Launcher screen, you can access the Python container. -![JupyterLab Terminal](/assets/images/jupyterlab-terminal.png ':size=600') +![JupyterLab Terminal](./assets/images/jupyterlab-terminal.png ':size=600') diff --git a/docs/faq-extra-features.md b/docs/faq-extra-features.md index f242cbce..b80ab36c 100644 --- a/docs/faq-extra-features.md +++ b/docs/faq-extra-features.md @@ -6,5 +6,5 @@ **Q**: How can I add new programs or libraries to the Python container? -**A**: There are several ways to do this, but it is convenient to add an installation script to the `pysetup.sh` in the shared folder to install libraries during the Monadic Chat environment setup. See [Adding Libraries](/python-container?id=adding-programs-and-libraries) and [Using pysetup.sh](/python-container?id=usage-of-pysetupsh) for more information. +**A**: There are several ways to do this, but it is convenient to add an installation script to the `pysetup.sh` in the shared folder to install libraries during the Monadic Chat environment setup. See [Adding Libraries](./python-container?id=adding-programs-and-libraries) and [Using pysetup.sh](./python-container?id=usage-of-pysetupsh) for more information. diff --git a/docs/faq-user-interface.md b/docs/faq-user-interface.md index 73f4bd4d..57b95e1b 100644 --- a/docs/faq-user-interface.md +++ b/docs/faq-user-interface.md @@ -4,7 +4,7 @@ **A**: The roles of each button and icon are as follows: -![](/assets/images/message-buttons.png ':size=600') +![](./assets/images/message-buttons.png ':size=600') - **Copy**
Copies the message text to the clipboard. - **Play**
Plays the message text using speech synthesis. @@ -27,7 +27,7 @@ The active/inactive status of a message changes depending on the context size an **A**: Each role has the following function: -![](/assets/images/role-selector.png ':size=400') +![](./assets/images/role-selector.png ':size=400') - **User**
Normally select this. Enter a message as a user and immediately send it to the AI agent for a response. - **User (to add to past messages)**
Enter a message as a user, but use it to add to past messages as part of the context. Do not request a direct response from the AI agent. diff --git a/docs/ja/README.md b/docs/ja/README.md index 2c2618c5..f3d59794 100644 --- a/docs/ja/README.md +++ b/docs/ja/README.md @@ -1,6 +1,6 @@ # Monadic Chat -![Monadic Chat Architecture](/assets/images/monadic-chat-architecture.svg ':size=800') +![Monadic Chat Architecture](./assets/images/monadic-chat-architecture.svg ':size=800') ## 概要 diff --git a/docs/ja/_sidebar.md b/docs/ja/_sidebar.md index 690ba122..67bd9fbd 100644 --- a/docs/ja/_sidebar.md +++ b/docs/ja/_sidebar.md @@ -34,7 +34,7 @@ - [ユーザー・インターフェイス](/ja/faq-user-interface.md) - [メディアファイルの送信](/ja/faq-media-files.md) - [音声インタラクション](/ja/faq-voice-interaction.md) - - [機能の追加](/ja/extra-features.md) + - [機能の追加](/ja/faq-extra-features.md) - [更新履歴](/ja/changelog.md) diff --git a/docs/ja/basic-apps.md b/docs/ja/basic-apps.md index e8392c5b..d9402956 100644 --- a/docs/ja/basic-apps.md +++ b/docs/ja/basic-apps.md @@ -1,6 +1,6 @@ # 基本アプリ -現在、以下の基本アプリが使用可能です。いずれかの基本アプリを選択し、パラメータを変更したり、初期プロンプトを書き換えたりすることで、AIエージェントの挙動を調整できます。調整した設定は、外部のJSONファイルにエクスポート／インポートできます。独自のアプリを作る方法については[アプリの開発](develop-apps.md)を参照してください。 +現在、以下の基本アプリが使用可能です。いずれかの基本アプリを選択し、パラメータを変更したり、初期プロンプトを書き換えたりすることで、AIエージェントの挙動を調整できます。調整した設定は、外部のJSONファイルにエクスポート／インポートできます。独自のアプリを作る方法については[アプリの開発](develop_apps.md)を参照してください。 ?> 各アプリの説明の下のドロップダウンをクリックすると、アプリのソースコードが表示されます。ソースコードはMonadic Chatの[Githubレポジトリ](https://github.com/yohasebe/monadic-chat)の`main`ブランチでの最新版です。 @@ -8,7 +8,7 @@ ### Chat -![Chat app icon](/assets/icons/chat.png ':size=40') +![Chat app icon](./assets/icons/chat.png ':size=40') 標準的なチャットアプリケーションです。ユーザーが入力したテキストに対して、AIが応答します。内容に応じた絵文字も表示されます。 @@ -21,7 +21,7 @@ ### Chat Plus -![Chat app icon](/assets/icons/chat.png ':size=40') +![Chat app icon](./assets/icons/chat.png ':size=40') Chatアプリの拡張版で、"monadic" な振る舞いを示します。AIの回答の背後で下記の情報を保持し、随時更新します。 @@ -39,15 +39,15 @@ Chatアプリの拡張版で、"monadic" な振る舞いを示します。AIの ### Voice Chat -![Voice Chat app icon](/assets/icons/voice-chat.png ':size=40') +![Voice Chat app icon](./assets/icons/voice-chat.png ':size=40') OpenAIのWhisper API（音声認識）とブラウザの音声合成APIを用いて、音声でチャットを行うことができるアプリケーションです。初期プロンプトは基本的にChatアプリと同じです。Google Chrome、Microsoft Edgeなど、ブラウザのText to Speech APIが動作するWebブラウザが必要です。 -![Voice input](/assets/images/voice-input-stop.png ':size=400') +![Voice input](./assets/images/voice-input-stop.png ':size=400') 音声入力中は波形が表示され、音声入力が終了すると、認識の「確らしさ」を示すp-value（0〜1の値）が表示されます。 -![Voice p-value](/assets/images/voice-p-value.png ':size=400') +![Voice p-value](./assets/images/voice-p-value.png ':size=400')
voice_chat_app.rb @@ -58,7 +58,7 @@ OpenAIのWhisper API（音声認識）とブラウザの音声合成APIを用い ### Wikipedia -![Wikipedia app icon](/assets/icons/wikipedia.png ':size=40') +![Wikipedia app icon](./assets/icons/wikipedia.png ':size=40') 基本的にChatと同じですが、言語モデルのカットオフ日時以降に発生したイベントに関する質問など、GPTが回答できない質問に対しては、Wikipediaを検索して回答します。問い合わせが英語以外の言語の場合、Wikipediaの検索は英語で行われ、結果は元の言語に翻訳されます。 @@ -71,7 +71,7 @@ OpenAIのWhisper API（音声認識）とブラウザの音声合成APIを用い ### Math Tutor -![Math Tutor app icon](/assets/icons/math.png ':size=40') +![Math Tutor app icon](./assets/icons/math.png ':size=40') AIチャットボットが [MathJax](https://www.mathjax.org/) の数式表記を用いて応答するアプリケーションです。数式の表示が必要なやりとりを行うのに適しています。 @@ -86,7 +86,7 @@ AIチャットボットが [MathJax](https://www.mathjax.org/) の数式表記 ### Second Opinion -![Second Opinion app icon](/assets/icons/second-opinion.png ':size=40') +![Second Opinion app icon](./assets/icons/second-opinion.png ':size=40') その質問に対する回答を生成します。その際、その回答の妥当性を確認するために、AIエージェント自身が同じLLMモデルに質問を投げ、自身の回答と比較します。AIによる回答におけるハルシネーションや誤解を防ぐために、このアプリケーションを使用することができます。 @@ -101,7 +101,7 @@ AIチャットボットが [MathJax](https://www.mathjax.org/) の数式表記 ### Language Practice -![Language Practice app icon](/assets/icons/language-practice.png ':size=40') +![Language Practice app icon](./assets/icons/language-practice.png ':size=40') アシスタントの発話から会話が始まる語学学習アプリケーションです。アシスタントの発話は音声合成で再生されます。ユーザーは、Enterキーを押して発話入力を開始し、もう一度Enterキーを押して発話入力を終了します。 @@ -114,7 +114,7 @@ AIチャットボットが [MathJax](https://www.mathjax.org/) の数式表記 ### Language Practice Plus -![Language Practice Plus app icon](/assets/icons/language-practice-plus.png ':size=40') +![Language Practice Plus app icon](./assets/icons/language-practice-plus.png ':size=40') アシスタントの発話から会話が始まる語学学習アプリケーションです。アシスタントの発話は音声合成で再生されます。ユーザーは、Enterキーを押して発話入力を開始し、もう一度Enterキーを押して発話入力を終了します。アシスタントは、通常の応答に加えて、言語的なアドバイスを含めます。言語的なアドバイスは、音声ではなくテキストとしてのみ提示されます。 @@ -127,7 +127,7 @@ AIチャットボットが [MathJax](https://www.mathjax.org/) の数式表記 ### Translate -![Translate app icon](/assets/icons/translate.png ':size=40') +![Translate app icon](./assets/icons/translate.png ':size=40') ユーザーの入力テキストを別の言語に翻訳します。まず、AIアシスタントが翻訳先の言語を尋ねます。次に、ユーザーの入力テキストを指定された言語に翻訳します。特定の表現に関して、それらをどのように訳すかを指定したい場合は、入力テキストの該当箇所に括弧を付け、括弧内に翻訳表現を指定してください。 @@ -140,7 +140,7 @@ AIチャットボットが [MathJax](https://www.mathjax.org/) の数式表記 ### Voice Interpreter -![Voice Interpreter app icon](/assets/icons/voice-chat.png ':size=40') +![Voice Interpreter app icon](./assets/icons/voice-chat.png ':size=40') ユーザーが音声入力で与えた内容を別の言語に翻訳し、音声合成で発話します。まず、アシスタントは翻訳先の言語を尋ねます。次に、入力されたテキストを指定された言語に翻訳します。 @@ -155,7 +155,7 @@ AIチャットボットが [MathJax](https://www.mathjax.org/) の数式表記 ### Novel Writer -![Novel Writer app icon](/assets/icons/novel.png ':size=40') +![Novel Writer app icon](./assets/icons/novel.png ':size=40') アシスタントと共同で小説を執筆するためのアプリケーションです。ユーザーのプロンプトに基づいてストーリーを展開し、一貫性と流れを維持します。AIエージェントは最初に、物語の舞台、登場人物、ジャンル、最終的な文章の量を尋ねます。その後、ユーザーが提供するプロンプトに基づいて、AIエージェントが物語を展開します。 @@ -168,7 +168,7 @@ AIチャットボットが [MathJax](https://www.mathjax.org/) の数式表記 ### Image Generator -![Image Generator app icon](/assets/icons/image-generator.png ':size=40') +![Image Generator app icon](./assets/icons/image-generator.png ':size=40') 説明に基づいて画像を生成するアプリケーションです。プロンプトが具体的でない場合や、英語以外の言語で書かれている場合は、改善されたプロンプトを返し、改善されたプロンプトで続行するかどうかを尋ねます。内部でDall-E 3 APIを使用しています。 @@ -183,7 +183,7 @@ AIチャットボットが [MathJax](https://www.mathjax.org/) の数式表記 ### Mail Composer -![Mail Composer app icon](/assets/icons/mail-composer.png ':size=40') +![Mail Composer app icon](./assets/icons/mail-composer.png ':size=40') アシスタントと共同でメールの草稿を作成するためのアプリケーションです。ユーザーの要望や指定に応じて、アシスタントがメールの草稿を作成します。 @@ -196,7 +196,7 @@ AIチャットボットが [MathJax](https://www.mathjax.org/) の数式表記 ### Mermaid Grapher -![Mermaid Grapher app icon](/assets/icons/diagram-draft.png ':size=40') +![Mermaid Grapher app icon](./assets/icons/diagram-draft.png ':size=40') [mermaid.js](https://mermaid.js.org/) を活用してデータを視覚化するアプリケーションです。任意のデータや指示文を入力すると、エージェントがフローチャートのMermaid コードを生成して画像を描画します。 @@ -209,7 +209,7 @@ AIチャットボットが [MathJax](https://www.mathjax.org/) の数式表記 ### Music Composer -![Music Composer app icon](/assets/icons/music.png ':size=40') +![Music Composer app icon](./assets/icons/music.png ':size=40') [ABC](https://en.wikipedia.org/wiki/ABC_notation)記法で簡単な楽譜を作成し、Midiで演奏するアプリケーションです。使用する楽器と音楽のジャンルやスタイルを指定します。 @@ -222,7 +222,7 @@ AIチャットボットが [MathJax](https://www.mathjax.org/) の数式表記 ### Speech Draft Helper -![Speech Draft Helper app icon](/assets/icons/speech-draft-helper.png ':size=40') +![Speech Draft Helper app icon](./assets/icons/speech-draft-helper.png ':size=40') このアプリでは、AIエージェントにスピーチのドラフト作成を依頼することができます。ドラフトを一から作成することもできますし、既存のドラフトを、テキスト文字列、Wordファイル、PDFファイルの形で提出することもできます。AIエージェントはそれらを分析し、修正版を返します。また、必要であれば、スピーチをより魅力的で効果的なものにするための改善案やヒントを提供します。スピーチのmp3ファイルを提供することもできます。 @@ -237,7 +237,7 @@ AIチャットボットが [MathJax](https://www.mathjax.org/) の数式表記 ### Video Describer -![Video Describer app icon](/assets/icons/video.png ':size=40') +![Video Describer app icon](./assets/icons/video.png ':size=40') 動画コンテンツを分析し、その内容を説明するアプリケーションです。AIが動画コンテンツを分析し中で何が起こっているのかを詳細に説明します。 @@ -254,17 +254,17 @@ AIチャットボットが [MathJax](https://www.mathjax.org/) の数式表記 ### PDF Navigator -![PDF Navigator app icon](/assets/icons/pdf-navigator.png ':size=40') +![PDF Navigator app icon](./assets/icons/pdf-navigator.png ':size=40') PDFファイルを読み込み、その内容に基づいてユーザーの質問に答えるアプリケーションです。`Upload PDF` ボタンをクリックしてファイルを指定してください。ファイルの内容はmax_tokensの長さのセグメントに分割され、セグメントごとにテキスト埋め込みが計算されます。ユーザーからの入力を受け取ると、入力文のテキスト埋め込み値に最も近いテキストセグメントがユーザーの入力値とともにGPTに渡され、その内容に基づいて回答が生成されます。 ?> PDF ファイルからのテキスト抽出には、[PyMuPDF](https://pymupdf.readthedocs.io/en/latest/) ライブラリが使用されます。抽出したテキストと埋め込みデータは [PGVector](https://github.com/pgvector/pgvector) データベースに保存されます。 -![PDF button](/assets/images/app-pdf.png ':size=700') +![PDF button](./assets/images/app-pdf.png ':size=700') -![Import PDF](/assets/images/import-pdf.png ':size=400') +![Import PDF](./assets/images/import-pdf.png ':size=400') -![PDF DB Panel](/assets/images/monadic-chat-pdf-db.png ':size=400') +![PDF DB Panel](./assets/images/monadic-chat-pdf-db.png ':size=400')
pdf_navigator_app.rb @@ -275,7 +275,7 @@ PDFファイルを読み込み、その内容に基づいてユーザーの質 ### Content Reader -![Content Reader app icon](/assets/icons/document-reader.png ':size=40') +![Content Reader app icon](./assets/icons/document-reader.png ':size=40') 提供されたファイルやWeb URLの内容を調べて説明するAIチャットボットを特徴とするアプリケーションです。説明は、わかりやすく、初心者にも理解しやすいように提示されます。ユーザーは、プログラミングコードを含む、さまざまなテキストデータを含むファイルやURLをアップロードすることができます。プロンプトメッセージにURLが記載されている場合、アプリは自動的にコンテンツを取得し、GPTとの会話にシームレスに統合します。 @@ -303,7 +303,7 @@ PNGやJPEGなどの画像ファイルを読み込んで、その内容を認識 ### Code Interpreter -![Code Interpreter app icon](/assets/icons/code-interpreter.png ':size=40') +![Code Interpreter app icon](./assets/icons/code-interpreter.png ':size=40') AIにプログラムコードを作成・実行させるアプリケーションです。プログラムの実行には、Dockerコンテナ内のPython環境が使用されます。実行結果として得られたテキストデータや画像は`Shared Folder`に保存されると共に、チャット上でも表示されます。 @@ -318,7 +318,7 @@ AIに読み込ませたいファイル（PythonコードやCSVデータなど） ### Coding Assistant -![Coding Assistant app icon](/assets/icons/coding-assistant.png ':size=40') +![Coding Assistant app icon](./assets/icons/coding-assistant.png ':size=40') これはコンピュータプログラムコードを書くためのアプリケーションです。プロフェッショナルなソフトウェアエンジニアとして設定が与えられたAIと対話することができます。ユーザーからのプロンプトを通じて様々なな質問に答え、コードを書き、適切な提案を行い、役立つアドバイスを提供します。 @@ -333,12 +333,12 @@ AIに読み込ませたいファイル（PythonコードやCSVデータなど） ### Jupyter Notebook -![Jupyter Notebook app icon](/assets/icons/jupyter-notebook.png ':size=40') +![Jupyter Notebook app icon](./assets/icons/jupyter-notebook.png ':size=40') AIがJupyter Notebookを作成して、ユーザーからのリクエストに応じてセルを追加し、セル内のコードを実行するアプリケーションです。コードの実行には、Dockerコンテナ内のPython環境が使用されます。作成されたNotebookは`Shared Folder`に保存されます。 ?> Jupyterノートブックを実行するためのJupyterLabサーバーの起動と停止は、AIエージェントに自然言語で依頼する他に、Monadic Chatコンソールパネルのメニューからも行うことができます（`Start JupyterLab`, `Stop JupyterLab`）。 -

![Action menu](/assets/images/action-menu.png ':size=120') +

![Action menu](./assets/images/action-menu.png ':size=120')
diff --git a/docs/ja/basic-architecture.md b/docs/ja/basic-architecture.md index b01242af..3e77966d 100644 --- a/docs/ja/basic-architecture.md +++ b/docs/ja/basic-architecture.md @@ -6,7 +6,7 @@ Dockerコンテ内にはユーザーとAIエージェントの両方がアクセ また、ホストコンピュータと個々のDockerコンテナとの間でデータを共有するための仕組みも提供しています。これにより、ユーザーは仮想環境とシームレスに連携でき、必要なファイルをAIエージェントに提供したり、AIエージェントにより生成されたファイルを取得したりすることができます。 -![Basic Architecture](/assets/images/basic-architecture.svg ':size=800') +![Basic Architecture](./assets/images/basic-architecture.svg ':size=800') ## 標準コンテナ @@ -30,6 +30,6 @@ Seleniumを使用して仮想的なWebブラウザを操作して、Webページ Postgresql上にテキスト埋め込みのベクトルデータを保存するため、pgvectorを使用するためのコンテナです。 -?> 追加のDockerコンテナを導入する方法については、[Dockerコンテナの追加](/ja/adding-containers.md)を参照してください。 +?> 追加のDockerコンテナを導入する方法については、[Dockerコンテナの追加](./adding-containers.md)を参照してください。 diff --git a/docs/ja/console-panel.md b/docs/ja/console-panel.md index 49170803..f51946e4 100644 --- a/docs/ja/console-panel.md +++ b/docs/ja/console-panel.md @@ -2,7 +2,7 @@ ## コンソールボタン項目 -![Monadic Chat Console](/assets/images/monadic-chat-console.png ':size=700') +![Monadic Chat Console](./assets/images/monadic-chat-console.png ':size=700') **Start**
Monadic Chatを起動します。初回起動時はDocker上での環境構築のため少し時間がかかります。 @@ -24,9 +24,9 @@ Monadic Chat Consoleを終了します。 ## コンソールメニュー項目 -![Console Menu](/assets/images/console-menu.png ':size=300') +![Console Menu](./assets/images/console-menu.png ':size=300') -![Action Menu](/assets/images/action-menu.png ':size=150') +![Action Menu](./assets/images/action-menu.png ':size=150') **Rebuild All**
Monadic ChatのすべてのDockerイメージおよびコンテナを再構築します。 @@ -57,7 +57,7 @@ Monadic ChatのPGVectorデータベースに、Monadic Chatのエクスポート ## APIトークン設定パネル -![Settings Panel](/assets/images/settings-panel.png ':size=600') +![Settings Panel](./assets/images/settings-panel.png ':size=600') ここでの設定はすべて `~/monadic/data/.env` ファイルに保存されます。 diff --git a/docs/ja/develop_apps.md b/docs/ja/develop_apps.md index 0ffe411a..a9e2a280 100644 --- a/docs/ja/develop_apps.md +++ b/docs/ja/develop_apps.md @@ -118,7 +118,7 @@ end Web 設定画面の Base App セレクタ上でアプリをグループ化するためのグループ名を指定します。必須ではありませんが、独自のアプリを追加する場合には、基本アプリと区別するために何らかのグループ名を指定することが推奨されます。 -これらの他に、任意の設定項目が多数あります。[設定項目](/ja/setting-items.md)を参照してください。 +これらの他に、任意の設定項目が多数あります。[設定項目](./setting-items.md)を参照してください。 ## 関数・ツールの呼び出し diff --git a/docs/ja/docker-access.md b/docs/ja/docker-access.md index 3960c0af..757ffb0d 100644 --- a/docs/ja/docker-access.md +++ b/docs/ja/docker-access.md @@ -12,11 +12,11 @@ docker exec -it monadic-chat-python-container bash Monadic ChatコンソールでStartをクリックすると、すべてのコンテナが起動します。起動が完了すると、コンテナにアクセスするためのコマンドが表示されるので、それをコピーしてターミナルに貼り付けて実行します。 -![Start JupyterLab](/assets/images/docker-commands.png ':size=600') +![Start JupyterLab](./assets/images/docker-commands.png ':size=600') ## JupyterLab Monadic Chatコンソールの`Actions/Start JupyterLab`メニューを使用してJupyterLabを起動すると、Pythonコンテナ上の`/monadic/data`をカレントディレクトリとしてJupyterLabが起動します。JupyterLabのLauncher画面で`Terminal`をクリックすると、Pythonコンテナにアクセスできます。 -![JupyterLab Terminal](/assets/images/jupyterlab-terminal.png ':size=600') +![JupyterLab Terminal](./assets/images/jupyterlab-terminal.png ':size=600') diff --git a/docs/ja/extra-features.md b/docs/ja/faq-extra-features.md similarity index 84% rename from docs/ja/extra-features.md rename to docs/ja/faq-extra-features.md index 41dc1d78..af7aaed3 100644 --- a/docs/ja/extra-features.md +++ b/docs/ja/faq-extra-features.md @@ -8,4 +8,4 @@ **Q**: Python コンテナに新たなプログラムやライブラリを追加するにはどうすればいいですか？ -**A**: いくつかの方法がありますが、共有フォルダ内の `pysetup.sh` にインストールスクリプトを追加して、Monadic Chat の環境構築時にライブラリをインストールする方法が便利です。[ライブラリの追加](/ja/python-container?id=%e3%83%a9%e3%82%a4%e3%83%96%e3%83%a9%e3%83%aa%e3%81%ae%e8%bf%bd%e5%8a%a0) および [pysetup.sh の利用](/ja/python-container?id=pysetupsh-%e3%81%ae%e5%88%a9%e7%94%a8) を参照してください。 +**A**: いくつかの方法がありますが、共有フォルダ内の `pysetup.sh` にインストールスクリプトを追加して、Monadic Chat の環境構築時にライブラリをインストールする方法が便利です。[ライブラリの追加](./python-container?id=ライブラリの追加) および [pysetup.sh の利用](./python-container?id=pysetupsh-の利用) を参照してください。 diff --git a/docs/ja/faq-media-files.md b/docs/ja/faq-media-files.md index 10da2152..76cb363a 100644 --- a/docs/ja/faq-media-files.md +++ b/docs/ja/faq-media-files.md @@ -19,9 +19,9 @@ **Q**: PDFの内容について AI エージェントに質問することはできますか？ -**A**: はい、いくつかのやり方があります。[`PDF Navigator`](./ja/basic-apps?id=pdf-navigator) アプリでは、提供された PDF の単語埋め込みを PGVector データベースに格納して、RAG（Retrieval-Augmented Generation）の手法を用いる形で AI に回答させることができます。[`Code Interpreter`](.ja/basic-apps?id=code-interpreter) や [`Content Reader`](.ja/basic-apps?id=content-reader) アプリでは、PDF ファイルを Python コンテナ上の MuPDF4LLM で Markdown 形式に変換して、その内容を AI エージェントに読み込ませて、その内容に関する質問ができるようになっています。 +**A**: はい、いくつかのやり方があります。[`PDF Navigator`](./basic-apps?id=pdf-navigator) アプリでは、提供された PDF の単語埋め込みを PGVector データベースに格納して、RAG（Retrieval-Augmented Generation）の手法を用いる形で AI に回答させることができます。[`Code Interpreter`](./basic-apps?id=code-interpreter) や [`Content Reader`](./basic-apps?id=content-reader) アプリでは、PDF ファイルを Python コンテナ上の MuPDF4LLM で Markdown 形式に変換して、その内容を AI エージェントに読み込ませて、その内容に関する質問ができるようになっています。 上記はいずれも OpenAIの GPT-4 系列モデルを使用しています。その他のモデルを使用する場合は、`Code` 対応のアプリ（`Anthropic Claude (Code)` など）の場合、`Code Interpreter` と同様の仕組みで PDF ファイルを読み込ませることができます。 -また、Anthropic Claude を用いたアプリでは、テキスト入力ボックスの下にある `Import Image/PDF` ボタンをクリックして、PDF ファイルを直接アップロードして、内容について AI エージェントに質問することができます。詳しくは [PDF のアップロード](./ja/message-input?id=pdf-のアップロード)を参照してください。 +また、Anthropic Claude を用いたアプリでは、テキスト入力ボックスの下にある `Import Image/PDF` ボタンをクリックして、PDF ファイルを直接アップロードして、内容について AI エージェントに質問することができます。詳しくは [PDF のアップロード](./message-input?id=pdf-のアップロード)を参照してください。 diff --git a/docs/ja/faq-user-interface.md b/docs/ja/faq-user-interface.md index 7332cd63..74ac2bf7 100644 --- a/docs/ja/faq-user-interface.md +++ b/docs/ja/faq-user-interface.md @@ -4,7 +4,7 @@ **A**: それぞれのボタンとアイコンの役割は以下の通りです。 -![](/assets/images/message-buttons.png ':size=600') +![](./assets/images/message-buttons.png ':size=600') - **Copy**
メッセージのテキストをクリップボードにコピーします。 - **Play**
メッセージのテキストを音声合成して再生します。 @@ -28,7 +28,7 @@ **Q**: それぞれ次の役割があります。 -![](/assets/images/role-selector.png ':size=400') +![](./assets/images/role-selector.png ':size=400') - **User**
通常はこれを選択します。ユーザーとしてメッセージを入力し、直ちにAIエージェントに送信してレスポンスを求めます。 - **User (to add to past messages)**
ユーザーとしてメッセージを入力しますが、コンテクストの一部として過去のメッセージに追加する目的で使用します。AIエージェントからの直接的なレスポンスを求めません。 diff --git a/docs/ja/jupyterlab.md b/docs/ja/jupyterlab.md index 56a8f9f5..65151be4 100644 --- a/docs/ja/jupyterlab.md +++ b/docs/ja/jupyterlab.md @@ -6,11 +6,11 @@ Monadic Chatには、JupyterLabを起動する機能があります。JupyterLab Monadic Chatコンソールの`Actions/Start JupyterLab`メニューをクリックすると、JupyterLabが起動します。JupyterLabは、`http://localhost:8889`でアクセスできます。 -![Action menu](/assets/images/action-menu.png ':size=120') +![Action menu](./assets/images/action-menu.png ':size=120') JupyterLabを起動すると、`/monadic/data`をホームディレクトリとしてJupyterLabが起動します。このため、JupyterLab内でも共有フォルダ内のファイルにアクセスできます。 -![JupyterLab Terminal](/assets/images/jupyterlab-terminal.png ':size=600') +![JupyterLab Terminal](./assets/images/jupyterlab-terminal.png ':size=600') ## JupyterLabの停止 diff --git a/docs/ja/language-models.md b/docs/ja/language-models.md index 999bce1a..fceb139f 100644 --- a/docs/ja/language-models.md +++ b/docs/ja/language-models.md @@ -8,13 +8,13 @@ Monadic Chatではチャットおよび音声認識、音声合成、画像生 OPENAI_API_KEY=api_key ``` -OpenAIの言語モデルを用いたアプリについては、[基本アプリ](/ja/basic-apps)のセクションを参照してください。 +OpenAIの言語モデルを用いたアプリについては、[基本アプリ](./basic-apps)のセクションを参照してください。 ?> OpenAI の GPT-4o 系列および GPT-4o-mini 系列のモデルを用いたアプリでは、"Predicted Outputs" の機能が利用可能です。プロンプトの中で `__DATA__` をセパレーターとして、AI エージェントへの指示と、AI エージェントに修正・加工してもらいたいデータを区別して示すことで、AIからのレスポンスを高速化するとともにトークン数を削減することができます（参考：OpenAI: [Predicted Outputs](https://platform.openai.com/docs/guides/latency-optimization#use-predicted-outputs)）。 ## Anthropic Models -![Anthropic apps icon](/assets/icons/a.png ':size=40') +![Anthropic apps icon](./assets/icons/a.png ':size=40') ANthropicのAPIキーを設定すると、Claudeを用いたアプリを使用することができます。APIキーを設定すると、`~/monadic/data/.env` ファイルに次の形式でAPIキーが保存されます。 @@ -50,7 +50,7 @@ Chat with Claudeは、Anthropic Claude APIにアクセスして、幅広いト ## Cohere Models -![Cohere apps icon](/assets/icons/c.png ':size=40') +![Cohere apps icon](./assets/icons/c.png ':size=40') CohereのAPIキーを設定すると、Command Rを用いたアプリを使用することができます。APIキーを設定すると、`~/monadic/data/.env` ファイルに次の形式でAPIキーが保存されます。 @@ -76,7 +76,7 @@ Chat with Command Rは、Cohere APIにアクセスして、幅広いトピック ## Google Models -![Google apps icon](/assets/icons/google.png ':size=40') +![Google apps icon](./assets/icons/google.png ':size=40') Google Gemini APIキーを設定すると、Geminiを用いたアプリを使用することができます。APIキーを設定すると、`~/monadic/data/.env` ファイルに次の形式でAPIキーが保存されます。 @@ -96,7 +96,7 @@ Chat with Geminiは、Google Gemini APIにアクセスして、幅広いトピ ## Mistral Models -![Mistral apps icon](/assets/icons/m.png ':size=40') +![Mistral apps icon](./assets/icons/m.png ':size=40') Mistral AI APIキーを設定すると、Mistralを用いたアプリを使用することができます。APIキーを設定すると、`~/monadic/data/.env` ファイルに次の形式でAPIキーが保存されます。 @@ -122,7 +122,7 @@ Chat with Mistralは、Mistral AI APIにアクセスして、幅広いトピッ ## Ollama Models -![Ollama apps icon](/assets/icons/ollama.png ':size=40') +![Ollama apps icon](./assets/icons/ollama.png ':size=40') 追加のイメージとコンテナを導入することで、Ollamaを用いたアプリを使用することができます。[Ollama](https://ollama.com/)を使うと、下記のようなLLMをローカルのDocker環境で使用することができます。 @@ -131,4 +131,4 @@ Chat with Mistralは、Mistral AI APIにアクセスして、幅広いトピッ - Mistral - Gemma -Monadic ChatでOllamaを導入する方法については、[Ollamaの利用](/ja/ollama)を参照してください。 +Monadic ChatでOllamaを導入する方法については、[Ollamaの利用](./ollama)を参照してください。 diff --git a/docs/ja/message-input.md b/docs/ja/message-input.md index a3cd1a00..914fa22d 100644 --- a/docs/ja/message-input.md +++ b/docs/ja/message-input.md @@ -6,9 +6,9 @@ Monadic Chat コンソールでサーバーを起動し、Web インターフェ テキストエリアにメッセージを入力し、`Send` ボタンをクリックすると、メッセージが送信されます。音声入力を行う場合は、`Voice Input` ボタンをクリックして音声入力を開始し、`Stop` ボタンをクリックして音声入力を終了すると、Whisper API を通じて音声がテキストに変換され、テキストエリアに表示されます。 -?> 音声入力と音声合成を使って AI エージェントとのチャットをスムーズに行うためには、Web 設定画面で `Auto Speech` と `Easy Submit` をオンにしておくと便利です。[Voice Chat] (./ja/basic-apps?id=voice-chat)アプリではこれらがデフォルトで有効になっています。 +?> 音声入力と音声合成を使って AI エージェントとのチャットをスムーズに行うためには、Web 設定画面で `Auto Speech` と `Easy Submit` をオンにしておくと便利です。[Voice Chat] (./basic-apps?id=voice-chat)アプリではこれらがデフォルトで有効になっています。 -?> `Role` セレクタは、メッセージの役割を選択するためのものです。通常は `User` を選択しますが、`Assistant` や `System` を選択することで、チャットのコンテクストをを追加・加工することができます。詳しくは [FAQ](/ja/faq) を参照してください。 +?> `Role` セレクタは、メッセージの役割を選択するためのものです。通常は `User` を選択しますが、`Assistant` や `System` を選択することで、チャットのコンテクストをを追加・加工することができます。詳しくは [FAQ](./faq-user-interface) を参照してください。 ## 画像のアップロード diff --git a/docs/ja/monadic-mode.md b/docs/ja/monadic-mode.md index ac38d2be..010de2b0 100644 --- a/docs/ja/monadic-mode.md +++ b/docs/ja/monadic-mode.md @@ -2,7 +2,7 @@ MonadicモードはMonadic Chatの特徴的な機能の一つです。Monadicモードでは、それまでのチャットでなされたやり取り、すなわち文脈を、定義された形式で随時更新しながら保持し、それを参照しながらチャットを行うことができます。 -![Monadic Chat Architecture](/assets/images/monadic-messaging.svg ':size=200') +![Monadic Chat Architecture](./assets/images/monadic-messaging.svg ':size=200') ## 基本的な構造 diff --git a/docs/ja/python-container.md b/docs/ja/python-container.md index a3981a2f..11ce25d2 100644 --- a/docs/ja/python-container.md +++ b/docs/ja/python-container.md @@ -13,8 +13,8 @@ Monadic Chat では、Python コンテナを使用して Python のコードを 追加のライブラリをインストールする場合は、下記のいずれかを行なってください。 - 共有フォルダの `pysetup.sh` にインストールスクリプトを追加して、Monadic Chat の環境構築時にライブラリをインストール（下記の例を参照） -- [Dockerコンテナへのアクセス](/ja/docker-access)を参照して、Monadic Chat の環境構築後に Python コンテナにログインしてライブラリをインストール -- [Dockerコンテナの追加](/ja/adding-containers)を参照して、カスタマイズした Python コンテナを追加 +- [Dockerコンテナへのアクセス](./docker-access)を参照して、Monadic Chat の環境構築後に Python コンテナにログインしてライブラリをインストール +- [Dockerコンテナの追加](./adding-containers)を参照して、カスタマイズした Python コンテナを追加 - [GitHub Issues](https://github.com/yohasebe/monadic-chat/issues) でリクエストを送信 ## `pysetup.sh` の利用 diff --git a/docs/ja/recipe-examples.md b/docs/ja/recipe-examples.md index 93456f25..4d663de6 100644 --- a/docs/ja/recipe-examples.md +++ b/docs/ja/recipe-examples.md @@ -4,7 +4,7 @@ ## シンプルなアプリ -シンプルなアプリを開発する方法については、[シンプルなアプリの追加方法](http://localhost:3000/#/ja/develop_apps?id=シンプルなアプリの追加方法)を参照してください。 +シンプルなアプリを開発する方法については、[シンプルなアプリの追加方法](./develop_apps?id=シンプルなアプリの追加方法)を参照してください。
レシピ・ファイル例（math_tutor.rb） @@ -15,7 +15,7 @@ ## 関数・ツールの定義を含むアプリ -アプリ内でAIエージェントに関数やツールを使用させる方法については、[関数・ツールの呼び出し](http://localhost:3000/#/ja/develop_apps?id=関数・ツールの呼び出し)を参照してください。 +アプリ内でAIエージェントに関数やツールを使用させる方法については、[関数・ツールの呼び出し](./develop_apps?id=関数・ツールの呼び出し)を参照してください。
レシピ・ファイル例（wikipedia.rb） @@ -33,7 +33,7 @@ ## 出力形式の指定を含むアプリ -Monadic ChatではJSON形式で出力する場合の特別なモード（`monadic`モード）があります。詳細については[Monadicモード](/ja/monadic-mode)も参照してください。 +Monadic ChatではJSON形式で出力する場合の特別なモード（`monadic`モード）があります。詳細については[Monadicモード](./monadic-mode)も参照してください。 OpenAIの一部のモデル（`gpt-4o`など）では、レスポンスをJSON形式で行うこと確実にするために、`response_format`を指定することができます。指定方法については[OpenAI: Structured outputs](https://platform.openai.com/docs/guides/structured-outputs)を参照してください。 @@ -46,7 +46,7 @@ OpenAIの一部のモデル（`gpt-4o`など）では、レスポンスをJSON ## AIエージェントがLLMを使用するアプリ -AIエージェントに使わせる関数・ツールの中でOpenAIの言語モデルにアクセスするアプリの例です。[関数・ツール内でのLLMの使用](http://localhost:3000/#/ja/develop_apps?id=関数・ツール内でのLLMの使用)を参照してください。 +AIエージェントに使わせる関数・ツールの中でOpenAIの言語モデルにアクセスするアプリの例です。[関数・ツール内でのLLMの使用](./develop_apps?id=関数・ツール内でのLLMの使用)を参照してください。
レシピ・ファイル例（second_opinion_app.rb） diff --git a/docs/ja/setting-items.md b/docs/ja/setting-items.md index 41e0f46e..65ae8891 100644 --- a/docs/ja/setting-items.md +++ b/docs/ja/setting-items.md @@ -27,7 +27,7 @@ Web 設定画面の Base App セレクタ上でアプリをグループ化するためのグループ名を指定します。独自のアプリを追加する場合には、基本アプリと区別するために何らかのグループ名を指定することが推奨されます。 -![](/assets/images/groups.png ':size=300') +![](./assets/images/groups.png ':size=300') `model` (string) @@ -91,7 +91,7 @@ Jupyter Notebookと連携する場合に`true`を指定します（MathJaxの表 `monadic` (bool) -アプリをMonadicモードに指定します。Monadicモードについては[Monadicモード](/ja/monadic-mode)を参照してください。 +アプリをMonadicモードに指定します。Monadicモードについては[Monadicモード](./monadic-mode)を参照してください。 `prompt_suffix` (string) diff --git a/docs/ja/shared-folder.md b/docs/ja/shared-folder.md index 20089f89..dfba0127 100644 --- a/docs/ja/shared-folder.md +++ b/docs/ja/shared-folder.md @@ -4,7 +4,7 @@ Monadic Chatを最初に起動すると、`~/monadic/data`ディレクトリが Monadic Chatコンソールの`Shared Folder`ボタンをクリックすると、OS標準のファイルマネージャが起動し、共有フォルダを開くことができます。 -![Monadic Chat Console](/assets/images/monadic-chat-console.png ':size=700') +![Monadic Chat Console](./assets/images/monadic-chat-console.png ':size=700') このディレクトリにファイルを配置すると、Monadic ChatのDockerコンテナ内でそのファイルにアクセスできます。ローカルでの共有フォルダのパスは`~/monadic/data`ですが、各Dockerコンテナ内での共有フォルダのパスは、`/monadic/data`です。 @@ -37,7 +37,7 @@ Monadic Chatコンソールの`Actions/Start JupyterLab`メニューを使用し ## 共有フォルダ内の構成 -基本アプリ以外のアプリを開発したり追加したりするときには、共有フォルダ内で適切に必要なファイルやフォルダを配置する必要があります。以下は、共有フォルダ内に自動的に作成されるサブフォルダです。追加アプリの開発方法については、[追加アプリの開発](/ja/developing-apps.md)を参照してください。 +基本アプリ以外のアプリを開発したり追加したりするときには、共有フォルダ内で適切に必要なファイルやフォルダを配置する必要があります。以下は、共有フォルダ内に自動的に作成されるサブフォルダです。追加アプリの開発方法については、[追加アプリの開発](./developing-apps.md)を参照してください。 **`apps`** diff --git a/docs/ja/syntax-highlighting.md b/docs/ja/syntax-highlighting.md index e2bc8486..f3ccfadb 100644 --- a/docs/ja/syntax-highlighting.md +++ b/docs/ja/syntax-highlighting.md @@ -6,66 +6,66 @@ Monaco Editor は、シンタックス・ハイライトをサポートしてい **base16-dark** -![](/assets/images/syntax-base16-dark.png ':size=800') +![](./assets/images/syntax-base16-dark.png ':size=800') **github-dark** -![](/assets/images/syntax-github-dark.png ':size=800') +![](./assets/images/syntax-github-dark.png ':size=800') **gruvbox-dark** -![](/assets/images/syntax-gruvbox-dark.png ':size=800') +![](./assets/images/syntax-gruvbox-dark.png ':size=800') **colorful** -![](/assets/images/syntax-colorful.png ':size=800') +![](./assets/images/syntax-colorful.png ':size=800') **molokai** -![](/assets/images/syntax-molokai.png ':size=800') +![](./assets/images/syntax-molokai.png ':size=800') **monokai** -![](/assets/images/syntax-monokai.png ':size=800') +![](./assets/images/syntax-monokai.png ':size=800') **monokai_sublime** -![](/assets/images/syntax-monokai_sublime.png ':size=800') +![](./assets/images/syntax-monokai_sublime.png ':size=800') **tulip** -![](/assets/images/syntax-tulip.png ':size=800') +![](./assets/images/syntax-tulip.png ':size=800') **thankful_eyes** -![](/assets/images/syntax-thankful_eyes.png ':size=800') +![](./assets/images/syntax-thankful_eyes.png ':size=800') ## Light Themes **base16-light** -![](/assets/images/syntax-base16-light.png ':size=800') +![](./assets/images/syntax-base16-light.png ':size=800') **github-light** -![](/assets/images/syntax-github-light.png ':size=800') +![](./assets/images/syntax-github-light.png ':size=800') **gruvbox-light** -![](/assets/images/syntax-gruvbox-light.png ':size=800') +![](./assets/images/syntax-gruvbox-light.png ':size=800') **bw** -![](/assets/images/syntax-bw.png ':size=800') +![](./assets/images/syntax-bw.png ':size=800') **igor_pro** -![](/assets/images/syntax-igor_pro.png ':size=800') +![](./assets/images/syntax-igor_pro.png ':size=800') **magritte** -![](/assets/images/syntax-magritte.png ':size=800') +![](./assets/images/syntax-magritte.png ':size=800') **pastie** -![](/assets/images/syntax-pastie.png ':size=800') +![](./assets/images/syntax-pastie.png ':size=800') diff --git a/docs/jupyterlab.md b/docs/jupyterlab.md index 700dde85..bd629a10 100644 --- a/docs/jupyterlab.md +++ b/docs/jupyterlab.md @@ -6,11 +6,11 @@ Monadic Chat has a feature to launch JupyterLab. JupyterLab is an integrated dev Click the `Actions/Start JupyterLab` menu in the Monadic Chat console to launch JupyterLab. JupyterLab can be accessed at `http://localhost:8889`. -![Action menu](/assets/images/action-menu.png ':size=150') +![Action menu](./assets/images/action-menu.png ':size=150') When JupyterLab is launched, it starts with `/monadic/data` as its home directory and current working directory. This allows you to access files in the shared folder within JupyterLab. -![JupyterLab Terminal](/assets/images/jupyterlab-terminal.png ':size=600') +![JupyterLab Terminal](./assets/images/jupyterlab-terminal.png ':size=600') ## Stopping JupyterLab diff --git a/docs/language-models.md b/docs/language-models.md index d66dc67d..e1922299 100644 --- a/docs/language-models.md +++ b/docs/language-models.md @@ -8,13 +8,13 @@ Monadic Chat uses OpenAI's language models to provide features such as chat, spe OPENAI_API_KEY=api_key ``` -For apps using OpenAI's language models, refer to the [Basic Apps](/basic-apps.md) section. +For apps using OpenAI's language models, refer to the [Basic Apps](./basic-apps.md) section. ?> For apps using OpenAI's GPT-4o series and GPT-4o-mini series models, the "Predicted Outputs" feature is available. By using the string `__DATA__` as a separator in the prompt to distinguish between instructions to the AI agent and data to be corrected or processed by the AI agent, you can speed up the response from the AI and reduce the number of tokens (See OpenAI [Predicted Outputs](https://platform.openai.com/docs/guides/latency-optimization#use-predicted-outputs)). ## Anthropic Models -![Anthropic apps icon](/assets/icons/a.png ':size=40') +![Anthropic apps icon](./assets/icons/a.png ':size=40') By setting the Anthropic API key, you can use apps that utilize Claude. Once set, the API key is saved in the `~/monadic/data/.env` file in the following format: @@ -50,7 +50,7 @@ Chat with Claude is an application that accesses the Anthropic Claude API to ans ## Cohere Models -![Cohere apps icon](/assets/icons/c.png ':size=40') +![Cohere apps icon](./assets/icons/c.png ':size=40') By setting the Cohere API key, you can use apps that utilize Command R. Once set, the API key is saved in the `~/monadic/data/.env` file in the following format: @@ -77,7 +77,7 @@ Chat with Command R is an application that accesses the Cohere API to answer que ## Google Models -![Google apps icon](/assets/icons/google.png ':size=40') +![Google apps icon](./assets/icons/google.png ':size=40') By setting the Google Gemini API key, you can use apps that utilize Gemini. Once set, the API key is saved in the `~/monadic/data/.env` file in the following format: @@ -96,7 +96,7 @@ Chat with Gemini is an application that accesses the Google Gemini API to answer ## Mistral Models -![Mistral apps icon](/assets/icons/m.png ':size=40') +![Mistral apps icon](./assets/icons/m.png ':size=40') By setting the Mistral AI API key, you can use apps that utilize Mistral. Once set, the API key is saved in the `~/monadic/data/.env` file in the following format: @@ -123,7 +123,7 @@ Chat with Mistral is an application that accesses the Mistral AI API to answer q ## Ollama Models -![Ollama apps icon](/assets/icons/ollama.png ':size=40') +![Ollama apps icon](./assets/icons/ollama.png ':size=40') By introducing additional images and containers, you can use apps that utilize Ollama. [Ollama](https://ollama.com/) is a platform that allows you to use language models in a local environment on Docker. The following models are available: @@ -132,4 +132,4 @@ By introducing additional images and containers, you can use apps that utilize O - Mistral - Gemma -For information on how to introduce Ollama in Monadic Chat, refer to [Using Ollama](/ollama). +For information on how to introduce Ollama in Monadic Chat, refer to [Using Ollama](./ollama). diff --git a/docs/message-input.md b/docs/message-input.md index b93b1d11..2ebc4fb6 100644 --- a/docs/message-input.md +++ b/docs/message-input.md @@ -8,7 +8,7 @@ Enter a message in the text area and click the `Send` button to send the message ?> To chat smoothly with the AI agent using voice input and speech synthesis, it is convenient to turn on `Auto Speech` and `Easy Submit` in the web settings. These are enabled by default in the [Voice Chat](./basic-apps?id=voice-chat) app. -?> The `Role` selector is used to select the role of the message. Normally, select `User`, but by selecting `Assistant` or `System`, you can add or modify the context of the chat. For more information, see the [FAQ](./faq). +?> The `Role` selector is used to select the role of the message. Normally, select `User`, but by selecting `Assistant` or `System`, you can add or modify the context of the chat. For more information, see the [FAQ](./faq-user-interface). # Uploading Images diff --git a/docs/monadic-mode.md b/docs/monadic-mode.md index b088d12d..a02e96b9 100644 --- a/docs/monadic-mode.md +++ b/docs/monadic-mode.md @@ -2,7 +2,7 @@ Monadic Mode is a distinctive feature of Monadic Chat. In Monadic Mode, you can maintain and update the context of the conversation, referencing it as you chat. This allows for more meaningful and coherent interactions with the AI agent. -![Monadic Chat Architecture](/assets/images/monadic-messaging.svg ':size=200') +![Monadic Chat Architecture](./assets/images/monadic-messaging.svg ':size=200') ## Basic Structure diff --git a/docs/python-container.md b/docs/python-container.md index 39e02679..ae04b57d 100644 --- a/docs/python-container.md +++ b/docs/python-container.md @@ -13,8 +13,8 @@ The standard Python container is built with the following Dockerfile. If you want to install additional programs and libraries, you can do one of the following: - Add an installation script to `pysetup.sh` in the shared folder to install the library during Monadic Chat environment setup (see the example below). -- Refer to [Docker Container Access](/docker-access) to log in to the Python container and install the library after setting up the Monadic Chat environment. -- Refer to [Adding Containers](/ja/adding-containers) to add a customized Python container. +- Refer to [Docker Container Access](./docker-access) to log in to the Python container and install the library after setting up the Monadic Chat environment. +- Refer to [Adding Containers](./adding-containers) to add a customized Python container. - Submit a request via [GitHub Issues](https://github.com/yohasebe/monadic-chat/issues). ## Usage of `pysetup.sh` diff --git a/docs/recipe-examples.md b/docs/recipe-examples.md index d63543a9..54fb4551 100644 --- a/docs/recipe-examples.md +++ b/docs/recipe-examples.md @@ -4,7 +4,7 @@ ## Simple Apps -For how to develop simple apps, refer to [Adding Simple Apps](/develop_apps.md#how-to-add-a-simple-app). +For how to develop simple apps, refer to [Adding Simple Apps](./develop_apps.md#how-to-add-a-simple-app).
Recipe Example (math_tutor_app.rb) @@ -15,7 +15,7 @@ For how to develop simple apps, refer to [Adding Simple Apps](/develop_apps.md#h ## Apps with Function Definitions -For how to use functions and tools in an app, refer to [Calling Functions in the App](/develop_apps.md#calling-functions-in-the-app). +For how to use functions and tools in an app, refer to [Calling Functions in the App](./develop_apps.md#calling-functions-in-the-app).
Recipe Example (wikipedia_app.rb) @@ -33,7 +33,7 @@ For how to use functions and tools in an app, refer to [Calling Functions in the ## Apps with Output Format Specification -Monadic Chat has a special mode (called `monadic` mode) for outputting in JSON format. For details, refer to [Monadic Mode](/monadic-mode.md). +Monadic Chat has a special mode (called `monadic` mode) for outputting in JSON format. For details, refer to [Monadic Mode](./monadic-mode.md). For some OpenAI models (such as `gpt-4o`), you can specify `response_format` to ensure that the response is in JSON format. For the specification method, refer to [OpenAI: Structured outputs](https://platform.openai.com/docs/guides/structured-outputs). @@ -46,7 +46,7 @@ For some OpenAI models (such as `gpt-4o`), you can specify `response_format` to ## AI Agents Using LLMs within Apps -This section provides examples of apps where the AI agent accesses the OpenAI language model within the functions and tools it uses. Refer to [Using LLM in Functions and Tools](/develop_apps.md#using-llm-in-functions-and-tools). +This section provides examples of apps where the AI agent accesses the OpenAI language model within the functions and tools it uses. Refer to [Using LLM in Functions and Tools](./develop_apps.md#using-llm-in-functions-and-tools).
Recipe Example (second_opinion_app.rb) @@ -64,4 +64,4 @@ This section provides examples of apps where the AI agent accesses the OpenAI la ## Apps Using a Custom Container -Refer to the section on [Adding Docker Containers](/adding-containers.md) for information on how to create and use custom containers with your apps. This allows you to extend Monadic Chat's functionality by adding new services and tools. +Refer to the section on [Adding Docker Containers](./adding-containers.md) for information on how to create and use custom containers with your apps. This allows you to extend Monadic Chat's functionality by adding new services and tools. diff --git a/docs/setting-items.md b/docs/setting-items.md index 3373e49e..e5daae7b 100644 --- a/docs/setting-items.md +++ b/docs/setting-items.md @@ -22,7 +22,7 @@ Specify the text of the system prompt. Specify the group name for grouping the app on the Base App selector on the web settings screen. When adding custom apps, it is recommended to specify some group name to distinguish them from the base apps. -![](/assets/images/groups.png ':size=300') +![](./assets/images/groups.png ':size=300') `model` (string) Specify the default model. If not specified, the default model provided by the included helper module (e.g., `gpt-4o-mini` for `OpenAIHelper`) is used. @@ -70,7 +70,7 @@ Specify whether to enable rendering of mathematical expressions using [MathJax]( Specify `true` when integrating with Jupyter Notebook (optimizes MathJax display). `monadic` (bool) -Specify the app to run in Monadic mode. For Monadic mode, refer to [Monadic Mode](/monadic-mode.md). +Specify the app to run in Monadic mode. For Monadic mode, refer to [Monadic Mode](./monadic-mode.md). `prompt_suffix` (string) Specify a text string to be added to every message from the user before sending it to the AI agent. This is useful for adding a reminder to the AI agent about highly important information (often specified in the system prompt) to ensure it is considered when preparing the response. diff --git a/docs/shared-folder.md b/docs/shared-folder.md index eed7e698..c7eee399 100644 --- a/docs/shared-folder.md +++ b/docs/shared-folder.md @@ -4,7 +4,7 @@ When you first start Monadic Chat, a `~/monadic/data` directory is created. This Clicking the `Shared Folder` button in the Monadic Chat console will launch the OS's standard file manager and open the Shared Folder. -![Monadic Chat Console](/assets/images/monadic-chat-console.png ':size=700') +![Monadic Chat Console](./assets/images/monadic-chat-console.png ':size=700') By placing files in this directory, you can access those files within Monadic Chat's Docker containers. The path to the Shared Folder within each Docker container is `/monadic/data`, while the path on your local machine is `~/monadic/data`. @@ -36,7 +36,7 @@ It's recommended to periodically clean up unnecessary files from these app direc ## Structure inside the Shared Folder -When developing or adding additional apps other than the basic apps, you need to place the necessary files and folders within the Shared Folder correctly. The following are subfolders that are automatically created inside the Shared Folder. For information on how to develop additional apps, see [Developing Apps](/developing-apps.md). +When developing or adding additional apps other than the basic apps, you need to place the necessary files and folders within the Shared Folder correctly. The following are subfolders that are automatically created inside the Shared Folder. For information on how to develop additional apps, see [Developing Apps](./developing-apps.md). **`apps`** diff --git a/docs/syntax-highlighting.md b/docs/syntax-highlighting.md index a49140e7..64d41681 100644 --- a/docs/syntax-highlighting.md +++ b/docs/syntax-highlighting.md @@ -6,66 +6,66 @@ Monadic Chat supports syntax highlighting for code snippets in the chat. The syn **base16-dark** -![](/assets/images/syntax-base16-dark.png ':size=800') +![](./assets/images/syntax-base16-dark.png ':size=800') **github-dark** -![](/assets/images/syntax-github-dark.png ':size=800') +![](./assets/images/syntax-github-dark.png ':size=800') **gruvbox-dark** -![](/assets/images/syntax-gruvbox-dark.png ':size=800') +![](./assets/images/syntax-gruvbox-dark.png ':size=800') **colorful** -![](/assets/images/syntax-colorful.png ':size=800') +![](./assets/images/syntax-colorful.png ':size=800') **molokai** -![](/assets/images/syntax-molokai.png ':size=800') +![](./assets/images/syntax-molokai.png ':size=800') **monokai** -![](/assets/images/syntax-monokai.png ':size=800') +![](./assets/images/syntax-monokai.png ':size=800') **monokai_sublime** -![](/assets/images/syntax-monokai_sublime.png ':size=800') +![](./assets/images/syntax-monokai_sublime.png ':size=800') **tulip** -![](/assets/images/syntax-tulip.png ':size=800') +![](./assets/images/syntax-tulip.png ':size=800') **thankful_eyes** -![](/assets/images/syntax-thankful_eyes.png ':size=800') +![](./assets/images/syntax-thankful_eyes.png ':size=800') ## Light Themes **base16-light** -![](/assets/images/syntax-base16-light.png ':size=800') +![](./assets/images/syntax-base16-light.png ':size=800') **github-light** -![](/assets/images/syntax-github-light.png ':size=800') +![](./assets/images/syntax-github-light.png ':size=800') **gruvbox-light** -![](/assets/images/syntax-gruvbox-light.png ':size=800') +![](./assets/images/syntax-gruvbox-light.png ':size=800') **bw** -![](/assets/images/syntax-bw.png ':size=800') +![](./assets/images/syntax-bw.png ':size=800') **igor_pro** -![](/assets/images/syntax-igor_pro.png ':size=800') +![](./assets/images/syntax-igor_pro.png ':size=800') **magritte** -![](/assets/images/syntax-magritte.png ':size=800') +![](./assets/images/syntax-magritte.png ':size=800') **pastie** -![](/assets/images/syntax-pastie.png ':size=800') +![](./assets/images/syntax-pastie.png ':size=800') diff --git a/docs/web-interface.md b/docs/web-interface.md index a622490c..ec21273f 100644 --- a/docs/web-interface.md +++ b/docs/web-interface.md @@ -7,7 +7,7 @@ ![](./assets/images/chat-settings.png ':size=700') **Base App**
-Select one of the basic apps provided by Monadic Chat. Each app has different default parameter values and unique initial prompts. For the characteristics of each app, see [Base Apps](/basic-apps.md). +Select one of the basic apps provided by Monadic Chat. Each app has different default parameter values and unique initial prompts. For the characteristics of each app, see [Base Apps](./basic-apps.md). **Model**
Models available for the selected app are displayed. If a default model is set for the app, the default model is pre-selected. You can change the model by selecting a different one from the dropdown list. With many basic apps, the model list is automatically retrieved from the API, and multiple models are selectable. Please note that using a model other than the default one might result in errors if the model isn't suitable for the app.