signalwire-agents 0.1.0__py3-none-any.whl

signalwire_agents-0.1.0.dist-info/METADATA

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: signalwire_agents
+Version: 0.1.0
+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
+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
+
+# 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
+- **Security Built-In**: Session management, per-call tokens, and basic auth
+- **State Management**: Persistent conversation state with lifecycle hooks
+- **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")
+        self.set_personality("You are a helpful assistant.")
+        self.set_goal("Help users with basic questions.")
+        self.add_instruction("Be concise and clear.")
+    
+    @AgentBase.tool(name="get_time", parameters={})
+    def get_time(self):
+        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.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
+        )
+    
+    # These methods are automatically registered when enable_state_tracking=True
+    def startup_hook(self, args, raw_data):
+        """Called when a conversation starts"""
+        call_id = raw_data.get("call_id")
+        state = self.get_state(call_id) or {}
+        state["started_at"] = "2023-01-01T12:00:00Z"
+        self.update_state(call_id, state)
+        return "Call initialized"
+        
+    def hangup_hook(self, args, raw_data):
+        """Called when a conversation ends"""
+        call_id = raw_data.get("call_id")
+        state = self.get_state(call_id)
+        return "Call completed"
+```
+
+## 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}."
+)
+
+agent.serve(host="0.0.0.0", port=8000, route="/support")
+```
+
+## 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
+
+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
+
+See the [full documentation](https://docs.signalwire.com/ai-agents) for details on:
+
+- Creating custom agents
+- Using prefab agents
+- SWAIG function definitions
+- State management and persistence
+- Security model
+- Deployment options
+- Multi-agent hosting
+
+## License
+
+MIT

signalwire_agents-0.1.0.dist-info/RECORD

@@ -0,0 +1,32 @@
+signalwire_agents/__init__.py,sha256=CKOaLzrbPQWgPrMMdojp1fs7waFnxp_fxzhm79vDDt4,609
+signalwire_agents/agent_server.py,sha256=FWRdNPqlrY6WXY5QqZD4ud4s0U57bDeKiKllo8cp40o,11837
+signalwire_agents/schema.json,sha256=M8Mn6pQda2P9jhbmkALrLr1wt-fRuhYRqdmEi9Rbhqk,178075
+signalwire_agents/core/__init__.py,sha256=KEfW2D3hTM13xB0zAH86zaFcMDw0OMKkuz2N3Eg1EuQ,615
+signalwire_agents/core/agent_base.py,sha256=l8D-0Ufa5kXE3MD6waeITOiW4651xYe4PF4LS47LCnU,94067
+signalwire_agents/core/function_result.py,sha256=myyoinywTcHrRDcBwl0Of5oJdH9g6fRVQK8Ke8G_22I,2963
+signalwire_agents/core/pom_builder.py,sha256=f322xT3WTmc427YVbTPwi14qoZReCLKZ0YpjMKyM2x0,6445
+signalwire_agents/core/swaig_function.py,sha256=MGKYhF9jJYLaBmSq2YtSKMDUtkrFeFwWbdP_0Hd3tts,6125
+signalwire_agents/core/swml_builder.py,sha256=3MYTx_Wq6Bvy7hn5ubXBSKkX42n3VDF1o1YQe8_w8ss,6403
+signalwire_agents/core/swml_handler.py,sha256=_O9JWufTvO219eEKUgcMGTuib0fY_6Qhs0yemgpBpLU,6811
+signalwire_agents/core/swml_renderer.py,sha256=GKj1LYRw9paCaJbrwVDYiT4gPum7keMixHhZjxyYdAk,13700
+signalwire_agents/core/swml_service.py,sha256=DkzIxe3Dc1BPDdL63dxN6qFqXqW8s6b00dLurDIag74,39470
+signalwire_agents/core/security/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+signalwire_agents/core/security/session_manager.py,sha256=2gcODBtk1Z_g0NVGr09V7GkCfuCmoEl4DVbW-1kAOos,5038
+signalwire_agents/core/state/__init__.py,sha256=8Da6qFziYNmYuaIM8imEwAC3DGRJvX0u5hJIIPFmC7c,188
+signalwire_agents/core/state/file_state_manager.py,sha256=rGD_rZy7rdIQm99kQVHLEUo_jiflaNCdQRJ2MllHnZ4,7116
+signalwire_agents/core/state/state_manager.py,sha256=AFHhICiYlI1czOIKbNyi-vauI8RW8oTpp3ZZGUZnMeA,2320
+signalwire_agents/prefabs/__init__.py,sha256=Zhhn0gRXrkDaS9ml54y5YItxJAqD1zhdDuN_-9C-jRo,430
+signalwire_agents/prefabs/concierge.py,sha256=ELPYR1ZO_tH6_QF0xt3PaS0oFAKhQ3UPLvvbC7O_b0Q,10290
+signalwire_agents/prefabs/faq_bot.py,sha256=k_Xd3CddIkPtXuw6X6DH0r-rDuT-5mB6CUM0ShKKkfk,11083
+signalwire_agents/prefabs/info_gatherer.py,sha256=vfg55qlfx28Mcg3YW2o8SrYD7k0yrevg_VSGqZBAO70,9173
+signalwire_agents/prefabs/survey.py,sha256=W3uKDlDtg34cuxuZg6Z0UqZrniQp2V2h3VxSB-Dj8K8,14857
+signalwire_agents/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+signalwire_agents/utils/pom_utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+signalwire_agents/utils/schema_utils.py,sha256=ouvxLkulGIgacYj4ip18IlswxGYMBmBEug27Evz8dgs,13282
+signalwire_agents/utils/token_generators.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+signalwire_agents/utils/validators.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+signalwire_agents-0.1.0.data/data/schema.json,sha256=M8Mn6pQda2P9jhbmkALrLr1wt-fRuhYRqdmEi9Rbhqk,178075
+signalwire_agents-0.1.0.dist-info/METADATA,sha256=R4-f572VAowe2qTR6Ek_zIkeYEHmdMJzSpQK1TJrw6g,5366
+signalwire_agents-0.1.0.dist-info/WHEEL,sha256=QZxptf4Y1BKFRCEDxD4h2V0mBFQOVFLFEpvxHmIs52A,91
+signalwire_agents-0.1.0.dist-info/top_level.txt,sha256=kDGS6ZYv84K9P5Kyg9_S8P_pbUXoHkso0On_DB5bbWc,18
+signalwire_agents-0.1.0.dist-info/RECORD,,

signalwire_agents-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.6.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

signalwire_agents-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+signalwire_agents