lollms-client 0.33.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

examples/simple_text_gen_with_image_test.py

@@ -1,178 +0,0 @@
-from lollms_client import LollmsClient, ELF_COMPLETION_FORMAT
-from lollms_client.lollms_types import MSG_TYPE # For callback signature
-from ascii_colors import ASCIIColors, trace_exception
-
-# --- Configuration ---
-# Choose your LLM binding and parameters here
-# Option 1: Default LOLLMS server binding
-# BINDING_NAME = "lollms"
-# HOST_ADDRESS = "http://localhost:9600"
-# MODEL_NAME = None # Server will use its default or last loaded model
-
-# Option 2: Ollama binding
-BINDING_NAME = "ollama"
-HOST_ADDRESS = "http://localhost:11434" # Default Ollama host
-MODEL_NAME = "llava:latest" # Or "llama3:latest", "phi3:latest", etc. - ensure it's pulled in Ollama
-
-# Option 3: llamacpp binding
-# BINDING_NAME = "llamacpp"
-# MODELS_PATH = r"E:\drumber" # Change to your own models folder
-# MODEL_NAME = "llava-v1.6-mistral-7b.Q3_K_XS.gguf" # Change to your vision capable model (make sure you have a mmprj file with the gguf model with the same name but without the quantization name and with mmproj- prefix (mmproj-llava-v1.6-mistral-7b.gguf))
-# You can also add a clip_model_path parameter to your lc_params
-img = "E:\\drumber\\1711741182996.jpg"
-# Option 3: OpenAI binding (requires OPENAI_API_KEY environment variable or service_key)
-# BINDING_NAME = "openai"
-# HOST_ADDRESS = None # Defaults to OpenAI API
-# MODEL_NAME = "gpt-3.5-turbo"
-# SERVICE_KEY = "sk-your_openai_api_key_here" # Optional, can use env var
-
-# --- Callback for streaming ---
-def simple_streaming_callback(chunk: str, msg_type: MSG_TYPE, params=None, metadata=None) -> bool:
-    """
-    Simple callback function to print streamed text chunks.
-    """
-    if msg_type == MSG_TYPE.MSG_TYPE_CHUNK:
-        print(chunk, end="", flush=True)
-    elif msg_type == MSG_TYPE.MSG_TYPE_EXCEPTION:
-        ASCIIColors.error(f"\nStreaming Error: {chunk}")
-    # Return True to continue streaming, False to stop
-    return True
-
-def test_text_generation():
-    ASCIIColors.cyan(f"\n--- Testing Text Generation with '{BINDING_NAME}' binding ---")
-
-    if BINDING_NAME!="llamacpp":
-        ASCIIColors.cyan(f"Host: {HOST_ADDRESS or 'Default'}, Model: {MODEL_NAME or 'Default'}")
-    else:
-        ASCIIColors.cyan(f"Host: {MODELS_PATH or 'Default'}, Model: {MODEL_NAME or 'Default'}")
-    try:
-        # Initialize LollmsClient
-        lc_params = {
-            "binding_name": BINDING_NAME,
-            "model_name": MODEL_NAME,
-            # "service_key": SERVICE_KEY, # Uncomment for OpenAI if needed
-        }
-        if BINDING_NAME!="llamacpp":
-            lc_params["host_address"]= HOST_ADDRESS
-            # Remove None host_address for bindings that have internal defaults (like OpenAI)
-            if lc_params["host_address"] is None and BINDING_NAME in ["openai"]:
-                del lc_params["host_address"]
-        else:
-            lc_params["models_path"]= MODELS_PATH
-
-
-        lc = LollmsClient(**lc_params)
-
-        # 1. Test basic non-streaming generation
-        ASCIIColors.magenta("\n1. Basic Non-Streaming Generation:")
-        prompt_non_stream = "describe this image"
-        ASCIIColors.yellow(f"Prompt: {prompt_non_stream}")
-        response_non_stream = lc.generate_text(
-            prompt=prompt_non_stream,
-            images=[img],
-            stream=False,
-            temperature=0.7,
-            n_predict=100 # Max tokens for the joke
-        )
-
-        if isinstance(response_non_stream, str):
-            ASCIIColors.green("Response:")
-            print(response_non_stream)
-        elif isinstance(response_non_stream, dict) and "error" in response_non_stream:
-            ASCIIColors.error(f"Error in non-streaming generation: {response_non_stream['error']}")
-        else:
-            ASCIIColors.warning(f"Unexpected response format: {response_non_stream}")
-
-        # 2. Test streaming generation
-        ASCIIColors.magenta("\n\n2. Streaming Generation:")
-        prompt_stream = "Explain the concept of recursion in one sentence."
-        ASCIIColors.yellow(f"Prompt: {prompt_stream}")
-        ASCIIColors.green("Response (streaming):")
-        response_stream = lc.generate_text(
-            prompt=prompt_stream,
-            stream=True,
-            streaming_callback=simple_streaming_callback,
-            temperature=0.5,
-            n_predict=150
-        )
-        print() # Newline after streaming
-
-        # The 'response_stream' variable will contain the full concatenated text if streaming_callback returns True throughout
-        # or an error dictionary if generation failed.
-        if isinstance(response_stream, str):
-            ASCIIColors.cyan(f"\n(Full streamed text was: {response_stream[:100]}...)") # Show a snippet of full text
-        elif isinstance(response_stream, dict) and "error" in response_stream:
-            ASCIIColors.error(f"Error in streaming generation: {response_stream['error']}")
-        # else: if callback returns False early, response_stream might be partial.
-
-        # 3. Test generation with a specific model (if applicable and different from default)
-        #    This tests the switch_model or model loading mechanism of the binding.
-        #    For 'lollms' binding, this would set the model on the server.
-        #    For 'ollama' or 'openai', it means the next generate_text will use this model.
-        ASCIIColors.magenta("\n\n3. List Available Models & Generate with Specific Model:")
-        available_models = lc.listModels()
-        if isinstance(available_models, list) and available_models:
-            ASCIIColors.green("Available models:")
-            for i, model_info in enumerate(available_models[:5]): # Print first 5
-                model_id = model_info.get('model_name', model_info.get('id', str(model_info)))
-                print(f"  - {model_id}")
-
-            # Try to use the first available model (or a known one if list is too generic)
-            target_model = None
-            if BINDING_NAME == "ollama":
-                # For Ollama, try using a different small model if available, or the same one
-                if "phi3:latest" in [m.get('name') for m in available_models if isinstance(m, dict)]:
-                    target_model = "phi3:latest"
-                elif available_models: # Fallback to first model in list if phi3 not present
-                     first_model_entry = available_models[0]
-                     target_model = first_model_entry.get('name', first_model_entry.get('model_name'))
-
-
-            elif BINDING_NAME == "lollms":
-                # For lollms, this would typically be a path or server-recognized name
-                # This part is harder to make generic without knowing server's models
-                ASCIIColors.yellow("For 'lollms' binding, ensure the target model is known to the server.")
-                if available_models and isinstance(available_models[0], str): # e.g. gptq model paths
-                    target_model = available_models[0]
-
-
-            if target_model and target_model != lc.binding.model_name: # Only if different and valid
-                ASCIIColors.info(f"\nSwitching to model (or using for next gen): {target_model}")
-                # For bindings like ollama/openai, setting model_name on binding directly works.
-                # For 'lollms' server binding, LollmsClient doesn't have a direct 'switch_model_on_server'
-                # but setting lc.binding.model_name will make the next generate_text request it.
-                lc.binding.model_name = target_model # Update the binding's current model_name
-
-                prompt_specific_model = f"What is the main capability of the {target_model.split(':')[0]} language model?"
-                ASCIIColors.yellow(f"Prompt (for {target_model}): {prompt_specific_model}")
-                ASCIIColors.green("Response:")
-                response_specific = lc.generate_text(
-                    prompt=prompt_specific_model,
-                    stream=True, # Keep it streaming for responsiveness
-                    streaming_callback=simple_streaming_callback,
-                    n_predict=200
-                )
-                print()
-            elif target_model == lc.binding.model_name:
-                ASCIIColors.yellow(f"Target model '{target_model}' is already the current model. Skipping specific model test.")
-            else:
-                ASCIIColors.yellow("Could not determine a different target model from the list to test specific model generation.")
-
-        elif isinstance(available_models, dict) and "error" in available_models:
-            ASCIIColors.error(f"Error listing models: {available_models['error']}")
-        else:
-            ASCIIColors.yellow("No models listed by the binding or format not recognized.")
-
-
-    except ValueError as ve:
-        ASCIIColors.error(f"Initialization Error: {ve}")
-        trace_exception(ve)
-    except RuntimeError as re:
-        ASCIIColors.error(f"Runtime Error (binding likely not initialized): {re}")
-        trace_exception(re)
-    except Exception as e:
-        ASCIIColors.error(f"An unexpected error occurred: {e}")
-        trace_exception(e)
-
-if __name__ == "__main__":
-    test_text_generation()

