Updated docs

Author: szczyglis-dev

README.md

@@ -3,7 +3,7 @@ Files and attachments
 
 Input (upload)
 -------
-**PYGPT** makes it simple for users to upload files to the server and send them to the model for tasks like analysis, similar to attaching files in ``ChatGPT``. There's a separate ``Files`` tab next to the text input area specifically for managing file uploads. Users can opt to have files automatically deleted after each upload or keep them on the list for repeated use.
+**PyGPT** makes it simple for users to upload files to the server and send them to the model for tasks like analysis, similar to attaching files in ``ChatGPT``. There's a separate ``Files`` tab next to the text input area specifically for managing file uploads. Users can opt to have files automatically deleted after each upload or keep them on the list for repeated use.
 
 The attachment feature is available in both the ``Assistant`` and ``Vision`` modes.
 
@@ -14,7 +14,7 @@ The attachment feature is available in both the ``Assistant`` and ``Vision`` mod
 
 Output (download, generation)
 ---------------
-**PYGPT** enables the automatic download and saving of files created by the model. This is carried out in the background, with the files being saved to an ``output`` folder located within the user's working directory. To view or manage these files, users can navigate to the ``Output`` tab which features a file browser for this specific directory. Here, users have the interface to handle all files sent by the AI.
+**PyGPT** enables the automatic download and saving of files created by the model. This is carried out in the background, with the files being saved to an ``output`` folder located within the user's working directory. To view or manage these files, users can navigate to the ``Output`` tab which features a file browser for this specific directory. Here, users have the interface to handle all files sent by the AI.
 
 This ``output`` directory is also where the application stores files that are generated locally by the AI, such as code files or any other outputs requested from the model. Users have the option to execute code directly from the stored files and read their contents, with the results fed back to the AI. This hands-off process is managed by the built-in plugin system and model-triggered commands.
 

docs/source/attachments.rst

@@ -6,10 +6,10 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'PYGPT'
+project = 'PyGPT'
 copyright = '2023, pygpt.net'
 author = 'szczyglis-dev, Marcin Szczygliński'
-release = '2.0.27'
+release = '2.0.28'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/source/conf.py

@@ -3,12 +3,12 @@ Context and memory
 
 Short and long-term memory
 --------------------------
-**PYGPT** features a continuous chat mode that maintains a long context of the ongoing dialogue. It preserves the entire conversation history and automatically appends it to each new message (prompt) you send to the AI. Additionally, you have the flexibility to revisit past conversations whenever you choose. The application keeps a record of your chat history, allowing you to resume discussions from the exact point you stopped.
+**PyGPT** features a continuous chat mode that maintains a long context of the ongoing dialogue. It preserves the entire conversation history and automatically appends it to each new message (prompt) you send to the AI. Additionally, you have the flexibility to revisit past conversations whenever you choose. The application keeps a record of your chat history, allowing you to resume discussions from the exact point you stopped.
 
 
 Handling multiple contexts
 ---------------------------
-On the left side of the application interface, there is a panel that displays a list of saved conversations. You can save numerous contexts and switch between them with ease. This feature allows you to revisit and continue from any point in a previous conversation. **PYGPT** automatically generates a summary for each context, akin to the way ``ChatGPT`` operates and gives you the option to modify these titles itself.
+On the left side of the application interface, there is a panel that displays a list of saved conversations. You can save numerous contexts and switch between them with ease. This feature allows you to revisit and continue from any point in a previous conversation. **PyGPT** automatically generates a summary for each context, akin to the way ``ChatGPT`` operates and gives you the option to modify these titles itself.
 
 .. image:: images/v2_context_list.png
    :width: 400

docs/source/context.rst

@@ -3,7 +3,7 @@ Images generation (DALL-E 3)
 
 DALL-E 3
 ---------
-PYGPT enables quick and straightforward image creation with ``DALL-E 3``. 
+PyGPT enables quick and straightforward image creation with ``DALL-E 3``. 
 The older model version, ``DALL-E 2``, is also accessible. Generating images is akin to a chat conversation  -  
 a user's prompt triggers the generation, followed by downloading, saving to the computer, 
 and displaying the image onscreen.

docs/source/images.rst

@@ -1,16 +1,16 @@
-.. PYGPT documentation master file, created by
+.. PyGPT documentation master file, created by
    sphinx-quickstart on Fri Mar 24 06:46:09 2023.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-PYGPT v2 - pygpt.net
