signalwire-agents 0.1.30__py3-none-any.whl → 0.1.32__py3-none-any.whl

signalwire_agents/__init__.py

@@ -18,7 +18,7 @@ A package for building AI agents using SignalWire's AI and SWML capabilities.
 from .core.logging_config import configure_logging
 configure_logging()
 
-__version__ = "0.1.30"
+__version__ = "0.1.32"
 
 # Import core classes for easier access
 from .core.agent_base import AgentBase

signalwire_agents/schema.json

@@ -6455,6 +6455,20 @@
           "type": "boolean",
           "description": "A boolean value, if set to `true`, the conversation history will be reset and the agent will only have the context of the original system prompt."
         },
+        "enter_fillers": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/FunctionFillers"
+          },
+          "description": "An array of objects that define the enter fillers for the context. Enter fillers are used when entering the context."
+        },
+        "exit_fillers": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/FunctionFillers"
+          },
+          "description": "An array of objects that define the exit fillers for the context. Exit fillers are used when exiting the context."
+        },
         "pom": {
           "type": "array",
           "items": {
@@ -6484,6 +6498,20 @@
           "type": "boolean",
           "description": "A boolean value, if set to `true`, the conversation history will be reset and the agent will only have the context of the original system prompt."
         },
+        "enter_fillers": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/FunctionFillers"
+          },
+          "description": "An array of objects that define the enter fillers for the context. Enter fillers are used when entering the context."
+        },
+        "exit_fillers": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/FunctionFillers"
+          },
+          "description": "An array of objects that define the exit fillers for the context. Exit fillers are used when exiting the context."
+        },
         "text": {
           "type": "string",
           "description": "The text to send to the agent."
@@ -6712,13 +6740,13 @@
     "ContextSteps": {
       "anyOf": [
         {
-          "$ref": "#/$defs/StepTypePOM"
+          "$ref": "#/$defs/ContextPOMSteps"
         },
         {
-          "$ref": "#/$defs/StepTypeText"
+          "$ref": "#/$defs/ContextTextSteps"
         }
       ],
-      "title": "ContextStepsParams union"
+      "title": "Context step - supports either POM or text-based steps"
     },
     "StringProperty": {
       "type": "object",
@@ -7137,25 +7165,128 @@
       ],
       "title": "Action union"
     },
-    "StepTypePOM": {
-      "anyOf": [
-        {
-          "$ref": "#/$defs/POMEndStep"
+    "ContextPOMSteps": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^(?!next$).*$",
+          "description": "The name of the step. The name must be unique within the context. The name is used for referencing the step in the context."
         },
-        {
-          "$ref": "#/$defs/POMValidSteps"
+        "step_criteria": {
+          "type": "string",
+          "description": "The conditions that must be met for the conversation to proceed to the next step. \nIf a condition is not met, the conversation will not proceed to the next step.\nIt's **highly** recommended you create a custom criteria for the step to get the intended behavior.   "
+        },
+        "functions": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "An array of strings, where each string is the name of a SWAIG.function that can be executed from this step."
+        },
+        "valid_contexts": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "An array of valid contexts that the conversation can transition to from this step."
+        },
+        "skip_user_turn": {
+          "anyOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "$ref": "#/$defs/SWMLVar"
+            }
+          ],
+          "description": "A boolean value, if set to `true`, will skip the user's turn to respond in the conversation and proceed to the next step."
+        },
+        "end": {
+          "type": "boolean",
+          "description": "A boolean value, if set to `true`, will end the contexts conversation and transition to a normal interaction."
+        },
+        "valid_steps": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "An array of valid steps that the conversation can proceed to from this step.\nIf the array is empty, or the `valid_steps` key is not present, the conversation will proceed to the next step in the context."
+        },
+        "pom": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/POM"
+          },
+          "description": "An array of objects that define the POM for the step. POM is the Post-Prompt Object Model, which is used to define the flow of the conversation."
         }