examples/test_local_models/local_chat.py

@@ -1,9 +0,0 @@
-from lollms_client import LollmsClient
-
-# Initialize the LollmsClient instance please select a different model to test with
-lc = LollmsClient("transformers", model_name= r"microsoft/Phi-4-mini-instruct")
-def cb(text, msg_type=0):
-    print(text,end='', flush=True)
-    return True
-out = lc.generate_text(f"{lc.system_full_header} Act as lollms, a helpful assistant.\n!@>user:Write a poem about love.\n!@>lollms:",streaming_callback=cb)
-print(out)

examples/text_2_audio.py

@@ -1,77 +0,0 @@
-from lollms_client import LollmsClient # Removed LollmsTTS import
-from lollms_client.lollms_types import MSG_TYPE # Import MSG_TYPE if callback uses it
-import random
-from ascii_colors import ASCIIColors # Assuming this might be used for better output
-
-# Initialize the LollmsClient instance, enabling the TTS binding
-# We'll use the 'lollms' tts binding by default.
-# The host_address in LollmsClient will be used by the lollms tts binding.
-lc = LollmsClient(
-    tts_binding_name="lollms" # Explicitly enable the lollms TTS binding
-)
-
-if not lc.tts:
-    ASCIIColors.error("TTS binding could not be initialized. Please check your LollmsClient setup and server.")
-    exit()
-
-voices = lc.tts.list_voices() # Use the new method via lc.tts
-
-# Pick a voice randomly
-if voices:
-    random_voice = random.choice(voices)
-    ASCIIColors.info(f"Selected voice: {random_voice}")
-else:
-    ASCIIColors.warning("No voices found. Using server default.")
-    random_voice = None # Or a known default like "main_voice"
-
-# Generate Text
-# response = lc.generate_text(prompt="Once upon a time", stream=False, temperature=0.5)
-# print(response)
-
-# # Generate Completion
-# response = lc.generate_completion(prompt="What is the capital of France", stream=False, temperature=0.5)
-# print(response)
-
-
-def cb(chunk, msg_type: MSG_TYPE, params=None, metadata=None): # Added params and metadata for full signature
-    print(chunk,end="",flush=True)
-    return True # Callback should return True to continue streaming
-
-response_text = lc.generate_text(prompt="One plus one equals ", stream=False, temperature=0.5, streaming_callback=cb)
-print() # For newline after streaming
-ASCIIColors.green(f"Generated text: {response_text}")
-print()
-
-if response_text and not isinstance(response_text, dict): # Check if generation was successful
-    try:
-        # Assuming generate_audio now might return status or file path rather than direct audio bytes for 'lollms' binding
-        # based on its current server behavior.
-        # If generate_audio for 'lollms' binding is expected to save a file and return status:
-        audio_generation_status = lc.tts.generate_audio(response_text, voice=random_voice, fn="output_example_text_2_audio.wav") # Example filename
-        ASCIIColors.info(f"Audio generation request status: {audio_generation_status}")
-        ASCIIColors.yellow(f"Audio should be saved as 'output_example_text_2_audio.wav' by the server in its default output path.")
-
-    except Exception as e:
-        ASCIIColors.error(f"Error during text to audio conversion: {e}")
-else:
-    ASCIIColors.error(f"Text generation failed or returned an error: {response_text}")
-
-
-# List Mounted Personalities (This is an LLM feature, specific to 'lollms' LLM binding)
-if lc.binding and hasattr(lc.binding, 'lollms_listMountedPersonalities'):
-    personalities_response = lc.listMountedPersonalities()
-    ASCIIColors.blue("\nMounted Personalities:")
-    print(personalities_response)
-else:
-    ASCIIColors.yellow("\nlistMountedPersonalities not available for the current LLM binding.")
-
-
-# List Models (This is an LLM feature)
-models_response = lc.listModels()
-ASCIIColors.blue("\nAvailable LLM Models:")
-print(models_response)
-
-# List available TTS bindings (for demonstration)
-if hasattr(lc, 'tts_binding_manager'):
-    available_tts_bindings = lc.tts_binding_manager.get_available_bindings()
-    ASCIIColors.cyan(f"\nAvailable TTS bindings in client: {available_tts_bindings}")