+PyGPT v2 - pygpt.net
 ====================
 
 | **Last update:** 2023-12-14 12:00
 | **Project website:** https://pygpt.net
 | **GitHub:** https://github.com/szczyglis-dev/py-gpt
 | **PyPI:** https://pypi.org/project/pygpt-net
-| **Release:** 2.0.27 (2023-12-14)
+| **Release:** 2.0.28 (2023-12-14)
 
 .. toctree::
    :maxdepth: 3

docs/source/index.rst

@@ -4,15 +4,15 @@ Introduction
 Overview
 ----------------
 
-**PYGPT** is **all-in-one** Desktop AI Assistant that provides direct interaction with OpenAI language models, including ``GPT-4``, ``GPT-4 Vision``, and ``GPT-3.5``, through the ``OpenAI API``. The application also integrates with alternative LLMs, like those available on ``HuggingFace``, by utilizing ``Langchain``.
+**PyGPT** is **all-in-one** Desktop AI Assistant that provides direct interaction with OpenAI language models, including ``GPT-4``, ``GPT-4 Vision``, and ``GPT-3.5``, through the ``OpenAI API``. The application also integrates with alternative LLMs, like those available on ``HuggingFace``, by utilizing ``Langchain``.
 
-This assistant offers multiple modes of operation such as chat, assistants, completions, and image-related tasks using ``DALL-E 3`` for generation and ``GPT-4 Vision`` for analysis. **PYGPT** has filesystem capabilities for file I/O, can generate and run Python code, execute system commands, and manage file transfers. It also allows models to perform web searches with the ``Google Custom Search API``.
+This assistant offers multiple modes of operation such as chat, assistants, completions, and image-related tasks using ``DALL-E 3`` for generation and ``GPT-4 Vision`` for analysis. **PyGPT** has filesystem capabilities for file I/O, can generate and run Python code, execute system commands, and manage file transfers. It also allows models to perform web searches with the ``Google Custom Search API``.
 
-For audio interactions, **PYGPT** includes speech synthesis using the ``Microsoft Azure Text-to-Speech API`` and ``OpenAI's TTS API``. Additionally, it features speech recognition capabilities provided by ``OpenAI Whisper``, enabling the application to understand spoken commands and transcribe audio inputs into text. It features context memory with save and load functionality, enabling users to resume interactions from predefined points in the conversation. Prompt creation and management are streamlined through an intuitive preset system.
+For audio interactions, **PyGPT** includes speech synthesis using the ``Microsoft Azure Text-to-Speech API`` and ``OpenAI's TTS API``. Additionally, it features speech recognition capabilities provided by ``OpenAI Whisper``, enabling the application to understand spoken commands and transcribe audio inputs into text. It features context memory with save and load functionality, enabling users to resume interactions from predefined points in the conversation. Prompt creation and management are streamlined through an intuitive preset system.
 
-**PYGPT**'s functionality extends through plugin support, allowing for custom enhancements. Its multi-modal capabilities make it an adaptable tool for a range of AI-assisted operations, such as text-based interactions, system automation, daily assisting, vision applications, natural language processing, code generation and image creation.
+**PyGPT**'s functionality extends through plugin support, allowing for custom enhancements. Its multi-modal capabilities make it an adaptable tool for a range of AI-assisted operations, such as text-based interactions, system automation, daily assisting, vision applications, natural language processing, code generation and image creation.
 
-Multiple operation modes are included, such as chatbot, text completion, assistant, vision, Langchain, commands execution and image generation, making **PYGPT** a comprehensive tool for many AI-driven tasks.
+Multiple operation modes are included, such as chatbot, text completion, assistant, vision, Langchain, commands execution and image generation, making **PyGPT** a comprehensive tool for many AI-driven tasks.
 
 .. image:: images/v2_main.png
    :width: 800
@@ -54,7 +54,7 @@ The application is free, open-source, and runs on PCs with ``Windows 10``, ``Win
 The full Python source code is available on ``GitHub``.
 
 
-**PYGPT uses the user's API key  -  to use the application, 
+**PyGPT uses the user's API key  -  to use the application, 
 you must have a registered OpenAI account and your own API key.**
 
 .. note::

docs/source/intro.rst

@@ -8,7 +8,7 @@ and those supported by ``Langchain`` to this file. Configuration for Langchain w
 Adding custom LLMs via Langchain
 --------------------------------
 
