signalwire-agents 0.1.6__py3-none-any.whl → 1.0.7__py3-none-any.whl

signalwire_agents-0.1.6.dist-info/METADATA

@@ -1,199 +0,0 @@
-Metadata-Version: 2.4
-Name: signalwire_agents
-Version: 0.1.6
-Summary: SignalWire AI Agents SDK
-Author-email: SignalWire Team <info@signalwire.com>
-Project-URL: Homepage, https://github.com/signalwire/signalwire-ai-agents
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: fastapi==0.115.12
-Requires-Dist: pydantic==2.11.4
-Requires-Dist: PyYAML==6.0.2
-Requires-Dist: Requests==2.32.3
-Requires-Dist: setuptools==66.1.1
-Requires-Dist: signalwire_pom==2.7.1
-Requires-Dist: structlog==25.3.0
-Requires-Dist: uvicorn==0.34.2
-Dynamic: license-file
-
-# SignalWire AI Agent SDK
-
-A Python SDK for creating, hosting, and securing SignalWire AI agents as microservices with minimal boilerplate.
-
-## Features
-
-- **Self-Contained Agents**: Each agent is both a web app and an AI persona
-- **Prompt Object Model**: Structured prompt composition using POM
-- **SWAIG Integration**: Easily define and handle AI tools/functions
-- **Custom Routing**: Dynamic request handling for different paths and content
-- **Security Built-In**: Session management, function-specific security tokens, and basic auth
-- **State Management**: Persistent conversation state with automatic tracking
-- **Prefab Archetypes**: Ready-to-use agent types for common scenarios
-- **Multi-Agent Support**: Host multiple agents on a single server
-
-## Installation
-
-```bash
-pip install signalwire-agents
-```
-
-## Quick Start
-
-```python
-from signalwire_agents import AgentBase
-from signalwire_agents.core.function_result import SwaigFunctionResult
-
-class SimpleAgent(AgentBase):
-    def __init__(self):
-        super().__init__(name="simple", route="/simple")
-        
-        # Configure the agent's personality
-        self.prompt_add_section("Personality", body="You are a helpful assistant.")
-        self.prompt_add_section("Goal", body="Help users with basic questions.")
-        self.prompt_add_section("Instructions", bullets=["Be concise and clear."])
-        
-        # Alternative using convenience methods:
-        # self.setPersonality("You are a helpful assistant.")
-        # self.setGoal("Help users with basic questions.")
-        # self.setInstructions(["Be concise and clear."])
-    
-    @AgentBase.tool(
-        name="get_time", 
-        description="Get the current time",
-        parameters={}
-    )
-    def get_time(self, args, raw_data):
-        from datetime import datetime
-        now = datetime.now().strftime("%H:%M:%S")
-        return SwaigFunctionResult(f"The current time is {now}")
-
-# Run the agent
-if __name__ == "__main__":
-    agent = SimpleAgent()
-    agent.serve(host="0.0.0.0", port=8000)
-```
-
-## Using State Management
-
-```python
-from signalwire_agents import AgentBase
-from signalwire_agents.core.function_result import SwaigFunctionResult
-from signalwire_agents.core.state import FileStateManager
-
-class StatefulAgent(AgentBase):
-    def __init__(self):
-        # Configure state management
-        state_manager = FileStateManager(storage_dir="./state_data")
-        
-        super().__init__(
-            name="stateful", 
-            route="/stateful",
-            enable_state_tracking=True,  # Enable state tracking
-            state_manager=state_manager  # Use custom state manager
-        )
-        
-        # When enable_state_tracking=True, startup_hook and hangup_hook
-        # are automatically registered to track session lifecycle
-    
-    # Custom tool for accessing and updating state
-    @AgentBase.tool(
-        name="save_preference",
-        description="Save a user preference",
-        parameters={
-            "preference_name": {
-                "type": "string",
-                "description": "Name of the preference to save"
-            },
-            "preference_value": {
-                "type": "string",
-                "description": "Value of the preference"
-            }
-        }
-    )
-    def save_preference(self, args, raw_data):
-        # Get the call ID from the raw data
-        call_id = raw_data.get("call_id")
-        
-        if call_id:
-            # Get current state or empty dict if none exists
-            state = self.get_state(call_id) or {}
-            
-            # Update the state
-            preferences = state.get("preferences", {})
-            preferences[args.get("preference_name")] = args.get("preference_value")
-            state["preferences"] = preferences
-            
-            # Save the updated state
-            self.update_state(call_id, state)
-            
-            return SwaigFunctionResult("Preference saved successfully")
-        else:
-            return SwaigFunctionResult("Could not save preference: No call ID")
-```
-
-## Using Prefab Agents
-
-```python
-from signalwire_agents.prefabs import InfoGathererAgent
-
-agent = InfoGathererAgent(
-    fields=[
-        {"name": "full_name", "prompt": "What is your full name?"},
-        {"name": "reason", "prompt": "How can I help you today?"}
-    ],
-    confirmation_template="Thanks {full_name}, I'll help you with {reason}.",
-    name="info-gatherer",
-    route="/info-gatherer"
-)
-
-agent.serve(host="0.0.0.0", port=8000)
-```
-
-Available prefabs include:
-- `InfoGathererAgent`: Collects structured information from users
-- `FAQBotAgent`: Answers questions based on a knowledge base
-- `ConciergeAgent`: Routes users to specialized agents
-- `SurveyAgent`: Conducts structured surveys with questions and rating scales
-
-## Configuration
-
-### Environment Variables
-
-The SDK supports the following environment variables:
-
-- `SWML_BASIC_AUTH_USER`: Username for basic auth (default: auto-generated)
-- `SWML_BASIC_AUTH_PASSWORD`: Password for basic auth (default: auto-generated)
-- `SWML_PROXY_URL_BASE`: Base URL to use when behind a reverse proxy, used for constructing webhook URLs
-- `SWML_SSL_ENABLED`: Enable HTTPS/SSL support (values: "true", "1", "yes")
-- `SWML_SSL_CERT_PATH`: Path to SSL certificate file
-- `SWML_SSL_KEY_PATH`: Path to SSL private key file
-- `SWML_DOMAIN`: Domain name for SSL certificate and external URLs
-- `SWML_SCHEMA_PATH`: Optional path to override the location of the schema.json file
-
-When the auth environment variables are set, they will be used for all agents instead of generating random credentials. The proxy URL base is useful when your service is behind a reverse proxy or when you need external services to access your webhooks.
-
-To enable HTTPS directly (without a reverse proxy), set `SWML_SSL_ENABLED` to "true", provide valid paths to your certificate and key files, and specify your domain name.
-
-## Documentation
-
-The package includes comprehensive documentation in the `docs/` directory:
-
-- [Agent Guide](docs/agent_guide.md) - Detailed guide to creating and customizing agents
-- [Architecture](docs/architecture.md) - Overview of the SDK architecture and core concepts
-- [SWML Service Guide](docs/swml_service_guide.md) - Guide to the underlying SWML service
-
-These documents provide in-depth explanations of the features, APIs, and usage patterns.
-
-## License
-
-MIT

