lollms-client 0.21.0__py3-none-any.whl → 0.22.0__py3-none-any.whl

lollms_client/lollms_personality.py

@@ -0,0 +1,182 @@
+import importlib.util
+import json
+from pathlib import Path
+from typing import Callable, List, Optional, Union
+
+class LollmsPersonality:
+    """
+    A class that encapsulates the full personality of an AI agent.
+
+    This includes its identity, system prompts, specialized knowledge (via RAG),
+    and custom execution logic (via a Python script). It is designed to be a
+    portable and self-contained unit that can be loaded and used by any
+    application using the lollms-client.
+    """
+    def __init__(
+        self,
+        # Metadata for identification and display
+        name: str,
+        author: str,
+        category: str,
+        description: str,
+        # Core behavioral instruction
+        system_prompt: str,        
+        icon: Optional[str] = None,  # Base64 encoded image string
+
+
+        # RAG - Data Files and Application-provided Callbacks
+        data_files: Optional[List[Union[str, Path]]] = None,
+        vectorize_chunk_callback: Optional[Callable[[str, str], None]] = None,  # (chunk_text, chunk_id) -> None
+        is_vectorized_callback: Optional[Callable[[str], bool]] = None,        # (chunk_id) -> bool
+        query_rag_callback: Optional[Callable[[str], str]] = None,              # (user_query) -> rag_context_str
+
+        # Custom Logic Override
+        script: Optional[str] = None,  # The Python script as a raw string
+
+        # Internal state
+        personality_id: Optional[str] = None
+    ):
+        """
+        Initializes a LollmsPersonality instance.
+
+        Args:
+            name: The display name of the personality.
+            author: The author of the personality.
+            category: A category for organization (e.g., 'Code', 'Writing', 'Fun').
+            description: A brief description of what the personality does.
+            icon: An optional base64 encoded string for a display icon.
+            system_prompt: The core system prompt that defines the AI's behavior.
+            data_files: A list of file paths to be used as a knowledge base for RAG.
+            vectorize_chunk_callback: A function provided by the host app to vectorize and store a text chunk.
+            is_vectorized_callback: A function provided by the host app to check if a chunk is already vectorized.
+            query_rag_callback: A function provided by the host app to query the vector store for relevant context.
+            script: A string containing a Python script to override default chat behavior.
+            personality_id: An optional unique identifier. If not provided, it's generated from the author and name.
+        """
+        self.name = name
+        self.author = author
+        self.category = category
+        self.description = description
+        self.icon = icon
+        self.system_prompt = system_prompt
+        self.data_files = [Path(f) for f in data_files] if data_files else []
+        
+        # RAG Callbacks provided by the host application
+        self.vectorize_chunk_callback = vectorize_chunk_callback
+        self.is_vectorized_callback = is_vectorized_callback
+        self.query_rag_callback = query_rag_callback
+        
+        self.script = script
+        self.script_module = None
+        self.personality_id = personality_id or self._generate_id()
+        
+        # Prepare custom logic and data upon initialization
+        self._prepare_script()
+        self.ensure_data_vectorized()
+
+    def _generate_id(self) -> str:
+        """
+        Creates a filesystem-safe, unique ID based on the author and name.
+        """
+        safe_author = "".join(c if c.isalnum() else '_' for c in self.author)
+        safe_name = "".join(c if c.isalnum() else '_' for c in self.name)
+        return f"{safe_author}_{safe_name}"
+
+    def _prepare_script(self):
+        """
+        Dynamically loads the personality's script as an in-memory Python module.
+
+        This allows the script to be executed without being saved as a .py file on disk,
+        making the system more secure and self-contained.
+        """
+        if not self.script:
+            return
+        try:
+            module_name = f"lollms_personality_script_{self.personality_id}"
+            
+            # Create a module specification and a module object from it
+            spec = importlib.util.spec_from_loader(module_name, loader=None)
+            self.script_module = importlib.util.module_from_spec(spec)
+            
+            # Execute the script code within the new module's namespace
+            exec(self.script, self.script_module.__dict__)
+            print(f"[{self.name}] Custom script loaded successfully.")
+        except Exception as e:
+            print(f"[{self.name}] Failed to load custom script: {e}")
+            self.script_module = None
+
+    def ensure_data_vectorized(self, chunk_size: int = 1024):
+        """
+        Checks if the personality's data files are vectorized using the host callbacks.
+        
+        It iterates through each data file, splits it into chunks, and for each chunk,
+        it checks if it's already processed. If not, it calls the vectorization callback
+        provided by the host application.
+
+        Args:
+            chunk_size: The size of each text chunk to process for vectorization.
+        """
+        if not self.data_files or not self.vectorize_chunk_callback or not self.is_vectorized_callback:
+            return
+            
+        print(f"[{self.name}] Checking RAG data vectorization...")
+        all_vectorized = True
+        for file_path in self.data_files:
+            if not file_path.exists():
+                print(f"  - Warning: Data file not found, skipping: {file_path}")
+                continue
+            
+            try:
+                content = file_path.read_text(encoding='utf-8')
+                chunks = [content[i:i+chunk_size] for i in range(0, len(content), chunk_size)]
+                
+                for i, chunk in enumerate(chunks):
+                    # Generate a unique and deterministic ID for each chunk
+                    chunk_id = f"{self.personality_id}_{file_path.name}_chunk_{i}"
+                    
+                    if not self.is_vectorized_callback(chunk_id):
+                        all_vectorized = False
+                        print(f"  - Vectorizing '{file_path.name}' chunk {i+1}/{len(chunks)}...")
+                        self.vectorize_chunk_callback(chunk, chunk_id)
+
+            except Exception as e:
+                print(f"  - Error processing file {file_path.name}: {e}")
+                continue
+        
+        if all_vectorized:
+            print(f"[{self.name}] All RAG data is already vectorized.")
+        else:
+            print(f"[{self.name}] RAG data vectorization complete.")
+        
+    def get_rag_context(self, query: str) -> Optional[str]:
+        """
+        Queries the vectorized data to get relevant context for a given query.
+
+        This method relies on the `query_rag_callback` provided by the host application
+        to perform the actual search in the vector store.
+
+        Args:
+            query: The user's query string.
+
+        Returns:
+            A string containing the relevant context, or None if no callback is available.
+        """
+        if not self.query_rag_callback:
+            return None
+        return self.query_rag_callback(query)
+
+    def to_dict(self) -> dict:
+        """
+        Serializes the personality's metadata to a dictionary.
+        Note: Callbacks and the script module are not serialized.
+        """
+        return {
+            "personality_id": self.personality_id,
+            "name": self.name,
+            "author": self.author,
+            "category": self.category,
+            "description": self.description,
+            "system_prompt": self.system_prompt,
+            "data_files": [str(p) for p in self.data_files],
+            "has_script": self.script is not None
+        }