-To add a new model using the Langchain wrapper in **PYGPT**, insert the model's configuration details into the ``models.json`` file. This should include the model's name, its supported modes (either ``chat``, ``completion``, or both), the LLM provider (which can be either e.g. ``OpenAI`` or ``HuggingFace``), and, if you are using a ``HuggingFace`` model, an optional ``API KEY``.
+To add a new model using the Langchain wrapper in **PyGPT**, insert the model's configuration details into the ``models.json`` file. This should include the model's name, its supported modes (either ``chat``, ``completion``, or both), the LLM provider (which can be either e.g. ``OpenAI`` or ``HuggingFace``), and, if you are using a ``HuggingFace`` model, an optional ``API KEY``.
 
 Example of models configuration - ``models.json``:
 
@@ -130,4 +130,4 @@ To add support for any provider not included by default, simply create your own
         launcher.run()
 
 
-To integrate your own model or provider into **PYGPT**, you can reference the sample classes located in the ``llm`` directory of the application. These samples can act as an example for your custom class. Ensure that your custom wrapper class includes two essential methods: ``chat`` and ``completion``. These methods should return the respective objects required for the model to operate in ``chat`` and ``completion`` modes.
+To integrate your own model or provider into **PyGPT**, you can reference the sample classes located in the ``llm`` directory of the application. These samples can act as an example for your custom class. Ensure that your custom wrapper class includes two essential methods: ``chat`` and ``completion``. These methods should return the respective objects required for the model to operate in ``chat`` and ``completion`` modes.

docs/source/models.rst

@@ -3,7 +3,7 @@ Chat, completion, assistants and vision
 
 Chat
 ----
-This mode in **PYGPT** mirrors ``ChatGPT``, allowing you to chat with models such as ``GPT-4``, ``GPT-4 Turbo``, ``GPT-3.5``, and ``GPT-3``. It's easy to switch models whenever you want. It works by using the ``ChatCompletion API``.
+This mode in **PyGPT** mirrors ``ChatGPT``, allowing you to chat with models such as ``GPT-4``, ``GPT-4 Turbo``, ``GPT-3.5``, and ``GPT-3``. It's easy to switch models whenever you want. It works by using the ``ChatCompletion API``.
 
 The main part of the interface is a chat window where conversations appear. Right below that is where you type your messages. On the right side of the screen, there's a section to set up or change your system prompts. You can also save these setups as presets to quickly switch between different models or tasks.
 
@@ -33,9 +33,9 @@ Assistants
 ----------
 This mode uses the new OpenAI's **Assistants API**.
 
-This mode expands on the basic chat functionality by including additional external tools like a ``Code Interpreter`` for executing code, ``Retrieval Files`` for accessing files, and custom ``Functions`` for enhanced interaction and integration with other APIs or services. In this mode, you can easily upload and download files. **PYGPT** streamlines file management, enabling you to quickly upload documents and manage files created by the model.
+This mode expands on the basic chat functionality by including additional external tools like a ``Code Interpreter`` for executing code, ``Retrieval Files`` for accessing files, and custom ``Functions`` for enhanced interaction and integration with other APIs or services. In this mode, you can easily upload and download files. **PyGPT** streamlines file management, enabling you to quickly upload documents and manage files created by the model.
 
-Setting up new assistants is simple - a single click is all it takes, and they instantly sync with the ``OpenAI API``. Importing assistants you've previously created with OpenAI into **PYGPT** is also a seamless process.
+Setting up new assistants is simple - a single click is all it takes, and they instantly sync with the ``OpenAI API``. Importing assistants you've previously created with OpenAI into **PyGPT** is also a seamless process.
 
 .. image:: images/v2_mode_assistant.png
    :width: 800
@@ -84,7 +84,7 @@ into the application, allowing you to interact with any LLM by simply supplying
 file for the specific model. You can add as many models as you like; just list them in the configuration 
 file named ``models.json``.
 
-Available LLMs providers supported by **PYGPT**:
+Available LLMs providers supported by **PyGPT**:
 
 * OpenAI
 * Azure OpenAI
@@ -96,4 +96,4 @@ Available LLMs providers supported by **PYGPT**:
 .. image:: images/v2_mode_langchain.png
    :width: 800
 