signalwire_agents-0.1.6.dist-info/RECORD

@@ -1,34 +0,0 @@
-signalwire_agents/__init__.py,sha256=q_3tXAaEKU5Yrua20bVq-dFYg0Q4burukwe_9KBujdw,800
-signalwire_agents/agent_server.py,sha256=se_YzOQE5UUoRUKCbTnOg9qr4G3qN7iVuQLutwXEwFU,12850
-signalwire_agents/schema.json,sha256=M8Mn6pQda2P9jhbmkALrLr1wt-fRuhYRqdmEi9Rbhqk,178075
-signalwire_agents/core/__init__.py,sha256=mVDLbpq1pg_WwiqsQR28NNZwJ6-VUXFIfg-vN7pk0ew,806
-signalwire_agents/core/agent_base.py,sha256=Qd25AARkFl7zGj01o7XZogtk6f8PpXYsz7bfRcpwUuA,99436
-signalwire_agents/core/function_result.py,sha256=vD8eBDJBQNNnss1jShadfogCZw_prODB6eBkTuVgZKA,3538
-signalwire_agents/core/pom_builder.py,sha256=ywuiIfP8BeLBPo_G4X1teZlG6zTCMkW71CZnmyoDTAQ,6636
-signalwire_agents/core/swaig_function.py,sha256=WoHGQuCmU9L9k39pttRunmfRtIa_PnNRn9W0Xq3MfIk,6316
-signalwire_agents/core/swml_builder.py,sha256=Y_eHThVVso-_Hz4f73eEuu3HJstsM9PtBl-36GvAXhI,6594
-signalwire_agents/core/swml_handler.py,sha256=KvphI_YY47VWGVXaix_N3SuQSyygHEUr9We6xESQK44,7002
-signalwire_agents/core/swml_renderer.py,sha256=iobMWWoBR7dkHndI3Qlwf4C0fg2p7DmAU2Rb7ZmmLhA,13891
-signalwire_agents/core/swml_service.py,sha256=J3IHJxU172bQa0zd2xRtFwVWonui4f1v_ki1KYHl9lI,47414
-signalwire_agents/core/security/__init__.py,sha256=4Mr7baQ_xR_hfJ72YxQRAT_GFa663YjFX_PumJ35Xds,191
-signalwire_agents/core/security/session_manager.py,sha256=5y0Mr3cI63cO34ctFgq-KX26mdG0Tpr7rTEsgoTS_44,5229
-signalwire_agents/core/state/__init__.py,sha256=qpYIfQBApet6VQsy6diS3yu0lMxCBC6REOUk5l1McUw,379
-signalwire_agents/core/state/file_state_manager.py,sha256=52I_KVlmhHCbKIaHj74Q-ksP_-AF6ewYmOXCf4n5DTQ,7307
-signalwire_agents/core/state/state_manager.py,sha256=76B4mDutMb826dK4c_IJhOXH09BW1bJu6EZa6Mh_LB4,2511
-signalwire_agents/prefabs/__init__.py,sha256=MW11J63XH7KxF2MWguRsMFM9iqMWexaEO9ynDPL_PDM,715
-signalwire_agents/prefabs/concierge.py,sha256=--esvAV1lozQGYXHAqvSg8_TtlIoVfQK75APJ5zqX9I,9779
-signalwire_agents/prefabs/faq_bot.py,sha256=cUuHhnDB8S4aVg-DiQe4jBmCAPrYQrND_Mff9iaeEa0,10572
-signalwire_agents/prefabs/info_gatherer.py,sha256=y9gxjq1vF0-TrE6m734dCcAHqxt0I_DyCqxoM45QY8U,9940
-signalwire_agents/prefabs/receptionist.py,sha256=Wb22igXTD8QK9lQVcJq88eIk7qQ2GSSIzSGuYyK-Dbk,10293
-signalwire_agents/prefabs/survey.py,sha256=1pyUeZ5heDqFAYqkYs5fHN_jQ7TKqJInnOOUQEajSsY,14358
-signalwire_agents/utils/__init__.py,sha256=4Mr7baQ_xR_hfJ72YxQRAT_GFa663YjFX_PumJ35Xds,191
-signalwire_agents/utils/pom_utils.py,sha256=4Mr7baQ_xR_hfJ72YxQRAT_GFa663YjFX_PumJ35Xds,191
-signalwire_agents/utils/schema_utils.py,sha256=LvFCFvJTQk_xYK0B-NXbkXKEF7Zmv-LqpV_vfpPnOb4,13473
-signalwire_agents/utils/token_generators.py,sha256=4Mr7baQ_xR_hfJ72YxQRAT_GFa663YjFX_PumJ35Xds,191
-signalwire_agents/utils/validators.py,sha256=4Mr7baQ_xR_hfJ72YxQRAT_GFa663YjFX_PumJ35Xds,191
-signalwire_agents-0.1.6.data/data/schema.json,sha256=M8Mn6pQda2P9jhbmkALrLr1wt-fRuhYRqdmEi9Rbhqk,178075
-signalwire_agents-0.1.6.dist-info/licenses/LICENSE,sha256=NYvAsB-rTcSvG9cqHt9EUHAWLiA9YzM4Qfz-mPdvDR0,1067
-signalwire_agents-0.1.6.dist-info/METADATA,sha256=A4krRD2w2jb0ukbBI1kHZ6nYctSZodaaMC6Oyja13nI,7414
-signalwire_agents-0.1.6.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-signalwire_agents-0.1.6.dist-info/top_level.txt,sha256=kDGS6ZYv84K9P5Kyg9_S8P_pbUXoHkso0On_DB5bbWc,18
-signalwire_agents-0.1.6.dist-info/RECORD,,