-      ]
+      },
+      "required": [
+        "name",
+        "pom"
+      ],
+      "title": "Context step with POM (Post-Prompt Object Model)",
+      "unevaluatedProperties": false
     },
-    "StepTypeText": {
-      "anyOf": [
-        {
-          "$ref": "#/$defs/TextEndStep"
+    "ContextTextSteps": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^(?!next$).*$",
+          "description": "The name of the step. The name must be unique within the context. The name is used for referencing the step in the context."
         },
-        {
-          "$ref": "#/$defs/TextValidSteps"
+        "step_criteria": {
+          "type": "string",
+          "description": "The conditions that must be met for the conversation to proceed to the next step. \nIf a condition is not met, the conversation will not proceed to the next step.\nIt's **highly** recommended you create a custom criteria for the step to get the intended behavior.   "
+        },
+        "functions": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "An array of strings, where each string is the name of a SWAIG.function that can be executed from this step."
+        },
+        "valid_contexts": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "An array of valid contexts that the conversation can transition to from this step."
+        },
+        "skip_user_turn": {
+          "anyOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "$ref": "#/$defs/SWMLVar"
+            }
+          ],
+          "description": "A boolean value, if set to `true`, will skip the user's turn to respond in the conversation and proceed to the next step."
+        },
+        "end": {
+          "type": "boolean",
+          "description": "A boolean value, if set to `true`, will end the contexts conversation and transition to a normal interaction."
+        },
+        "valid_steps": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "An array of valid steps that the conversation can proceed to from this step.\nIf the array is empty, or the `valid_steps` key is not present, the conversation will proceed to the next step in the context."
+        },
+        "text": {
+          "type": "string",
+          "description": "The prompt or instructions given to the AI at this step."
         }
-      ]
+      },
+      "required": [
+        "name",
+        "text"
+      ],
+      "title": "Context step with text prompt",
+      "unevaluatedProperties": false
     },
     "StringFormat": {
       "type": "string",
@@ -7469,230 +7600,6 @@
       ],
       "title": "UserInputAction object",
       "unevaluatedProperties": false
