AgentBase

1
from signalwire_agents import AgentBase, SwaigFunctionResult
2
3
class CustomerSupportAgent(AgentBase):
4
    """Production customer support agent."""
5
6
    def __init__(self):
7
        super().__init__(
8
            name="customer-support",
9
            route="/support"
10
        )
11
12
        # Voice configuration
13
        self.add_language("English", "en-US", "rime.spore")
14
15
        # AI behavior
16
        self.set_params({
17
            "end_of_speech_timeout": 500,
18
            "attention_timeout": 15000,
19
            "inactivity_timeout": 30000
20
        })
21
22
        # Prompts
23
        self.prompt_add_section(
24
            "Role",
25
            "You are Alex, a friendly customer support agent for Acme Inc."
26
        )
27
28
        self.prompt_add_section(
29
            "Guidelines",
30
            body="Follow these guidelines:",
31
            bullets=[
32
                "Be helpful and professional",
33
                "Ask clarifying questions when needed",
34
                "Keep responses concise for voice",
35
                "Offer to transfer if you cannot help"
36
            ]
37
        )
38
39
        # Speech recognition hints
40
        self.add_hints([
41
            "Acme", "account number", "order status",
42
            "refund", "billing", "representative"
43
        ])
44
45
        # Functions
46
        self.define_tool(
47
            name="check_order",
48
            description="Look up an order by order number",
49
            parameters={
50
                "type": "object",
51
                "properties": {
52
                    "order_number": {
53
                        "type": "string",
54
                        "description": "The order number to look up"
55
                    }
56
                },
57
                "required": ["order_number"]
58
            },
59
            handler=self.check_order
60
        )
61
62
        # Skills
63
        self.add_skill("datetime")
64
65
        # Post-call summary
66
        self.set_post_prompt(
67
            "Summarize: issue type, resolution, customer satisfaction"
68
        )
69
70
    def check_order(self, args, raw_data):
71
        order_number = args.get("order_number")
72
        # Your business logic here
73
        return SwaigFunctionResult(
74
            f"Order {order_number}: Shipped on Monday, arriving Thursday"
75
        )
76
77
if __name__ == "__main__":
78
    agent = CustomerSupportAgent()
79
    agent.run(host="0.0.0.0", port=3000)

1
class MyAgent(AgentBase):
2
    def __init__(self):
3
        super().__init__(name="my-agent")
4
        self.configure()
5
6
    def configure(self):
7
        # All configuration here
8
        pass

1
from signalwire_agents import AgentBase
2
3
agent = AgentBase(name="simple-agent")
4
agent.add_language("English", "en-US", "rime.spore")
5
agent.prompt_add_section("Role", "You are a helpful assistant.")
6
agent.run()

1
from signalwire_agents import AgentServer
2
3
server = AgentServer()
4
server.register(SupportAgent(), "/support")
5
server.register(SalesAgent(), "/sales")
6
server.register(BillingAgent(), "/billing")
7
server.run(port=3000)

1
from signalwire_agents import AgentBase
2
3
agent = AgentBase(
4
    # Required
5
    name="my-agent",                    # Unique agent identifier
6
7
    # Server Configuration
8
    route="/",                          # HTTP route path (default: "/")
9
    host="0.0.0.0",                     # Bind address (default: "0.0.0.0")
10
    port=3000,                          # Server port (default: 3000)
11
12
    # Authentication
13
    basic_auth=("user", "pass"),        # Override env var credentials
14
15
    # Behavior
16
    auto_answer=True,                   # Answer calls automatically
17
    use_pom=True,                       # Use Prompt Object Model
18
19
    # Recording
20
    record_call=False,                  # Enable call recording
21
    record_format="mp4",                # Recording format
22
    record_stereo=True,                 # Stereo recording
23
24
    # Tokens and Security
25
    token_expiry_secs=3600,             # Function token expiration
26
27
    # Advanced
28
    default_webhook_url=None,           # Override webhook URL
29
    agent_id=None,                      # Custom agent ID (auto-generated)
30
    native_functions=None,              # Built-in SignalWire functions
31
    schema_path=None,                   # Custom SWML schema path
32
    suppress_logs=False,                # Disable logging
33
    config_file=None                    # Load from config file
34
)

1
from signalwire_agents import AgentBase, SwaigFunctionResult
2
3
4
class MyAgent(AgentBase):
5
    def __init__(self):
6
        super().__init__(name="my-agent")
