AgentBase

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 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 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 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 import AgentBase, FunctionResult
2
3
class MyAgent(AgentBase):
4
    def __init__(self):
5
        super().__init__(name="my-agent")
6
        self._setup()
7
8
    def _setup(self):
9
        self.add_language("English", "en-US", "rime.spore")
10
        self.prompt_add_section("Role", "You are a helpful assistant.")
11
        self.define_tool(name="greet", description="Greet the user", parameters={}, handler=self.greet)
12
13
    def greet(self, args, raw_data):
14
        return FunctionResult("Hello! How can I help you today?")
15
16
if __name__ == "__main__":
17
    agent = MyAgent()
18
    agent.run()

1
from signalwire 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 import AgentBase
2
3
class DeclarativeAgent(AgentBase):
4
    PROMPT_SECTIONS = {
5
        "Role": "You are a helpful customer service agent.",
6
        "Guidelines": [
7
            "Be professional and courteous",
8
            "Ask clarifying questions when needed",
9
            "Keep responses concise"
10
        ],
11
        "Rules": {
12
            "body": "Always follow these rules:",
13
            "bullets": [
14
                "Never share customer data",
15
                "Escalate complex issues"
16
            ]
17
        }
18
    }
19
20
    def __init__(self):
21
        super().__init__(name="declarative-agent")
22
        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 import AgentServer
2
3
class SupportAgent(AgentBase):
4
    def __init__(self):
5
        super().__init__(name="support", route="/support")
6
7
class SalesAgent(AgentBase):
8
    def __init__(self):
9
        super().__init__(name="sales", route="/sales")
10
11
server = AgentServer()
12
server.register(SupportAgent())
13
server.register(SalesAgent())
14
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({"end_of_speech_timeout": 500, "attention_timeout": 15000})
12
13
    def _configure_prompts(self):
14
        self.prompt_add_section("Role", "You are a helpful assistant.")
15
16
    def _configure_functions(self):
17
        self.define_tool(name="help", description="Get help", parameters={}, handler=self.get_help)
18
19
    def _configure_skills(self):
20
        self.add_skill("datetime")
21
22
    def get_help(self, args, raw_data):
23
        return FunctionResult("I can help you with...")