{lollms_client-0.21.0.dist-info → lollms_client-0.22.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lollms_client
-Version: 0.21.0
+Version: 0.22.0
 Summary: A client library for LoLLMs generate endpoint
 Author-email: ParisNeo <parisneoai@gmail.com>
 License: Apache Software License

{lollms_client-0.21.0.dist-info → lollms_client-0.22.0.dist-info}/RECORD

@@ -1,13 +1,13 @@
-examples/console_discussion.py,sha256=naHRPWKbP2ifRRfukNBskdGXI7DWSxonqIHiezFaqOo,8184
+examples/console_discussion.py,sha256=JxjVaAxtt1WEXLN8vCJosu-cYNgfIX2JGO25kg1FFNY,20490
 examples/external_mcp.py,sha256=swx1KCOz6jk8jGTAycq-xu7GXPAhRMDe1x--SKocugE,13371
 examples/function_calling_with_local_custom_mcp.py,sha256=g6wOFRB8-p9Cv7hKmQaGzPvtMX3H77gas01QVNEOduM,12407
 examples/generate_a_benchmark_for_safe_store.py,sha256=bkSt0mrpNsN0krZAUShm0jgVM1ukrPpjI7VwSgcNdSA,3974
 examples/generate_text_with_multihop_rag_example.py,sha256=riEyVYo97r6ZYdySL-NJkRhE4MnpwbZku1sN8RNvbvs,11519
 examples/gradio_chat_app.py,sha256=ZZ_D1U0wvvwE9THmAPXUvNKkFG2gi7tQq1f2pQx_2ug,15315
-examples/gradio_lollms_chat.py,sha256=K59c-bPUpyaH1H-bz2ZEFALBjYRiIW88YdxUh5_83zo,10131
+examples/gradio_lollms_chat.py,sha256=z5FDE62dmPU3nb16zbZX6jkVitML1PMfPxYyWr8VLz8,10135
 examples/internet_search_with_rag.py,sha256=ioTb_WI2M6kFeh1Dg-EGcKjccphnCsIGD_e9PZgZshw,12314
 examples/local_mcp.py,sha256=w40dgayvHYe01yvekEE0LjcbkpwKjWwJ-9v4_wGYsUk,9113
-examples/lollms_discussions_test.py,sha256=xLPrSBkZsC3ZDbKr-R8Ps7x5SE_ZhinaeXG9OeKgC4s,6790
+examples/lollms_discussions_test.py,sha256=Jk1cCUDBBhTcK5glI50jAgzfB3IOiiUlnK3q7RYfMkA,6796
 examples/openai_mcp.py,sha256=7IEnPGPXZgYZyiES_VaUbQ6viQjenpcUxGiHE-pGeFY,11060
 examples/run_remote_mcp_example copy.py,sha256=pGT8A5iXK9oHtjGNEUCm8fnj9DQ37gcznjLYqAEI20o,10075
 examples/run_standard_mcp_example.py,sha256=GSZpaACPf3mDPsjA8esBQVUsIi7owI39ca5avsmvCxA,9419
@@ -25,13 +25,14 @@ examples/deep_analyze/deep_analyze_multiple_files.py,sha256=fOryShA33P4IFxcxUDe-
 examples/generate_and_speak/generate_and_speak.py,sha256=RAlvRwtEKXCh894l9M3iQbADe8CvF5N442jtRurK02I,13908
 examples/generate_game_sfx/generate_game_fx.py,sha256=MgLNGi4hGBRoyr4bqYuCUdCSqd-ldDVfF0VSDUjgzsg,10467
 examples/test_local_models/local_chat.py,sha256=slakja2zaHOEAUsn2tn_VmI4kLx6luLBrPqAeaNsix8,456
-lollms_client/__init__.py,sha256=vcrVS2ZpZiG4iGRIQ_8Ga4loefYHFACqbWuf5EKBbaw,916
+lollms_client/__init__.py,sha256=Cd4G7paIm0kKNqc90yAJ7VJ8mpi2jfzoMBabmWRBZbY,1047
 lollms_client/lollms_config.py,sha256=goEseDwDxYJf3WkYJ4IrLXwg3Tfw73CXV2Avg45M_hE,21876
-lollms_client/lollms_core.py,sha256=uV-qgwEovlwhE21pxb4xtQXYgiptPnhh0-dDVy_W4Hg,143638
-lollms_client/lollms_discussion.py,sha256=K0mev5LVPePqs1QrkaiITzKLPAb9vgWj9ZnJ-3Uy0Dg,30336
+lollms_client/lollms_core.py,sha256=y_KIVFCBsA0BYizGAbvQZrtWZCX5jB00yMuAgHlHaD4,143685
+lollms_client/lollms_discussion.py,sha256=zdAUOhbFod65-VZYfKaldHYURR7wWnuccqv6FJa1qrM,36291
 lollms_client/lollms_js_analyzer.py,sha256=01zUvuO2F_lnUe_0NLxe1MF5aHE1hO8RZi48mNPv-aw,8361
 lollms_client/lollms_llm_binding.py,sha256=E81g4yBlQn76WTSLicnTETJuQhf_WZUMZaxotgRnOcA,12096
 lollms_client/lollms_mcp_binding.py,sha256=0rK9HQCBEGryNc8ApBmtOlhKE1Yfn7X7xIQssXxS2Zc,8933
+lollms_client/lollms_personality.py,sha256=dILUI5DZdzJ3NDDQiIsK2UptVF-jZK3XYXZ2bpXP_ew,8035
 lollms_client/lollms_python_analyzer.py,sha256=7gf1fdYgXCOkPUkBAPNmr6S-66hMH4_KonOMsADASxc,10246
 lollms_client/lollms_stt_binding.py,sha256=jAUhLouEhh2hmm1bK76ianfw_6B59EHfY3FmLv6DU-g,5111
 lollms_client/lollms_tti_binding.py,sha256=afO0-d-Kqsmh8UHTijTvy6dZAt-XDB6R-IHmdbf-_fs,5928
@@ -77,8 +78,9 @@ lollms_client/tts_bindings/piper_tts/__init__.py,sha256=0IEWG4zH3_sOkSb9WbZzkeV5
 lollms_client/tts_bindings/xtts/__init__.py,sha256=FgcdUH06X6ZR806WQe5ixaYx0QoxtAcOgYo87a2qxYc,18266
 lollms_client/ttv_bindings/__init__.py,sha256=UZ8o2izQOJLQgtZ1D1cXoNST7rzqW22rL2Vufc7ddRc,3141
 lollms_client/ttv_bindings/lollms/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-lollms_client-0.21.0.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-lollms_client-0.21.0.dist-info/METADATA,sha256=8YNTMkFKF5EuAgA9P4BN0IlH07wRDNk4ltftGF03tp8,13374
-lollms_client-0.21.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-lollms_client-0.21.0.dist-info/top_level.txt,sha256=NI_W8S4OYZvJjb0QWMZMSIpOrYzpqwPGYaklhyWKH2w,23
-lollms_client-0.21.0.dist-info/RECORD,,
+lollms_client-0.22.0.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+personalities/parrot.py,sha256=-HdbK1h7Ixvp8FX69Nv92Z_El6_UVtsF8WuAvNpKbfg,478
+lollms_client-0.22.0.dist-info/METADATA,sha256=71v2Qlp7tSyr_fL9I8Nw-9LLlncfuUkYgtJkK1EKayc,13374
+lollms_client-0.22.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+lollms_client-0.22.0.dist-info/top_level.txt,sha256=vgtOcmtJbKs9gEiIIPp2scIsvtvU2y5u3tngqlme1RU,37
+lollms_client-0.22.0.dist-info/RECORD,,

{lollms_client-0.21.0.dist-info → lollms_client-0.22.0.dist-info}/top_level.txt

@@ -1,2 +1,3 @@
 examples
 lollms_client
+personalities

personalities/parrot.py

@@ -0,0 +1,10 @@
+
+def run(discussion, on_chunk_callback):
+    # This script overrides the normal chat flow.
+    user_message = discussion.get_branch(discussion.active_branch_id)[-1].content
+    response = f"Squawk! {user_message}! Squawk!"
+    if on_chunk_callback:
+        # We need to simulate the message type for the callback
+        from lollms_client import MSG_TYPE
+        on_chunk_callback(response, MSG_TYPE.MSG_TYPE_CHUNK)
+    return response # Return the full raw response