7
        self._setup()
8
9
    def _setup(self):
10
        # Voice
11
        self.add_language("English", "en-US", "rime.spore")
12
13
        # Prompts
14
        self.prompt_add_section("Role", "You are a helpful assistant.")
15
16
        # Functions
17
        self.define_tool(
18
            name="greet",
19
            description="Greet the user",
20
            parameters={},
21
            handler=self.greet
22
        )
23
24
    def greet(self, args, raw_data):
25
        return SwaigFunctionResult("Hello! How can I help you today?")
26
27
28
if __name__ == "__main__":
29
    agent = MyAgent()
30
    agent.run()

1
from signalwire_agents import AgentBase
2
3
agent = AgentBase(name="quick-agent")
4
agent.add_language("English", "en-US", "rime.spore")
5
agent.prompt_add_section("Role", "You are a helpful assistant.")
6
agent.run()

1
from signalwire_agents import AgentBase
2
3
4
class DeclarativeAgent(AgentBase):
5
    PROMPT_SECTIONS = {
6
        "Role": "You are a helpful customer service agent.",
7
        "Guidelines": [
8
            "Be professional and courteous",
9
            "Ask clarifying questions when needed",
10
            "Keep responses concise"
11
        ],
12
        "Rules": {
13
            "body": "Always follow these rules:",
14
            "bullets": [
15
                "Never share customer data",
16
                "Escalate complex issues"
17
            ]
18
        }
19
    }
20
21
    def __init__(self):
22
        super().__init__(name="declarative-agent")
23
        self.add_language("English", "en-US", "rime.spore")

1
# Voice and Language
2
agent.add_language(name, code, voice)       # Add language support
3
agent.set_languages(languages)               # Set all languages at once
4
5
# Prompts
6
agent.prompt_add_section(title, body)        # Add prompt section
7
agent.prompt_add_subsection(parent, title)   # Add subsection
8
agent.set_post_prompt(text)                  # Set post-call summary prompt
9
10
# AI Parameters
11
agent.set_params(params_dict)                # Set AI behavior parameters
12
agent.set_param_value(key, value)            # Set single parameter
13
14
# Speech Recognition
15
agent.add_hints(hints_list)                  # Add speech hints
16
agent.add_hint(hint_string)                  # Add single hint
17
18
# Functions
19
agent.define_tool(name, description, ...)   # Define SWAIG function
20
agent.add_skill(skill_name)                 # Add a skill
21
22
# Pronunciation
23
agent.add_pronunciation(replace, with_text)  # Add pronunciation rule

1
# Start server
2
agent.run(host="0.0.0.0", port=3000)
3
4
# Get SWML document
5
swml = agent.get_swml()
6
7
# Access components
8
agent.pom              # Prompt Object Model
9
agent.data_map         # DataMap builder

1
agent = AgentBase(
2
    name="my-agent",
3
    config_file="config/agent.yaml"
4
)

1
from signalwire_agents import AgentServer
2
3
4
class SupportAgent(AgentBase):
5
    def __init__(self):
6
        super().__init__(name="support", route="/support")
7
        # ... configuration
8
9
10
class SalesAgent(AgentBase):
11
    def __init__(self):
12
        super().__init__(name="sales", route="/sales")
13
        # ... configuration
14
15
16
# Register multiple agents
17
server = AgentServer()
18
server.register(SupportAgent())
19
server.register(SalesAgent())
20
server.run(host="0.0.0.0", port=3000)

1
class WellOrganizedAgent(AgentBase):
2
    def __init__(self):
3
        super().__init__(name="organized-agent")
4
        self._configure_voice()
5
        self._configure_prompts()
6
        self._configure_functions()
7
        self._configure_skills()
8
9
    def _configure_voice(self):
10
        self.add_language("English", "en-US", "rime.spore")
11
        self.set_params({
12
            "end_of_speech_timeout": 500,
13
            "attention_timeout": 15000
14
        })
15
16
    def _configure_prompts(self):
17
        self.prompt_add_section("Role", "You are a helpful assistant.")
18
19
    def _configure_functions(self):
20
        self.define_tool(
21
            name="help",
22
            description="Get help",
23
            parameters={},
24
            handler=self.get_help
25
        )
26
27
    def _configure_skills(self):
28
        self.add_skill("datetime")
29
30
    def get_help(self, args, raw_data):
31
        return SwaigFunctionResult("I can help you with...")