-You have the ability to add custom model wrappers for models that are not available by default in **PYGPT**. To integrate a new model, you can create your own wrapper and register it with the application. Detailed instructions for this process are provided in the section titled ``Managing models / Adding models via Langchain``.
+You have the ability to add custom model wrappers for models that are not available by default in **PyGPT**. To integrate a new model, you can create your own wrapper and register it with the application. Detailed instructions for this process are provided in the section titled ``Managing models / Adding models via Langchain``.

docs/source/modes.rst

@@ -135,7 +135,7 @@ Allows system commands execution. *Default:* `True`
 Command: Custom Commands
 ------------------------
 
-With the ``Custom Commands`` plugin, you can integrate **PYGPT** with your operating system and scripts or applications. You can define an unlimited number of custom commands and instruct GPT on when and how to execute them. Configuration is straightforward, and **PYGPT** includes a simple tutorial command for testing and learning how it works:
+With the ``Custom Commands`` plugin, you can integrate **PyGPT** with your operating system and scripts or applications. You can define an unlimited number of custom commands and instruct GPT on when and how to execute them. Configuration is straightforward, and **PyGPT** includes a simple tutorial command for testing and learning how it works:
 
 .. image:: images/v2_custom_cmd.png
    :width: 800
@@ -171,7 +171,7 @@ Here are some predefined system placeholders for use:
 - ``{_date}`` - current date in ``Y-m-d`` format
 - ``{_datetime}`` - current date and time in ``Y-m-d H:M:S`` format
 - ``{_file}`` - path to the file from which the command is invoked
-- ``{_home}`` - path to PYGPT's home/working directory
+- ``{_home}`` - path to PyGPT's home/working directory
 
 You can connect predefined placeholders with your own params.
 
@@ -187,11 +187,11 @@ With the setup above, every time you ask GPT to generate a song for you and save
 1. Generate a song.
 2. Locate your command.
 3. Execute the command by sending the song's title and text.
-4. The command will save the song text into a file named with the song's title in the PYGPT working directory.
+4. The command will save the song text into a file named with the song's title in the PyGPT working directory.
 
 **Example tutorial command**
 
-**PYGPT** provides simple tutorial command to show how it work, to run it just ask GPT for execute ``tutorial test command`` and it will show you how it works:
+**PyGPT** provides simple tutorial command to show how it work, to run it just ask GPT for execute ``tutorial test command`` and it will show you how it works:
 
 .. code-block:: console
 
@@ -204,7 +204,7 @@ With the setup above, every time you ask GPT to generate a song for you and save
 Command: Google Web Search
 --------------------------
 
-**PYGPT** lets you connect GPT to the internet and carry out web searches in real time as you make queries.
+**PyGPT** lets you connect GPT to the internet and carry out web searches in real time as you make queries.
 
 To activate this feature, turn on the ``Command: Google Web Search`` plugin found in the ``Plugins`` menu.
 
@@ -218,7 +218,7 @@ After registering an account, create a new project and select it from the list o
 https://programmablesearchengine.google.com/controlpanel/all
 
 After selecting your project, you need to enable the ``Whole Internet Search`` option in its settings. 
-Then, copy the following two items into PYGPT:
+Then, copy the following two items into PyGPT:
 
 * Api Key
 * CX ID
@@ -232,7 +232,7 @@ These data must be configured in the appropriate fields in the ``Plugins / Setti
 Audio Output (Microsoft Azure)
 --------------------------
 
-**PYGPT** implements voice synthesis using the ``Microsoft Azure Text-To-Speech`` API.
+**PyGPT** implements voice synthesis using the ``Microsoft Azure Text-To-Speech`` API.
 This feature requires to have an ``Microsoft Azure`` API Key. 
 You can get API KEY for free from here: https://azure.microsoft.com/en-us/services/cognitive-services/text-to-speech
 
@@ -390,7 +390,7 @@ current date and time in real-time. *Default:* `Current time is {time}.`
 Creating Your Own Plugins
 --------------------------
 
-You can create your own plugin for **PYGPT** at any time. The plugin can be written in Python and then registered with the application just before launching it. All plugins included with the app are stored in the ``plugin`` directory - you can use them as coding examples for your own plugins. Then, you can create your own and register it in the system using:
+You can create your own plugin for **PyGPT** at any time. The plugin can be written in Python and then registered with the application just before launching it. All plugins included with the app are stored in the ``plugin`` directory - you can use them as coding examples for your own plugins. Then, you can create your own and register it in the system using:
 
 .. code-block:: python