-    },
-    "POMEndStep": {
-      "type": "object",
-      "properties": {
-        "name": {
-          "type": "string",
-          "pattern": "^(?!next$).*$",
-          "description": "The name of the step. The name must be unique within the context. The name is used for referencing the step in the context."
-        },
-        "step_criteria": {
-          "type": "string",
-          "description": "The conditions that must be met for the conversation to proceed to the next step. \nIf a condition is not met, the conversation will not proceed to the next step.\nIt's **highly** recommended you create a custom criteria for the step to get the intended behavior.   "
-        },
-        "functions": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "An array of strings, where each string is the name of a SWAIG.function that can be executed from this step."
-        },
-        "valid_contexts": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "An array of valid contexts that the conversation can transition to from this step."
-        },
-        "skip_user_turn": {
-          "anyOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "$ref": "#/$defs/SWMLVar"
-            }
-          ],
-          "description": "A boolean value, if set to `true`, will skip the user's turn to respond in the conversation and proceed to the next step."
-        },
-        "pom": {
-          "type": "array",
-          "items": {
-            "$ref": "#/$defs/POM"
-          },
-          "description": "An array of objects that define the POM for the step. POM is the Post-Prompt Object Model, which is used to define the flow of the conversation."
-        },
-        "end": {
-          "type": "boolean",
-          "description": "A boolean value, if set to `true`, will end the contexts conversation and transition to a normal interaction."
-        }
-      },
-      "required": [
-        "name",
-        "pom"
-      ],
-      "title": "ContextStepsEnd object",
-      "unevaluatedProperties": false
-    },
-    "POMValidSteps": {
-      "type": "object",
-      "properties": {
-        "name": {
-          "type": "string",
-          "pattern": "^(?!next$).*$",
-          "description": "The name of the step. The name must be unique within the context. The name is used for referencing the step in the context."
-        },
-        "step_criteria": {
-          "type": "string",
-          "description": "The conditions that must be met for the conversation to proceed to the next step. \nIf a condition is not met, the conversation will not proceed to the next step.\nIt's **highly** recommended you create a custom criteria for the step to get the intended behavior.   "
-        },
-        "functions": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "An array of strings, where each string is the name of a SWAIG.function that can be executed from this step."
-        },
-        "valid_contexts": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "An array of valid contexts that the conversation can transition to from this step."
-        },
-        "skip_user_turn": {
-          "anyOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "$ref": "#/$defs/SWMLVar"
-            }
-          ],
-          "description": "A boolean value, if set to `true`, will skip the user's turn to respond in the conversation and proceed to the next step."
-        },
-        "pom": {
-          "type": "array",
-          "items": {
-            "$ref": "#/$defs/POM"
-          },
-          "description": "An array of objects that define the POM for the step. POM is the Post-Prompt Object Model, which is used to define the flow of the conversation."
-        },
-        "valid_steps": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "An array of valid steps that the conversation can proceed to from this step.\nIf the array is empty, or the `valid_steps` key is not present, the conversation will proceed to the next step in the context."
-        }
-      },
-      "required": [
-        "name",
-        "pom"
-      ],
-      "title": "ContextStepsValidSteps object",
-      "unevaluatedProperties": false
-    },
-    "TextEndStep": {
-      "type": "object",
-      "properties": {
-        "name": {
-          "type": "string",
-          "pattern": "^(?!next$).*$",
-          "description": "The name of the step. The name must be unique within the context. The name is used for referencing the step in the context."
-        },
-        "step_criteria": {
-          "type": "string",
-          "description": "The conditions that must be met for the conversation to proceed to the next step. \nIf a condition is not met, the conversation will not proceed to the next step.\nIt's **highly** recommended you create a custom criteria for the step to get the intended behavior.   "
-        },
-        "functions": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "An array of strings, where each string is the name of a SWAIG.function that can be executed from this step."
-        },
-        "valid_contexts": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "An array of valid contexts that the conversation can transition to from this step."
-        },
-        "skip_user_turn": {
-          "anyOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "$ref": "#/$defs/SWMLVar"
-            }
-          ],
-          "description": "A boolean value, if set to `true`, will skip the user's turn to respond in the conversation and proceed to the next step."
-        },
-        "text": {
-          "type": "string",
-          "description": "The prompt or instructions given to the AI at this step."
-        },
-        "end": {
-          "type": "boolean",
-          "description": "A boolean value, if set to `true`, will end the contexts conversation and transition to a normal interaction."
-        }
-      },
-      "required": [
-        "name",
-        "text"
-      ],
-      "title": "ContextStepsBase object",
-      "unevaluatedProperties": false
-    },
-    "TextValidSteps": {
-      "type": "object",
-      "properties": {
-        "name": {
-          "type": "string",
-          "pattern": "^(?!next$).*$",
-          "description": "The name of the step. The name must be unique within the context. The name is used for referencing the step in the context."
-        },
-        "step_criteria": {
-          "type": "string",
-          "description": "The conditions that must be met for the conversation to proceed to the next step. \nIf a condition is not met, the conversation will not proceed to the next step.\nIt's **highly** recommended you create a custom criteria for the step to get the intended behavior.   "
-        },
-        "functions": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "An array of strings, where each string is the name of a SWAIG.function that can be executed from this step."
-        },
-        "valid_contexts": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "An array of valid contexts that the conversation can transition to from this step."
-        },
-        "skip_user_turn": {
-          "anyOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "$ref": "#/$defs/SWMLVar"
-            }
-          ],
-          "description": "A boolean value, if set to `true`, will skip the user's turn to respond in the conversation and proceed to the next step."
-        },
-        "text": {
-          "type": "string",
-          "description": "The prompt or instructions given to the AI at this step."
-        },
-        "valid_steps": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "An array of valid steps that the conversation can proceed to from this step.\nIf the array is empty, or the `valid_steps` key is not present, the conversation will proceed to the next step in the context."
-        }
-      },
-      "required": [
-        "name",
-        "text"
-      ],
-      "title": "ContextStepsBase object",
-      "unevaluatedProperties": false
     }
   },
   "unevaluatedProperties": false

