signalwire-agents 0.1.31__py3-none-any.whl → 0.1.33__py3-none-any.whl

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.31.dist-info → signalwire_agents-0.1.33.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: signalwire_agents
-Version: 0.1.31
+Version: 0.1.33
 Summary: SignalWire AI Agents SDK
 Author-email: SignalWire Team <info@signalwire.com>
 License: MIT
@@ -98,12 +98,16 @@ Dynamic: license-file
     <img src="https://img.shields.io/github/stars/signalwire/signalwire-agents" alt="GitHub Stars" href="https://github.com/signalwire/docs"/>
 </div>
 
+<br/>
+
+<img src="https://github.com/user-attachments/assets/c2510c86-ae03-42a9-be06-ab9bcea948e1" alt="Sign Up" href="https://signalwire.com/signup" height="65"/>
+
 </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                               |
@@ -117,24 +121,84 @@ Dynamic: license-file
 | �      **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>
+## Installation
+
+### Basic Installation
+
+```bash
+pip install signalwire-agents
+```
+
+### 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
+
+```bash
+# Query existing .swsearch files only (smallest footprint)
+pip install signalwire-agents[search-queryonly]
+
+# Basic search (vector search + keyword search + building indexes)
+pip install signalwire-agents[search]
+
+# Full search with document processing (PDF, DOCX, etc.)
+pip install signalwire-agents[search-full]
+
+# Advanced NLP features (includes spaCy)
+pip install signalwire-agents[search-nlp]
+
+# All search features
+pip install signalwire-agents[search-all]
+```
+
+#### What Each Option Includes
+
+| Option | Size | Features |
+|--------|------|----------|
+| `search-queryonly` | ~400MB | Query existing .swsearch files only (no building/processing) |
+| `search` | ~500MB | Vector embeddings, keyword search, basic text processing |
+| `search-full` | ~600MB | + PDF, DOCX, Excel, PowerPoint, HTML, Markdown processing |
+| `search-nlp` | ~600MB | + Advanced spaCy NLP features |
+| `search-all` | ~700MB | All search features combined |
+
+**When to use `search-queryonly`:**
+- Production containers with pre-built `.swsearch` files
+- Lambda/serverless deployments
+- Agents that only need to query knowledge bases (not build them)
+- Smaller deployment footprint requirements
+
+#### Search Features
+
+- **Local/Offline Search**: No external API dependencies
+- **Hybrid Search**: Vector similarity + keyword search
+- **Smart Document Processing**: Markdown, Python, PDF, DOCX, etc.
+- **Multiple Languages**: English, Spanish, with extensible framework
+- **CLI Tools**: Build search indexes from document directories
+- **HTTP API**: Standalone or embedded search service
+
+#### Usage Example
+
+```python
+# Only available with search extras installed
+from signalwire_agents.search import IndexBuilder, SearchEngine
+
+# Build search index
+builder = IndexBuilder()
+builder.build_index(
+    source_dir="./docs",
+    output_file="knowledge.swsearch",
+    file_types=['md', 'txt', 'pdf']
+)
+
+# Search documents
+engine = SearchEngine("knowledge.swsearch")
+results = engine.search(
+    query_vector=embeddings,
+    enhanced_text="search query",
+    count=5
+)
+```
 
 <details>
 <summary><h2>Documentation</h2></summary>
@@ -529,85 +593,6 @@ agent.serve()
 
 For detailed documentation and advanced examples, see [Contexts and Steps Guide](docs/contexts_guide.md).
 
-### Installation
-
-#### Basic Installation
-
-```bash
-pip install signalwire-agents
-```
-
-#### 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
-
-```bash
-# Query existing .swsearch files only (smallest footprint)
-pip install signalwire-agents[search-queryonly]
-
-# Basic search (vector search + keyword search + building indexes)
-pip install signalwire-agents[search]
-
-# Full search with document processing (PDF, DOCX, etc.)
-pip install signalwire-agents[search-full]
-
-# Advanced NLP features (includes spaCy)
-pip install signalwire-agents[search-nlp]
-
-# All search features
-pip install signalwire-agents[search-all]
-```
-
-##### What Each Option Includes
-
-| Option | Size | Features |
-|--------|------|----------|
-| `search-queryonly` | ~400MB | Query existing .swsearch files only (no building/processing) |
-| `search` | ~500MB | Vector embeddings, keyword search, basic text processing |
-| `search-full` | ~600MB | + PDF, DOCX, Excel, PowerPoint, HTML, Markdown processing |
-| `search-nlp` | ~600MB | + Advanced spaCy NLP features |
-| `search-all` | ~700MB | All search features combined |
-
-**When to use `search-queryonly`:**
-- Production containers with pre-built `.swsearch` files
-- Lambda/serverless deployments
-- Agents that only need to query knowledge bases (not build them)
-- Smaller deployment footprint requirements
-
-##### Search Features
-
-- **Local/Offline Search**: No external API dependencies
-- **Hybrid Search**: Vector similarity + keyword search
-- **Smart Document Processing**: Markdown, Python, PDF, DOCX, etc.
-- **Multiple Languages**: English, Spanish, with extensible framework
-- **CLI Tools**: Build search indexes from document directories
-- **HTTP API**: Standalone or embedded search service
-
-##### Usage Example
-
-```python
-# Only available with search extras installed
-from signalwire_agents.search import IndexBuilder, SearchEngine
-
-# Build search index
-builder = IndexBuilder()
-builder.build_index(
-    source_dir="./docs",
-    output_file="knowledge.swsearch",
-    file_types=['md', 'txt', 'pdf']
-)
-
-# Search documents
-engine = SearchEngine("knowledge.swsearch")
-results = engine.search(
-    query_vector=embeddings,
-    enhanced_text="search query",
-    count=5
-)
-```
-
 ### Quick Start
 
 ```python