examples/text_2_image.py

@@ -1,144 +0,0 @@
-from lollms_client import LollmsClient
-from lollms_client.lollms_types import MSG_TYPE # If using callbacks
-from ascii_colors import ASCIIColors, trace_exception
-from PIL import Image
-from pathlib import Path
-import io
-import os
-
-# --- Configuration ---
-# This client_id should match one known by your LoLLMs WebUI if security is enabled for these endpoints.
-# For a default local setup, it might not be strictly checked for /generate_image,
-# but IS required for /list_tti_services, /get_active_tti_settings, /set_active_tti_settings.
-LOLLMS_CLIENT_ID = "my_lollms_client_id" # Replace with your actual client ID or a test one
-
-# Initialize LollmsClient, enabling the TTI 'lollms' binding
-# The service_key here is used as client_id by the TTI binding for lollms
-# lc = LollmsClient(
-#     tti_binding_name="lollms"
-# )
-
-# make sure you have a OPENAI_API_KEY environment variable
-lc = LollmsClient(
-    tti_binding_name="dalle"
-)
-
-if not lc.tti:
-    ASCIIColors.error("TTI binding could not be initialized. Please check LollmsClient setup.")
-    exit()
-
-def test_list_tti_services():
-    ASCIIColors.cyan("\n--- Testing List TTI Services ---")
-    try:
-        # client_id is taken from lc.service_key by the binding
-        services = lc.tti.list_services()
-        if services:
-            ASCIIColors.green("Available TTI Services:")
-            for i, service in enumerate(services):
-                print(f"  {i+1}. Name: {service.get('name')}, Caption: {service.get('caption')}")
-        else:
-            ASCIIColors.yellow("No TTI services listed or an empty list was returned.")
-    except Exception as e:
-        ASCIIColors.error(f"Error listing TTI services: {e}")
-        trace_exception(e)
-
-def test_get_tti_settings():
-    ASCIIColors.cyan("\n--- Testing Get Active TTI Settings ---")
-    try:
-        # client_id is taken from lc.service_key by the binding
-        settings = lc.tti.get_settings()
-        if settings: # Server returns a list for settings template
-            ASCIIColors.green("Current Active TTI Settings/Template:")
-            # Assuming settings is a list of dicts (template format)
-            for setting_item in settings:
-                print(f"  - Name: {setting_item.get('name')}, Type: {setting_item.get('type')}, Value: {setting_item.get('value')}, Help: {setting_item.get('help')}")
-        elif isinstance(settings, dict) and not settings: # Empty dict if no TTI active
-             ASCIIColors.yellow("No active TTI service or settings configured on the server.")
-        else:
-            ASCIIColors.yellow("Could not retrieve TTI settings or format unexpected.")
-            print(f"Received: {settings}")
-    except Exception as e:
-        ASCIIColors.error(f"Error getting TTI settings: {e}")
-        trace_exception(e)
-
-def test_set_tti_settings():
-    ASCIIColors.cyan("\n--- Testing Set Active TTI Settings (Illustrative) ---")
-    ASCIIColors.yellow("Note: This test requires knowing the exact settings structure of your active TTI service.")
-    ASCIIColors.yellow("Skipping actual setting change to avoid misconfiguration.")
-    # Example: If you knew your TTI service had a 'quality' setting:
-    # example_settings_to_set = [
-    #     {"name": "quality", "value": "high", "type": "str", "help": "Image quality"},
-    #     # ... other settings from get_settings()
-    # ]
-    # try:
-    #     # client_id is taken from lc.service_key
-    #     success = lc.tti.set_settings(example_settings_to_set)
-    #     if success:
-    #         ASCIIColors.green("Successfully sent settings update request.")
-    #     else:
-    #         ASCIIColors.red("Failed to set TTI settings (server indicated failure or no change).")
-    # except Exception as e:
-    #     ASCIIColors.error(f"Error setting TTI settings: {e}")
-
-def test_generate_image():
-    ASCIIColors.cyan("\n--- Testing Generate Image ---")
-    prompt = "A futuristic cityscape at sunset, neon lights, flying vehicles"
-    negative_prompt = "blurry, low quality, ugly, text, watermark"
-    width = 1024
-    height = 1024
-    home_dir = Path.home()
-    documents_dir = home_dir / "Documents"
-    output_filename = documents_dir/"generated_lollms_image.jpg"
-
-    ASCIIColors.info(f"Prompt: {prompt}")
-    ASCIIColors.info(f"Negative Prompt: {negative_prompt}")
-    ASCIIColors.info(f"Dimensions: {width}x{height}")
-
-    try:
-        image_bytes = lc.tti.generate_image(
-            prompt=prompt,
-            negative_prompt=negative_prompt,
-            width=width,
-            height=height
-            # You can add other kwargs here if your TTI service supports them, e.g., seed=12345
-        )
-
-        if image_bytes:
-            ASCIIColors.green(f"Image generated successfully ({len(image_bytes)} bytes).")
-            try:
-                image = Image.open(io.BytesIO(image_bytes))
-                image.save(output_filename)
-                ASCIIColors.green(f"Image saved as {output_filename}")
-                # Attempt to show image if possible (platform dependent)
-                if os.name == 'nt': # Windows
-                    os.startfile(output_filename)
-                elif os.name == 'posix': # MacOS/Linux
-                    try:
-                        import subprocess
-                        opener = "open" if platform.system() == "Darwin" else "xdg-open"
-                        subprocess.call([opener, output_filename])
-                    except:
-                        ASCIIColors.yellow(f"Could not auto-open image. Please find it at {output_filename}")
-
-            except Exception as e:
-                ASCIIColors.error(f"Error processing or saving image: {e}")
-                # Save raw bytes if PIL fails, for debugging
-                with open("generated_lollms_image_raw.data", "wb") as f_raw:
-                    f_raw.write(image_bytes)
-                ASCIIColors.yellow("Raw image data saved as generated_lollms_image_raw.data for inspection.")
-
-        else:
-            ASCIIColors.red("Image generation returned empty bytes.")
-
-    except Exception as e:
-        ASCIIColors.error(f"Error during image generation: {e}")
-        trace_exception(e)
-
-if __name__ == "__main__":
-    # Test management functions first
-    test_list_tti_services()
-    test_get_tti_settings()
-    test_set_tti_settings() # Currently illustrative
-
-    # Then test image generation
-    test_generate_image()