{signalwire_agents-0.1.30.dist-info → signalwire_agents-0.1.32.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: signalwire_agents
-Version: 0.1.30
+Version: 0.1.32
 Summary: SignalWire AI Agents SDK
 Author-email: SignalWire Team <info@signalwire.com>
 License: MIT
@@ -72,26 +72,74 @@ Requires-Dist: python-pptx>=0.6.21; extra == "search-all"
 Requires-Dist: python-magic>=0.4.27; extra == "search-all"
 Dynamic: license-file
 
-# SignalWire AI Agent SDK
+<!-- Header -->
+<div align="center">
+    <img src="https://github.com/user-attachments/assets/0c8ed3b9-8c50-4dc6-9cc4-cc6cd137fd50" width="500" href="https://signalwire.com" />
 
-A Python SDK for creating, hosting, and securing SignalWire AI agents as microservices with minimal boilerplate.
+# Agents SDK
+
+#### _A Python SDK for creating, hosting, and securing SignalWire AI agents as microservices with minimal boilerplate._
+
+<br/>
+
+<p align="center">
+  <a href="https://developer.signalwire.com/sdks/agents-sdk" target="_blank">📖 Documentation</a> &nbsp; &nbsp; <code>#</code> &nbsp; &nbsp;
+  <a href="https://github.com/signalwire/signalwire-docs/issues/new/choose" target="_blank">🐛 Report an issue</a> &nbsp; &nbsp; <code>#</code> &nbsp; &nbsp;
+  <a href="https://pypi.org/project/signalwire-agents/" target="_blank">🐍 PyPI</a>
+</p>
+
+<br/>
+
+<!-- Badges -->
+<div align="center">
+    <img src="https://img.shields.io/badge/Discord%20Community-5865F2" alt="Discord" href="https://discord.com/invite/F2WNYTNjuF"/>
+    <img src="https://img.shields.io/badge/MIT-License-blue" alt="MIT License" href="LICENSE" />
+    <img src="https://img.shields.io/badge/GitHub-%23121011.svg?logo=github&logoColor=white&" alt="GitHub" href="https://github.com/signalwire"/>
+    <img src="https://img.shields.io/github/stars/signalwire/signalwire-agents" alt="GitHub Stars" href="https://github.com/signalwire/docs"/>
+</div>
+
+</div>
 
 ## 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
-- **Dynamic Configuration**: Configure agents per-request for multi-tenant apps and personalization
-- **Custom Routing**: Dynamic request handling for different paths and content
-- **SIP Integration**: Route SIP calls to agents based on SIP usernames
-- **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
-- **Modular Skills System**: Add capabilities to agents with simple one-liner calls
-- **Local Search System**: Offline document search with vector similarity and keyword search
-
-## Skills System
+|                   |                                                                  |
+|-------------------------------|-----------------------------------------------------------------------------|
+| 🤖     **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                               |
+| 🔧     **Dynamic Configuration** | Configure agents per-request for multi-tenant apps and personalization    |
+| 🗺️     **Custom Routing**        | Dynamic request handling for different paths and content                  |
+| 📞     **SIP Integration**       | Route SIP calls to agents based on SIP usernames                          |
+| 🔒     **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                                  |
+| �      **Modular Skills System** | Add capabilities to agents with simple one-liner calls                   |
+| 🔍     **Local Search System**   | Offline document search with vector similarity and keyword search        |
+
+<picture>
+  <source
+    media="(prefers-color-scheme: dark)"
+    srcset="
+      https://api.star-history.com/svg?repos=signalwire/signalwire-agents&type=Date&theme=dark
+    "
+  />
+  <source
+    media="(prefers-color-scheme: light)"
+    srcset="
+      https://api.star-history.com/svg?repos=signalwire/signalwire-agents&type=Date
+    "
+  />
+  <img
+    alt="Star History Chart"
+    src="https://api.star-history.com/svg?repos=signalwire/signalwire-agents&type=Date"
+  />
+</picture>
+
+<details>
+<summary><h2>Documentation</h2></summary>
+
+### Skills System
 
 The SignalWire Agents SDK includes a powerful modular skills system that allows you to add complex capabilities to your agents with simple one-liner calls:
 
@@ -163,7 +211,7 @@ agent.add_skill("datasphere", {
 agent.serve()
 ```
 
-### Available Built-in Skills
+#### Available Built-in Skills
 
 - **web_search**: Google Custom Search API integration with web scraping (supports multiple instances)
 - **datetime**: Current date and time with timezone support
@@ -171,7 +219,7 @@ agent.serve()
 - **datasphere**: SignalWire DataSphere knowledge search (supports multiple instances)
 - **native_vector_search**: Offline document search with vector similarity and keyword search
 
-### Benefits
+#### Benefits
 
 - **One-liner integration**: `agent.add_skill("skill_name")`
 - **Configurable parameters**: `agent.add_skill("skill_name", {"param": "value"})`
@@ -181,11 +229,11 @@ agent.serve()
 
 For detailed documentation, see [Skills System README](docs/skills_system.md).
 
-## DataMap Tools
+### DataMap Tools
 
 The SDK provides a DataMap system for creating SWAIG tools that integrate directly with REST APIs without requiring custom webhook endpoints. DataMap tools execute on the SignalWire server, making them simpler to deploy than traditional webhook-based tools.
 
-### Basic DataMap Usage
+#### Basic DataMap Usage
 
 ```python
 from signalwire_agents import AgentBase
@@ -211,7 +259,7 @@ agent = APIAgent()
 agent.serve()
 ```
 
-### Advanced DataMap Examples
+#### Advanced DataMap Examples
 
 ```python
 # POST API with authentication
@@ -242,7 +290,7 @@ docs_tool = (DataMap('get_latest_docs')
 )
 ```
 
-### Helper Functions
+#### Helper Functions
 
 For simpler use cases, use the convenience functions:
 
@@ -272,7 +320,7 @@ self.register_swaig_function(weather.to_swaig_function())
 self.register_swaig_function(file_control.to_swaig_function())
 ```
 
-### Variable Expansion
+#### Variable Expansion
 
 DataMap tools support powerful variable expansion using `${variable}` syntax:
 
@@ -282,7 +330,7 @@ DataMap tools support powerful variable expansion using `${variable}` syntax:
 - **Global data**: `${global_data.key}`
 - **Metadata**: `${meta_data.call_id}`
 
-### Benefits of DataMap Tools
+#### Benefits of DataMap Tools
 
 - **No webhook infrastructure**: Tools run on SignalWire servers
 - **Simplified deployment**: No need to expose endpoints
@@ -293,11 +341,11 @@ DataMap tools support powerful variable expansion using `${variable}` syntax:
 
 For detailed documentation, see [DataMap Guide](docs/datamap_guide.md).
 
-## Contexts and Steps
+### Contexts and Steps
 
 The SignalWire Agents SDK provides a powerful enhancement to traditional prompts through the **Contexts and Steps** system. This feature allows you to add structured, workflow-driven AI interactions on top of your base prompt, with explicit navigation control and step-by-step guidance.
 
-### Why Use Contexts and Steps?
+#### Why Use Contexts and Steps?
 
 - **Structured Workflows**: Define clear, step-by-step processes for complex interactions
 - **Navigation Control**: Explicitly control which steps or contexts users can access
@@ -306,7 +354,7 @@ The SignalWire Agents SDK provides a powerful enhancement to traditional prompts
 - **Workflow Isolation**: Create separate contexts for different conversation flows
 - **Enhanced Base Prompts**: Adds structured workflows on top of your existing prompt foundation
 
-### Basic Usage
+#### Basic Usage
 
 ```python
 from signalwire_agents import AgentBase
@@ -351,7 +399,7 @@ agent = WorkflowAgent()
 agent.serve()
 ```
 
-### Advanced Features
+#### Advanced Features
 
 ```python
 class MultiContextAgent(AgentBase):
@@ -394,13 +442,13 @@ class MultiContextAgent(AgentBase):
             .set_valid_contexts(["main"])  # Can return to main
 ```
 
-### Context and Step Methods
+#### Context and Step Methods
 
-#### Context Methods
+##### Context Methods
 - `add_step(name)`: Create a new step in this context
 - `set_valid_contexts(contexts)`: Control which contexts can be accessed from this context
 
-#### Step Methods
+##### Step Methods
 - `set_text(text)`: Set direct text prompt for the step
 - `add_section(title, body)`: Add POM-style section (alternative to set_text)
 - `add_bullets(bullets)`: Add bullet points to the current or last section
@@ -409,14 +457,14 @@ class MultiContextAgent(AgentBase):
 - `set_valid_steps(steps)`: Control navigation to other steps in same context
 - `set_valid_contexts(contexts)`: Control navigation to other contexts
 
-### Navigation Rules
+#### Navigation Rules
 
 - **Valid Steps**: If omitted, only "next" step is implied. If specified, only those steps are allowed.
 - **Valid Contexts**: If omitted, user is trapped in current context. If specified, can navigate to those contexts.
 - **Single Context**: Must be named "default" for single-context workflows.
 - **Function Restrictions**: Use `set_functions(["function_name"])` or `set_functions("none")` to control AI tool access.
 
-### Complete Example: Customer Support Workflow
+#### Complete Example: Customer Support Workflow
 
 ```python
 class SupportAgent(AgentBase):
@@ -471,7 +519,7 @@ agent = SupportAgent()
 agent.serve()
 ```
 
-### Benefits
+#### Benefits
 
 - **Clear Structure**: Explicit workflow definition makes agent behavior predictable
 - **Enhanced Control**: Fine-grained control over function access and navigation
@@ -481,19 +529,19 @@ agent.serve()
 
 For detailed documentation and advanced examples, see [Contexts and Steps Guide](docs/contexts_guide.md).
 
-## Installation
+### Installation
 
-### Basic Installation
+#### Basic Installation
 
 ```bash
 pip install signalwire-agents
 ```
 
-### Optional Search Functionality
+#### Optional Search Functionality
 
 The SDK includes optional local search capabilities that can be installed separately to avoid adding large dependencies to the base installation:
 
-#### Search Installation Options
+##### Search Installation Options
 
 ```bash
 # Query existing .swsearch files only (smallest footprint)
@@ -512,7 +560,7 @@ pip install signalwire-agents[search-nlp]
 pip install signalwire-agents[search-all]
 ```
 
-#### What Each Option Includes
+##### What Each Option Includes
 
 | Option | Size | Features |
 |--------|------|----------|
@@ -528,7 +576,7 @@ pip install signalwire-agents[search-all]
 - Agents that only need to query knowledge bases (not build them)
 - Smaller deployment footprint requirements
 
-#### Search Features
+##### Search Features
 
 - **Local/Offline Search**: No external API dependencies
 - **Hybrid Search**: Vector similarity + keyword search
@@ -537,7 +585,7 @@ pip install signalwire-agents[search-all]
 - **CLI Tools**: Build search indexes from document directories
 - **HTTP API**: Standalone or embedded search service
 
-#### Usage Example
+##### Usage Example
 
 ```python
 # Only available with search extras installed
@@ -560,7 +608,7 @@ results = engine.search(
 )
 ```
 
-## Quick Start
+### Quick Start
 
 ```python
 from signalwire_agents import AgentBase
@@ -593,7 +641,7 @@ if __name__ == "__main__":
     agent.serve(host="0.0.0.0", port=8000)
 ```
 
-## Using Prefab Agents
+### Using Prefab Agents
 
 ```python
 from signalwire_agents.prefabs import InfoGathererAgent
@@ -618,16 +666,16 @@ Available prefabs include:
 - `SurveyAgent`: Conducts structured surveys with questions and rating scales
 - `ReceptionistAgent`: Greets callers and transfers them to appropriate departments
 
-## Dynamic Agent Configuration
+### Dynamic Agent Configuration
 
 Configure agents dynamically based on request parameters for multi-tenant applications, A/B testing, and personalization.
 
-### Static vs Dynamic Configuration
+#### Static vs Dynamic Configuration
 
 - **Static**: Agent configured once at startup (traditional approach)
 - **Dynamic**: Agent configured fresh for each request based on parameters
 
-### Basic Example
+#### Basic Example
 
 ```python
 from signalwire_agents import AgentBase
@@ -672,7 +720,7 @@ class DynamicAgent(AgentBase):
 # curl "http://localhost:3000/dynamic?tier=standard&language=en"
 ```
 
-### Use Cases
+#### Use Cases
 
 - **Multi-tenant SaaS**: Different configurations per customer/organization
 - **A/B Testing**: Test different agent behaviors with different user groups
@@ -680,7 +728,7 @@ class DynamicAgent(AgentBase):
 - **Localization**: Language and cultural adaptation based on user location
 - **Dynamic Pricing**: Adjust features and capabilities based on subscription tiers
 
-### Preserving Dynamic State in SWAIG Callbacks
+#### Preserving Dynamic State in SWAIG Callbacks
 
 When using dynamic configuration to add skills or tools based on request parameters, there's a challenge: SWAIG webhook callbacks are separate HTTP requests that won't have the original query parameters. The SDK provides `add_swaig_query_params()` to solve this:
 
@@ -726,9 +774,9 @@ This ensures that any dynamic configuration based on request parameters is consi
 
 For detailed documentation and advanced examples, see the [Agent Guide](docs/agent_guide.md#dynamic-agent-configuration).
 
-## Configuration
+### Configuration
 
-### Environment Variables
+#### Environment Variables
 
 The SDK supports the following environment variables:
 
@@ -745,14 +793,14 @@ When the auth environment variables are set, they will be used for all agents in
 
 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.
 
-## Testing
+### Testing
 
 The SDK includes powerful CLI tools for development and testing:
 
 - **`swaig-test`**: Comprehensive local testing and serverless environment simulation
 - **`sw-search`**: Build local search indexes from document directories and search within them
 
-### Local Testing with swaig-test
+#### Local Testing with swaig-test
 
 Test your agents locally without deployment:
 
@@ -774,7 +822,7 @@ swaig-test examples/my_agent.py --dump-swml
 swaig-test examples/my_agent.py --dump-swml --format-json | jq '.'
 ```
 
-### Serverless Environment Simulation
+#### Serverless Environment Simulation
 
 Test your agents in simulated serverless environments without deployment:
 
@@ -807,7 +855,7 @@ swaig-test examples/my_agent.py --simulate-serverless azure_function \
   --exec my_function
 ```
 
-### Environment Management
+#### Environment Management
 
 Use environment files for consistent testing across platforms:
 
@@ -829,7 +877,7 @@ swaig-test examples/my_agent.py --simulate-serverless lambda \
   --env-file production.env --env DEBUG=true --dump-swml
 ```
 
-### Cross-Platform Testing
+#### Cross-Platform Testing
 
 Test the same agent across multiple serverless platforms:
 
@@ -846,7 +894,7 @@ swaig-test examples/my_agent.py --simulate-serverless lambda --dump-swml | grep
 swaig-test examples/my_agent.py --simulate-serverless cgi --cgi-host example.com --dump-swml | grep web_hook_url
 ```
 
-### Key Benefits
+#### Key Benefits
 
 - **No Deployment Required**: Test serverless behavior locally
 - **Environment Simulation**: Complete platform-specific environment variable setup
@@ -857,7 +905,7 @@ swaig-test examples/my_agent.py --simulate-serverless cgi --cgi-host example.com
 
 For detailed testing documentation, see the [CLI Testing Guide](docs/cli_testing_guide.md).
 
-## Documentation
+### Documentation
 
 The package includes comprehensive documentation in the `docs/` directory:
 
@@ -870,6 +918,12 @@ The package includes comprehensive documentation in the `docs/` directory:
 
 These documents provide in-depth explanations of the features, APIs, and usage patterns.
 
+</details
+
+### ***[Read the official docs.](https://developer.signalwire.com/sdks/agents-sdk)***
+
+---
+
 ## License
 
 MIT

{signalwire_agents-0.1.30.dist-info → signalwire_agents-0.1.32.dist-info}/RECORD

@@ -1,6 +1,6 @@
-signalwire_agents/__init__.py,sha256=5TiCvjU53y8o22RKkXnmqehcXDi62LZQ_YOaqIUq35k,2608
+signalwire_agents/__init__.py,sha256=LAnGf-IAb3LdYxNKag2n8bhaqiDytjiKShisdVKXZ8U,2608
 signalwire_agents/agent_server.py,sha256=x9HyWia8D3r6KMqY-Q4DtNVivfJWLTx8B-KzUI8okuA,26880
-signalwire_agents/schema.json,sha256=AWhh6MoMU95roA_6RSdVdvbHDWPYqMavRoSnsVeMiw8,240965
+signalwire_agents/schema.json,sha256=6-7ccbt39iM1CO36dOfvupRPfd0gnQ0XoAdyo-EFyjo,238042
 signalwire_agents/cli/__init__.py,sha256=XbxAQFaCIdGXIXJiriVBWoFPOJsC401u21588nO4TG8,388
 signalwire_agents/cli/build_search.py,sha256=KLQJBqVSADFyGcKAi0KLwU_UoUd5rtRoKAdfcH91u70,28652
 signalwire_agents/cli/config.py,sha256=2i4e0BArdKsaXxjeueYYRNke7GWicHPYC2wuitVrP7A,2541
@@ -121,9 +121,9 @@ signalwire_agents/utils/pom_utils.py,sha256=4Mr7baQ_xR_hfJ72YxQRAT_GFa663YjFX_Pu
 signalwire_agents/utils/schema_utils.py,sha256=i4okv_O9bUApwT_jJf4Yoij3bLCrGrW3DC-vzSy2RuY,16392
 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.30.dist-info/licenses/LICENSE,sha256=NYvAsB-rTcSvG9cqHt9EUHAWLiA9YzM4Qfz-mPdvDR0,1067
-signalwire_agents-0.1.30.dist-info/METADATA,sha256=AcO-83M3tqqeVWTfXm3hQ6KNk4SrHgKKGsvgR80zRZ4,35907
-signalwire_agents-0.1.30.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-signalwire_agents-0.1.30.dist-info/entry_points.txt,sha256=sfdeRaTSs9J56pqFdcZGRTxQcTuecb8IMx8gqleJ6s0,136
-signalwire_agents-0.1.30.dist-info/top_level.txt,sha256=kDGS6ZYv84K9P5Kyg9_S8P_pbUXoHkso0On_DB5bbWc,18
-signalwire_agents-0.1.30.dist-info/RECORD,,
+signalwire_agents-0.1.32.dist-info/licenses/LICENSE,sha256=NYvAsB-rTcSvG9cqHt9EUHAWLiA9YzM4Qfz-mPdvDR0,1067
+signalwire_agents-0.1.32.dist-info/METADATA,sha256=weKRqyFq6N4mYkFJOr0v5TgGEN-nBjqsxA4cVmnmMn0,38391
+signalwire_agents-0.1.32.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+signalwire_agents-0.1.32.dist-info/entry_points.txt,sha256=sfdeRaTSs9J56pqFdcZGRTxQcTuecb8IMx8gqleJ6s0,136
+signalwire_agents-0.1.32.dist-info/top_level.txt,sha256=kDGS6ZYv84K9P5Kyg9_S8P_pbUXoHkso0On_DB5bbWc,18
+signalwire_agents-0.1.32.dist-info/RECORD,,