pygpt-net 2.4.36.post1__py3-none-any.whl → 2.4.41__py3-none-any.whl

{pygpt_net-2.4.36.post1.dist-info → pygpt_net-2.4.41.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pygpt-net
-Version: 2.4.36.post1
+Version: 2.4.41
 Summary: Desktop AI Assistant powered by models: OpenAI o1, GPT-4o, GPT-4, GPT-4 Vision, GPT-3.5, DALL-E 3, Llama 3, Mistral, Gemini, Claude, Bielik, and other models supported by Langchain, Llama Index, and Ollama. Features include chatbot, text completion, image generation, vision analysis, speech-to-text, internet access, file handling, command execution and more.
 Home-page: https://pygpt.net
 License: MIT
@@ -92,7 +92,7 @@ Description-Content-Type: text/markdown
 
 [![pygpt](https://snapcraft.io/pygpt/badge.svg)](https://snapcraft.io/pygpt)
 
-Release: **2.4.36** | build: **2024.11.28** | Python: **>=3.10, <3.12**
+Release: **2.4.41** | build: **2024.12.14** | Python: **>=3.10, <3.12**
 
 > Official website: https://pygpt.net | Documentation: https://pygpt.readthedocs.io
 > 
@@ -693,11 +693,11 @@ Built-in file loaders:
 - Webpages (crawling any webpage content)
 - YouTube (transcriptions)
 
-You can configure data loaders in `Settings / LlamaIndex / Data Loaders` by providing list of keyword arguments for specified loaders.
+You can configure data loaders in `Settings / Indexes (LlamaIndex) / Data Loaders` by providing list of keyword arguments for specified loaders.
 You can also develop and provide your own custom loader and register it within the application.
 
 LlamaIndex is also integrated with context database - you can use data from database (your context history) as additional context in discussion. 
-Options for indexing existing context history or enabling real-time indexing new ones (from database) are available in `Settings / LlamaIndex` section.
+Options for indexing existing context history or enabling real-time indexing new ones (from database) are available in `Settings / Indexes (LlamaIndex)` section.
 
 **WARNING:** remember that when indexing content, API calls to the embedding model are used. Each indexing consumes additional tokens. Always control the number of tokens used on the OpenAI page.
 
@@ -759,7 +759,7 @@ You can set the limit of steps in such a loop by going to `Settings -> Agents an
 
 You can change the prompt used for evaluating the response in `Settings -> Prompts -> Agent: evaluation prompt in loop`. Here, you can adjust it to suit your needs, for example, by defining more or less critical feedback for the responses received.
 
-##  Agent (Legacy, Autonomous) 
+##  Agent (Autonomous) 
 
 This is an older version of the Agent mode, still available as legacy. However, it is recommended to use the newer mode: `Agent (LlamaIndex)`.
 
@@ -907,11 +907,13 @@ The content from the uploaded attachments will be used in the current conversati
 
 - `Full context`: Provides best results. This mode attaches the entire content of the read file to the user's prompt. This process happens in the background and may require a large number of tokens if you uploaded extensive content.
 
-- `Query only`: The indexed attachment will only be queried in real-time using LlamaIndex. This operation does not require any additional tokens, but it may not provide access to the full content of the file 1:1.
+- `RAG`: The indexed attachment will only be queried in real-time using LlamaIndex. This operation does not require any additional tokens, but it may not provide access to the full content of the file 1:1.
 
 - `Summary`: When queried, an additional query will be generated in the background and executed by a separate model to summarize the content of the attachment and return the required information to the main model. You can change the model used for summarization in the settings under the `Files and attachments` section.
 
-**Important**: When using `Full context` mode, the entire content of the file is included in the prompt, which can result in high token usage each time. If you want to reduce the number of tokens used, instead use the `Query only` option, which will only query the indexed attachment in the vector database to provide additional context.
+In the `RAG` and `Summary` mode, you can enable an additional setting by going to `Settings -> Files and attachments -> Use history in RAG query`. This allows for better preparation of queries for RAG. When this option is turned on, the entire conversation context is considered, rather than just the user's last query. This allows for better searching of the index for additional context. In the `RAG limit` option, you can set a limit on how many recent entries in a discussion should be considered (`0 = no limit, default: 3`).
+
+**Important**: When using `Full context` mode, the entire content of the file is included in the prompt, which can result in high token usage each time. If you want to reduce the number of tokens used, instead use the `RAG` option, which will only query the indexed attachment in the vector database to provide additional context.
 
 **Images as Additional Context**
 
@@ -919,7 +921,7 @@ Files such as jpg, png, and similar images are a special case. By default, image
 
 **Uploading larger files and auto-index**
 
-To use the `Query only` mode, the file must be indexed in the vector database. This occurs automatically at the time of upload if the `Auto-index on upload` option in the `Attachments` tab is enabled. When uploading large files, such indexing might take a while - therefore, if you are using the `Full context` option, which does not use the index, you can disable the `Auto-index` option to speed up the upload of the attachment. In this case, it will only be indexed when the `Query only` option is called for the first time, and until then, attachment will be available in the form of `Full context` and `Summary`.
+To use the `RAG` mode, the file must be indexed in the vector database. This occurs automatically at the time of upload if the `Auto-index on upload` option in the `Attachments` tab is enabled. When uploading large files, such indexing might take a while - therefore, if you are using the `Full context` option, which does not use the index, you can disable the `Auto-index` option to speed up the upload of the attachment. In this case, it will only be indexed when the `RAG` option is called for the first time, and until then, attachment will be available in the form of `Full context` and `Summary`.
 
 ## Downloading files
 
@@ -2072,6 +2074,10 @@ Per-page content chunk size (max characters per chunk). *Default:* `20000`
 
 Disables SSL verification when crawling web pages. *Default:* `False`
 
+- `Use raw content (without summarization)` *raw*
+
+Return raw content from web search instead of summarized content. Provides more data but consumes more tokens. *Default:* `True`
+
 - `Timeout` *timeout*
 
 Connection timeout (seconds). *Default:* `5`
@@ -2082,7 +2088,7 @@ User agent to use when making requests. *Default:* `Mozilla/5.0`.
 
 - `Max result length` *max_result_length*
 
-Max length of summarized result (characters). *Default:* `1500`
+Max length of the summarized or raw result (characters). *Default:* `50000`
 
 - `Max summary tokens` *summary_max_tokens*
 
@@ -2768,6 +2774,8 @@ Config -> Settings...
 
 - `Zoom`: Adjusts the zoom in chat window (web render view). `WebEngine / Chromium` render mode only.
 
+- `Style (chat)`: Chat style (Blocks, or ChatGPT-like, or ChatGPT-like Wide. `WebEngine / Chromium` render mode only.
+
 - `Code syntax highlight`: Syntax highlight theme in code blocks. `WebEngine / Chromium` render mode only.
 
 - `Font Size (chat window)`: Adjusts the font size in the chat window (plain-text) and notepads.
@@ -2790,8 +2798,6 @@ Config -> Settings...
 
 - `Use theme colors in chat window`: Use color theme in chat window, Default: True.
 
-- `Disable markdown formatting in output`: Enables plain-text display in output window, Default: False.
-
 **Files and attachments**
 
 - `Store attachments in the workdir upload directory`: Enable to store a local copy of uploaded attachments for future use. Default: True
@@ -2800,6 +2806,16 @@ Config -> Settings...
 
 - `Directory for file downloads`: Subdirectory for downloaded files, e.g. in Assistants mode, inside "data". Default: "download"
 
+- `Verbose mode`: Enabled verbose mode when using attachment as additional context.
+
+- `Model for querying index`: Model to use for preparing query and querying the index when the RAG option is selected.
+
+- `Model for attachment content summary`: Model to use when generating a summary for the content of a file when the Summary option is selected.
+
+- `Use history in RAG query`: When enabled, the content of the entire conversation will be used when preparing a query if mode is RAG or Summary.
+
+- `RAG limit`: Only if the option `Use history in RAG query` is enabled. Specify the limit of how many recent entries in the conversation will be used when generating a query for RAG. 0 = no limit.
+
 **Context**
 
 - `Context Threshold`: Sets the number of tokens reserved for the model to respond to the next prompt.
@@ -2892,14 +2908,22 @@ Config -> Settings...
 
 **Vision**
 
+- `Vision: Camera Input Device`: Video capture camera index (index of the camera, default: 0).
+
 - `Vision: Camera capture width (px)`: Video capture resolution (width).
 
 - `Vision: Camera capture height (px)`: Video capture resolution (height).
 
-- `Vision: Camera IDX (number)`: Video capture camera index (number of camera).
-
 - `Vision: Image capture quality`: Video capture image JPEG quality (%).
 
+**Audio**
+
+- `Audio Input Device`: Selects the audio device for Microphone input.
+
+- `Channels`: Input channels, default: 1
+
+- `Sampling Rate`: Sampling rate, default: 44100
+
 **Indexes (LlamaIndex)**
 
 - `Indexes`: List of created indexes.
@@ -3337,7 +3361,7 @@ If you want to only query index (without chat) you can enable `Query index only
 
 You can create a custom vector store provider or data loader for your data and develop a custom launcher for the application. 
 
-See the section `Extending PyGPT / Adding custom Vector Store provider` for more details.
+See the section `Extending PyGPT / Adding a custom Vector Store provider` for more details.
 
 # Updates
 
@@ -3635,6 +3659,8 @@ Syntax: `event name` - triggered on, `event data` *(data type)*:
 
 - `AI_NAME` - when preparing an AI name, `data['value']` *(string, name of the AI assistant)*
 
+- `AGENT_PROMPT` - on agent prompt in eval mode, `data['value']` *(string, prompt)*
+
 - `AUDIO_INPUT_RECORD_START` - start audio input recording
 
 - `AUDIO_INPUT_RECORD_STOP` -  stop audio input recording
@@ -3693,10 +3719,16 @@ Syntax: `event name` - triggered on, `event data` *(data type)*:
 
 - `POST_PROMPT` - after preparing a system prompt, `data['value']` *(string, system prompt)*
 
+- `POST_PROMPT_ASYNC` - after preparing a system prompt, just before request in async thread, `data['value']` *(string, system prompt)*
+
+- `POST_PROMPT_END` - after preparing a system prompt, just before request in async thread, at the very end `data['value']` *(string, system prompt)*
+
 - `PRE_PROMPT` - before preparing a system prompt, `data['value']` *(string, system prompt)*
 
 - `SYSTEM_PROMPT` - when preparing a system prompt, `data['value']` *(string, system prompt)*
 
+- `TOOL_OUTPUT_RENDER` - when rendering extra content from tools from plugins, `data['content']` *(string, content)*
+
 - `UI_ATTACHMENTS` - when the attachment upload elements are rendered, `data['value']` *(bool, show True/False)*
 
 - `UI_VISION` - when the vision elements are rendered, `data['value']` *(bool, show True/False)*
@@ -3935,117 +3967,42 @@ may consume additional tokens that are not displayed in the main window.
 
 ## Recent changes:
 
-**2.4.36 (2024-11-28)**
-
-- Added a new command-line argument: --workdir="/path/to/workdir" to explicitly set the current working directory.
-- Fix: start image generation in Image mode.
-
-**2.4.35 (2024-11-28)**
-
-- Docker removed from dependencies in Snap version #82
-- Refactored documentation.
-- Fix: toggles real-time update hook.
-- Fix: missing edit icons.
-- Added tokens from attachments to counters if mode == Full context.
-
-**2.4.34 (2024-11-26)**
-
-- Added a new mode: `Chat with Audio`, with built-in multimodal support for audio input/output. Currently in `beta`, the execution of commands and tools in this mode is temporarily unavailable.
-- Added new models: `gpt-4o-audio-preview`, `gpt-4o-2024-11-20`, `chatgpt-4o-latest`.
-- Force disabled integration with the native system menu.
-
-**2.4.33 (2024-11-26)**
-
-- Improved CSS and rendering of file and image lists.
-- Added displaying of used attachments in the chat window.
-
-**2.4.32 (2024-11-26)**
-
-- The "Add URL" option added to the "Attachments" tab allows users to include content from a given website as additional context. Currently, it only supports standard web pages and video transcription for YouTube links. More "web" options will be added in the future.
-- Added UTF-8 as default in attachments content text read/write.
-
-**2.4.31 (2024-11-25)**
-
-- Added an option checkbox `Auto-index on upload` in the `Attachments` tab: 
-
-**Tip:** To use the `Query only` mode, the file must be indexed in the vector database. This occurs automatically at the time of upload if the `Auto-index on upload` option in the `Attachments` tab is enabled. When uploading large files, such indexing might take a while - therefore, if you are using the `Full context` option, which does not use the index, you can disable the `Auto-index` option to speed up the upload of the attachment. In this case, it will only be indexed when the `Query only` option is called for the first time, and until then, attachment will be available in the form of `Full context` and `Summary`.
-
-- Added context menu options in `Uploaded attachments` tab: `Open`, `Open Source directory` and `Open Storage directory`.
-
-**2.4.30 (2024-11-25)**
-
-- Added instruction to model about mapped data directory in both legacy and IPython code interepreter.
-- Updated locales for plugins.
-
-**2.4.29 (2024-11-25)**
-
-- Added a local IPython interpreter - you can now choose between local and sandbox (Docker) in the plugin settings.
-- Added the ability to configure mapped volumes and ports for Docker containers in the plugin settings.
-- Optimized and speed-up the LlamaIndex plugin (inline).
-- Checkboxes replaced with Toggle buttons.
-- Improved settings dialogs.
-- Slight modification of the layout.
-- Fix: Dockerfile formatting in Code Interpreter config.
-- Fix: experts inline plugin execution.
-
-**2.4.28 (2024-11-24)**
-
-- Fix: issue #78
-
-**2.4.27 (2024-11-24)**
-
-- Profile switch fix.
-
-**2.4.26 (2024-11-24)**
-
-- Fix: issue #77
-
-**2.4.25 (2024-11-24)**
-
-- Added new plugin: System (OS), with optional sandbox support.
-- Execution of system commands moved to the System plugin.
-- Improved sandbox/Docker management.
-- Enhanced plugin settings.
-- Commands renamed to Tools, simplified layout.
-- Fix: handling of the Mouse and Keyboard plugin.
-- Fix: switching to a new context from a non-chat tab.
-- Fix: camera screenshots when the camera is not started.
-
-**2.4.24 (2024-11-23)**
-
-- Added the ability to use ZIP and TAR archives as attachments (they are now unpacked "on the fly").
-- Added the ability to index ZIP and TAR archives (it may be necessary to remove .zip and .tar from the blacklist in the settings).
-- Fix: error when uploading to the /data directory using the Upload files button.
-
-**2.4.23 (2024-11-23)**
+**2.4.41 (2024-12-14)**
 
-- Condensed layout widgets margins.
-- Added filename info to provided additional context from attachments.
-- Fixed auto-clear in attachments in Assistants mode.
+- Improved switching between columns on a split screen.
+- Added visual identification of the active column.
 
-**2.4.22 (2024-11-23)**
+**2.4.40 (2024-12-13)**
 
-- Added the ability to use attachments with images, audio, and video as additional context. Tip: to enable the use of images as additional context, you need to enable the option: `Files and attachments -> Allow images as additional context`.
-- Edit icons in the chat window are enabled by default.
+- Enhanced Split Screen mode, now promoted from beta to stable.
+- Python Code Interpreter tool added to the Tabs.
+- HTML/JS Canvas tool added to the Tabs.
+- Added attachment icon to the context list if context has attachments.
+- Improved audio playback.
+- Improved web search.
+- Added a thumbnail image to web search results.
+- Added a new commands to web search: "extract_images" and "extract_links".
+- Added the option "Use raw content (without summarization)" to the web search plugin, which provides a more detailed result to the main model.
+- Extended the default maximum result characters to 50,000 in the web search plugin.
 
-**2.4.21 (2024-11-23)**
+**2.4.39 (2024-12-09)**
 
-- Added the ability to send additional context from attachments without needing to activate the "Chat with Files" mode. Now, you just need to attach a file, and the additional context from the file will be available in the conversation. More information can be found in the "Files and attachments" section of the documentation.
+- Added "Split Screen" mode (accessible via the switch in the bottom-right corner of the screen), which allows you to work in two windows simultaneously. It is currently experimental (beta). Future updates will include Code Interpreter and Canvas running in tabs.
 
-- Fixed the issue with restarting the agent after it has been forcefully stopped.
+- Fixed: Language switch.
 
-**2.4.20 (2024-11-22)**
+**2.4.38 (2024-12-08)**
 
-- Fixed freeze in Windows installer. #75
-- Small fixes.
+- Added the ability to select a style for chat display between: Blocks, ChatGPT-like, and ChatGPT-like Wide. New option in the menu: Config -> Theme -> Style...
+- Added configuration options for audio input in Settings -> Audio -> Audio Input Device, Channels, and Sampling rate.
 
-**2.4.19 (2024-11-22)**
+**2.4.37 (2024-11-30)**
 
-- Added new LLM providers for LlamaIndex: HuggingFaceAPI and LocalAI.
-- The IPython interpreter now returns local paths to generated files and images (mapped to: %workdir%/ipython/).
-- Refactored legacy Agent and Expert modes.
-- Fixed Expert mode initialization.
-- Added an option in Settings -> Layout to disable animations.
+- The `Query only` mode in `Uploaded` tab has been renamed to `RAG`.
+- New options have been added under `Settings -> Files and Attachments`: 
+  - `Use history in RAG query`: When enabled, the content of the entire conversation will be used when preparing a query if the mode is set to RAG or Summary.
+  - `RAG limit`: This option is applicable only if 'Use history in RAG query' is enabled. It specifies the limit on how many recent entries in the conversation will be used when generating a query for RAG. A value of 0 indicates no limit.
+- Cache: dynamic parts of the system prompt (from plugins) have been moved to the very end of the prompt stack to enable the use of prompt cache mechanisms in OpenAI.
 
 
 # Credits and links