@signalwire/sdk 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (325) hide show
  1. package/.github/workflows/publish.yml +27 -0
  2. package/.github/workflows/test.yml +17 -0
  3. package/CLAUDE.md +112 -0
  4. package/README.md +254 -0
  5. package/docs/MIGRATION-2.0.md +81 -0
  6. package/docs/agent-guide.md +869 -0
  7. package/docs/agent_guide.md +1026 -0
  8. package/docs/api-reference.md +2420 -0
  9. package/docs/api_reference.md +1301 -0
  10. package/docs/architecture.md +843 -0
  11. package/docs/cli-guide.md +579 -0
  12. package/docs/cli_guide.md +448 -0
  13. package/docs/cloud_functions_guide.md +474 -0
  14. package/docs/configuration.md +422 -0
  15. package/docs/contexts-guide.md +787 -0
  16. package/docs/contexts_guide.md +511 -0
  17. package/docs/datamap-guide.md +1141 -0
  18. package/docs/datamap_guide.md +595 -0
  19. package/docs/llm_parameters.md +239 -0
  20. package/docs/mcp_gateway_reference.md +648 -0
  21. package/docs/mcp_integration.md +108 -0
  22. package/docs/prefabs-guide.md +800 -0
  23. package/docs/sdk_features.md +477 -0
  24. package/docs/security.md +436 -0
  25. package/docs/serverless-guide.md +513 -0
  26. package/docs/skills-guide.md +857 -0
  27. package/docs/skills-system.md +301 -0
  28. package/docs/skills_parameter_schema.md +392 -0
  29. package/docs/skills_system.md +467 -0
  30. package/docs/swaig-reference.md +1627 -0
  31. package/docs/swaig_reference.md +910 -0
  32. package/docs/swml_service_guide.md +600 -0
  33. package/docs/third_party_skills.md +533 -0
  34. package/docs/web_service.md +677 -0
  35. package/examples/README.md +131 -0
  36. package/examples/advanced-datamap.ts +100 -0
  37. package/examples/advanced-dynamic-config.ts +70 -0
  38. package/examples/auto-vivified.ts +94 -0
  39. package/examples/call-flow.ts +63 -0
  40. package/examples/comprehensive-dynamic.ts +125 -0
  41. package/examples/contexts-steps.ts +65 -0
  42. package/examples/custom-path.ts +45 -0
  43. package/examples/datamap-tools.ts +55 -0
  44. package/examples/datasphere-multi-instance.ts +63 -0
  45. package/examples/datasphere-serverless-env.ts +68 -0
  46. package/examples/datasphere-webhook-env.ts +66 -0
  47. package/examples/datasphere.ts +37 -0
  48. package/examples/declarative.ts +100 -0
  49. package/examples/dynamic-config.ts +54 -0
  50. package/examples/dynamic-info-gatherer.ts +69 -0
  51. package/examples/dynamic-swml-service.ts +67 -0
  52. package/examples/gather-info.ts +71 -0
  53. package/examples/gather-per-question-functions-demo.ts +140 -0
  54. package/examples/joke-agent.ts +34 -0
  55. package/examples/kubernetes-agent.ts +45 -0
  56. package/examples/llm-params.ts +69 -0
  57. package/examples/mcp-agent.ts +84 -0
  58. package/examples/mcp-gateway.ts +35 -0
  59. package/examples/multi-agent.ts +73 -0
  60. package/examples/multi-endpoint.ts +79 -0
  61. package/examples/pom-prompt.ts +71 -0
  62. package/examples/prefab-concierge.ts +47 -0
  63. package/examples/prefab-faq.ts +54 -0
  64. package/examples/prefab-info-gatherer.ts +33 -0
  65. package/examples/prefab-receptionist.ts +36 -0
  66. package/examples/prefab-survey.ts +68 -0
  67. package/examples/record-call.ts +67 -0
  68. package/examples/relay-demo.ts +33 -0
  69. package/examples/room-and-sip.ts +94 -0
  70. package/examples/serverless-lambda.ts +35 -0
  71. package/examples/session-state.ts +83 -0
  72. package/examples/simple-agent.ts +36 -0
  73. package/examples/simple-static.ts +29 -0
  74. package/examples/skills-demo.ts +38 -0
  75. package/examples/step-function-inheritance-demo.ts +124 -0
  76. package/examples/swaig-features.ts +187 -0
  77. package/examples/swml-service-routing.ts +66 -0
  78. package/examples/swml-service.ts +38 -0
  79. package/examples/tap.ts +68 -0
  80. package/examples/verb-methods.ts +45 -0
  81. package/examples/web-search-multi-instance.ts +72 -0
  82. package/examples/web-search.ts +38 -0
  83. package/examples/wikipedia.ts +36 -0
  84. package/livewire/README.md +140 -0
  85. package/livewire/docs/migration-guide.md +228 -0
  86. package/livewire/examples/livewire-basic-agent.ts +74 -0
  87. package/livewire/examples/livewire-handoff.ts +197 -0
  88. package/livewire/examples/livewire-multi-tool.ts +117 -0
  89. package/package.json +38 -0
  90. package/relay/README.md +70 -0
  91. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +1257 -0
  92. package/relay/docs/call-methods.md +474 -0
  93. package/relay/docs/client-reference.md +142 -0
  94. package/relay/docs/events.md +134 -0
  95. package/relay/docs/getting-started.md +134 -0
  96. package/relay/docs/guide.md +306 -0
  97. package/relay/docs/messaging.md +182 -0
  98. package/relay/examples/relay-inbound.ts +66 -0
  99. package/relay/examples/relay-messaging.ts +71 -0
  100. package/relay/examples/relay-outbound.ts +76 -0
  101. package/rest/README.md +95 -0
  102. package/rest/docs/calling.md +273 -0
  103. package/rest/docs/client-reference.md +107 -0
  104. package/rest/docs/compat.md +204 -0
  105. package/rest/docs/fabric.md +183 -0
  106. package/rest/docs/getting-started.md +110 -0
  107. package/rest/docs/guide.md +351 -0
  108. package/rest/docs/namespaces.md +285 -0
  109. package/rest/examples/rest-10dlc-registration.ts +161 -0
  110. package/rest/examples/rest-calling-ivr-and-ai.ts +102 -0
  111. package/rest/examples/rest-calling-play-and-record.ts +91 -0
  112. package/rest/examples/rest-client.ts +65 -0
  113. package/rest/examples/rest-compat-laml.ts +210 -0
  114. package/rest/examples/rest-datasphere-search.ts +82 -0
  115. package/rest/examples/rest-fabric-conferences-and-routing.ts +144 -0
  116. package/rest/examples/rest-fabric-subscribers-and-sip.ts +108 -0
  117. package/rest/examples/rest-fabric-swml-and-callflows.ts +99 -0
  118. package/rest/examples/rest-manage-resources.ts +65 -0
  119. package/rest/examples/rest-phone-number-management.ts +197 -0
  120. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  121. package/rest/examples/rest-video-rooms.ts +186 -0
  122. package/src/AgentBase.ts +2489 -0
  123. package/src/AgentServer.ts +415 -0
  124. package/src/AuthHandler.ts +256 -0
  125. package/src/ConfigLoader.ts +447 -0
  126. package/src/ContextBuilder.ts +1150 -0
  127. package/src/DataMap.ts +449 -0
  128. package/src/FunctionResult.ts +866 -0
  129. package/src/Logger.ts +337 -0
  130. package/src/PomBuilder.ts +439 -0
  131. package/src/PromptManager.ts +133 -0
  132. package/src/SWMLHandler.ts +298 -0
  133. package/src/SWMLService.ts +717 -0
  134. package/src/SchemaUtils.ts +361 -0
  135. package/src/SecurityUtils.ts +153 -0
  136. package/src/ServerlessAdapter.ts +221 -0
  137. package/src/SessionManager.ts +311 -0
  138. package/src/SslConfig.ts +118 -0
  139. package/src/SwaigFunction.ts +276 -0
  140. package/src/SwmlBuilder.ts +258 -0
  141. package/src/SwmlVerbMethods.generated.ts +234 -0
  142. package/src/TypeInference.ts +181 -0
  143. package/src/WebService.ts +619 -0
  144. package/src/cli/agent-loader.ts +166 -0
  145. package/src/cli/mock-data.ts +111 -0
  146. package/src/cli/swaig-test.ts +452 -0
  147. package/src/generateVerbTypes.ts +322 -0
  148. package/src/index.ts +167 -0
  149. package/src/livewire/index.ts +950 -0
  150. package/src/prefabs/ConciergeAgent.ts +287 -0
  151. package/src/prefabs/FAQBotAgent.ts +384 -0
  152. package/src/prefabs/InfoGathererAgent.ts +339 -0
  153. package/src/prefabs/ReceptionistAgent.ts +366 -0
  154. package/src/prefabs/SurveyAgent.ts +646 -0
  155. package/src/prefabs/index.ts +27 -0
  156. package/src/relay/Action.ts +314 -0
  157. package/src/relay/Call.ts +854 -0
  158. package/src/relay/Deferred.ts +71 -0
  159. package/src/relay/Message.ts +148 -0
  160. package/src/relay/RelayClient.ts +1036 -0
  161. package/src/relay/RelayError.ts +14 -0
  162. package/src/relay/RelayEvent.ts +892 -0
  163. package/src/relay/constants.ts +132 -0
  164. package/src/relay/index.ts +123 -0
  165. package/src/relay/types.ts +149 -0
  166. package/src/rest/HttpClient.ts +103 -0
  167. package/src/rest/RestError.ts +31 -0
  168. package/src/rest/base/BaseResource.ts +19 -0
  169. package/src/rest/base/CrudResource.ts +51 -0
  170. package/src/rest/base/CrudWithAddresses.ts +26 -0
  171. package/src/rest/index.ts +200 -0
  172. package/src/rest/namespaces/addresses.ts +32 -0
  173. package/src/rest/namespaces/calling.ts +187 -0
  174. package/src/rest/namespaces/chat.ts +20 -0
  175. package/src/rest/namespaces/compat.ts +352 -0
  176. package/src/rest/namespaces/datasphere.ts +45 -0
  177. package/src/rest/namespaces/fabric.ts +222 -0
  178. package/src/rest/namespaces/imported-numbers.ts +20 -0
  179. package/src/rest/namespaces/logs.ts +84 -0
  180. package/src/rest/namespaces/lookup.ts +21 -0
  181. package/src/rest/namespaces/mfa.ts +30 -0
  182. package/src/rest/namespaces/number-groups.ts +38 -0
  183. package/src/rest/namespaces/phone-numbers.ts +44 -0
  184. package/src/rest/namespaces/project.ts +36 -0
  185. package/src/rest/namespaces/pubsub.ts +20 -0
  186. package/src/rest/namespaces/queues.ts +33 -0
  187. package/src/rest/namespaces/recordings.ts +28 -0
  188. package/src/rest/namespaces/registry.ts +101 -0
  189. package/src/rest/namespaces/short-codes.ts +28 -0
  190. package/src/rest/namespaces/sip-profile.ts +25 -0
  191. package/src/rest/namespaces/verified-callers.ts +27 -0
  192. package/src/rest/namespaces/video.ts +165 -0
  193. package/src/rest/pagination.ts +84 -0
  194. package/src/rest/types.ts +61 -0
  195. package/src/schema.json +12250 -0
  196. package/src/skills/SkillBase.ts +547 -0
  197. package/src/skills/SkillManager.ts +415 -0
  198. package/src/skills/SkillRegistry.ts +367 -0
  199. package/src/skills/builtin/api_ninjas_trivia.ts +280 -0
  200. package/src/skills/builtin/ask_claude.ts +241 -0
  201. package/src/skills/builtin/claude_skills.ts +978 -0
  202. package/src/skills/builtin/custom_skills.ts +312 -0
  203. package/src/skills/builtin/datasphere.ts +438 -0
  204. package/src/skills/builtin/datasphere_serverless.ts +339 -0
  205. package/src/skills/builtin/datetime.ts +130 -0
  206. package/src/skills/builtin/google_maps.ts +651 -0
  207. package/src/skills/builtin/index.ts +88 -0
  208. package/src/skills/builtin/info_gatherer.ts +405 -0
  209. package/src/skills/builtin/joke.ts +191 -0
  210. package/src/skills/builtin/math.ts +142 -0
  211. package/src/skills/builtin/mcp_gateway.ts +677 -0
  212. package/src/skills/builtin/native_vector_search.ts +901 -0
  213. package/src/skills/builtin/play_background_file.ts +358 -0
  214. package/src/skills/builtin/spider.ts +869 -0
  215. package/src/skills/builtin/swml_transfer.ts +635 -0
  216. package/src/skills/builtin/weather_api.ts +248 -0
  217. package/src/skills/builtin/web_search.ts +1074 -0
  218. package/src/skills/builtin/wikipedia_search.ts +299 -0
  219. package/src/skills/index.ts +12 -0
  220. package/src/types.ts +132 -0
  221. package/tests/AgentBase.test.ts +1093 -0
  222. package/tests/AgentServer.test.ts +126 -0
  223. package/tests/AuthHandler.test.ts +133 -0
  224. package/tests/ConfigLoader.test.ts +151 -0
  225. package/tests/ContextBuilder.test.ts +108 -0
  226. package/tests/DataMap.test.ts +367 -0
  227. package/tests/EphemeralSkillCopy.test.ts +107 -0
  228. package/tests/FunctionResult.test.ts +298 -0
  229. package/tests/GracefulShutdown.test.ts +46 -0
  230. package/tests/Logger.test.ts +420 -0
  231. package/tests/PomBuilder.test.ts +228 -0
  232. package/tests/ProxyDetection.test.ts +228 -0
  233. package/tests/SWMLService.test.ts +320 -0
  234. package/tests/SWMLVerbHandler.test.ts +523 -0
  235. package/tests/SchemaUtils.test.ts +106 -0
  236. package/tests/SchemaUtils.verb.test.ts +206 -0
  237. package/tests/SecurityUtils.test.ts +192 -0
  238. package/tests/ServerlessAdapter.test.ts +222 -0
  239. package/tests/SessionManager.test.ts +257 -0
  240. package/tests/SkillBaseFeatures.test.ts +130 -0
  241. package/tests/SkillMultiInstance.test.ts +102 -0
  242. package/tests/SkillParameterSchemas.test.ts +134 -0
  243. package/tests/SkillRegistrySchema.test.ts +84 -0
  244. package/tests/SslConfig.test.ts +97 -0
  245. package/tests/SwmlBuilder.test.ts +400 -0
  246. package/tests/TypeInference.test.ts +165 -0
  247. package/tests/VerbHandlerRegistry.test.ts +128 -0
  248. package/tests/cli/mock-data.test.ts +113 -0
  249. package/tests/cli/swaig-test.test.ts +108 -0
  250. package/tests/examples.test.ts +194 -0
  251. package/tests/fixtures/scrape-parity/README.md +53 -0
  252. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +5 -0
  253. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +5 -0
  254. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +5 -0
  255. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +5 -0
  256. package/tests/fixtures/scrape-parity/expected/05_malformed.json +5 -0
  257. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +5 -0
  258. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +5 -0
  259. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +5 -0
  260. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +5 -0
  261. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +5 -0
  262. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +5 -0
  263. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +5 -0
  264. package/tests/fixtures/scrape-parity/html/01_simple_article.html +18 -0
  265. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +18 -0
  266. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +13 -0
  267. package/tests/fixtures/scrape-parity/html/04_bare_body.html +9 -0
  268. package/tests/fixtures/scrape-parity/html/05_malformed.html +11 -0
  269. package/tests/fixtures/scrape-parity/html/06_multi_class.html +18 -0
  270. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +12 -0
  271. package/tests/fixtures/scrape-parity/html/08_inline_script.html +17 -0
  272. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +21 -0
  273. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +10 -0
  274. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +13 -0
  275. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +24 -0
  276. package/tests/fixtures/scrape-parity/python_extract.py +109 -0
  277. package/tests/livewire/livewire.test.ts +780 -0
  278. package/tests/mcp.test.ts +221 -0
  279. package/tests/prefabs/prefabs.test.ts +1093 -0
  280. package/tests/relay/Action.test.ts +392 -0
  281. package/tests/relay/Call.test.ts +535 -0
  282. package/tests/relay/Deferred.test.ts +71 -0
  283. package/tests/relay/Message.test.ts +164 -0
  284. package/tests/relay/RelayClient.test.ts +779 -0
  285. package/tests/relay/RelayEvent.test.ts +463 -0
  286. package/tests/relay/helpers.ts +79 -0
  287. package/tests/rest/HttpClient.test.ts +274 -0
  288. package/tests/rest/RestError.test.ts +53 -0
  289. package/tests/rest/calling.test.ts +156 -0
  290. package/tests/rest/client.test.ts +197 -0
  291. package/tests/rest/compat.test.ts +335 -0
  292. package/tests/rest/datasphere.test.ts +71 -0
  293. package/tests/rest/fabric.test.ts +186 -0
  294. package/tests/rest/helpers.ts +95 -0
  295. package/tests/rest/logs.test.ts +68 -0
  296. package/tests/rest/pagination.test.ts +133 -0
  297. package/tests/rest/registry.test.ts +94 -0
  298. package/tests/rest/relay-rest.test.ts +290 -0
  299. package/tests/rest/video.test.ts +173 -0
  300. package/tests/setup.ts +6 -0
  301. package/tests/skills/SkillBase.test.ts +108 -0
  302. package/tests/skills/SkillManager.test.ts +268 -0
  303. package/tests/skills/SkillRegistry.test.ts +176 -0
  304. package/tests/skills/builtin.test.ts +1472 -0
  305. package/tests/skills/claude-skills.test.ts +54 -0
  306. package/tests/skills/custom-skills.test.ts +53 -0
  307. package/tests/skills/datasphere-serverless.test.ts +70 -0
  308. package/tests/skills/datasphere.test.ts +107 -0
  309. package/tests/skills/datetime.test.ts +101 -0
  310. package/tests/skills/google-maps.test.ts +78 -0
  311. package/tests/skills/info-gatherer.test.ts +411 -0
  312. package/tests/skills/joke.test.ts +81 -0
  313. package/tests/skills/math.test.ts +68 -0
  314. package/tests/skills/mcp-gateway.test.ts +101 -0
  315. package/tests/skills/play-background.test.ts +54 -0
  316. package/tests/skills/spider.test.ts +108 -0
  317. package/tests/skills/swml-transfer.test.ts +178 -0
  318. package/tests/skills/trivia.test.ts +54 -0
  319. package/tests/skills/vector-search.test.ts +135 -0
  320. package/tests/skills/weather-api.test.ts +77 -0
  321. package/tests/skills/web-search-parity.test.ts +59 -0
  322. package/tests/skills/web-search.test.ts +103 -0
  323. package/tests/skills/wikipedia.test.ts +63 -0
  324. package/tsconfig.json +18 -0
  325. package/vitest.config.ts +9 -0
@@ -0,0 +1,600 @@
1
+ # SignalWire SWML Service Guide
2
+
3
+ ## Table of Contents
4
+ - [Introduction](#introduction)
5
+ - [Installation](#installation)
6
+ - [Basic Usage](#basic-usage)
7
+ - [Centralized Logging System](#centralized-logging-system)
8
+ - [SWML Document Creation](#swml-document-creation)
9
+ - [Verb Handling](#verb-handling)
10
+ - [Web Service Features](#web-service-features)
11
+ - [Custom Routing Callbacks](#custom-routing-callbacks)
12
+ - [Advanced Usage](#advanced-usage)
13
+ - [API Reference](#api-reference)
14
+ - [Examples](#examples)
15
+
16
+ ## Introduction
17
+
18
+ The `SWMLService` class provides a foundation for creating and serving SignalWire Markup Language (SWML) documents. It serves as the base class for all SignalWire services, including AI Agents, and handles common tasks such as:
19
+
20
+ - SWML document creation and manipulation
21
+ - Schema validation
22
+ - Web service functionality
23
+ - Authentication
24
+ - Centralized logging
25
+
26
+ The class is designed to be extended for specific use cases, while providing a full set of capabilities out of the box.
27
+
28
+ ## Installation
29
+
30
+ The `SWMLService` class is part of the SignalWire AI Agent SDK. Install it using pip:
31
+
32
+ ```bash
33
+ pip install @signalwire/sdk
34
+ ```
35
+
36
+ ## Basic Usage
37
+
38
+ Here's a simple example of creating an SWML service:
39
+
40
+ ```python
41
+ from signalwire_agents.core.swml_service import SWMLService
42
+
43
+ class SimpleVoiceService(SWMLService):
44
+ def __init__(self, host="0.0.0.0", port=3000):
45
+ super().__init__(
46
+ name="voice-service",
47
+ route="/voice",
48
+ host=host,
49
+ port=port
50
+ )
51
+
52
+ # Build the SWML document
53
+ self.build_document()
54
+
55
+ def build_document(self):
56
+ # Reset the document to start fresh
57
+ self.reset_document()
58
+
59
+ # Add answer verb
60
+ self.add_verb("answer", {})
61
+
62
+ # Add play verb for greeting
63
+ self.add_verb("play", {
64
+ "url": "say:Hello, thank you for calling our service."
65
+ })
66
+
67
+ # Add hangup verb
68
+ self.add_verb("hangup", {})
69
+
70
+ # Create and start the service
71
+ service = SimpleVoiceService()
72
+ service.run()
73
+ ```
74
+
75
+ ## Centralized Logging System
76
+
77
+ The `SWMLService` class includes a centralized logging system based on `structlog` that provides structured, JSON-formatted logs. This logging system is automatically set up when you import the module, so you don't need to configure it in each service or example.
78
+
79
+ ### How It Works
80
+
81
+ 1. When `swml_service.py` is imported, it configures `structlog` (if not already configured)
82
+ 2. Each `SWMLService` instance gets a logger bound to its service name
83
+ 3. All logs include contextual information like service name, timestamp, and log level
84
+ 4. Logs are formatted as JSON for easy parsing and analysis
85
+
86
+ ### Using the Logger
87
+
88
+ Every `SWMLService` instance has a `log` attribute that can be used for logging:
89
+
90
+ ```python
91
+ # Basic logging
92
+ self.log.info("service_started")
93
+
94
+ # Logging with context
95
+ self.log.debug("document_created", size=len(document))
96
+
97
+ # Error logging
98
+ try:
99
+ # Some operation
100
+ pass
101
+ except Exception as e:
102
+ self.log.error("operation_failed", error=str(e))
103
+ ```
104
+
105
+ ### Log Levels
106
+
107
+ The following log levels are available (in increasing order of severity):
108
+ - `debug`: Detailed information for debugging
109
+ - `info`: General information about operation
110
+ - `warning`: Warning about potential issues
111
+ - `error`: Error information when operations fail
112
+ - `critical`: Critical error that might cause the application to terminate
113
+
114
+ ### Suppressing Logs
115
+
116
+ To suppress logs when running a service, you can set the log level:
117
+
118
+ ```python
119
+ import logging
120
+ logging.getLogger().setLevel(logging.WARNING) # Only show warnings and above
121
+ ```
122
+
123
+ You can also pass `suppress_logs=True` when initializing an agent or service:
124
+
125
+ ```python
126
+ service = SWMLService(
127
+ name="my-service",
128
+ suppress_logs=True
129
+ )
130
+ ```
131
+
132
+ ## SWML Document Creation
133
+
134
+ The `SWMLService` class provides methods for creating and manipulating SWML documents.
135
+
136
+ ### Document Structure
137
+
138
+ SWML documents have the following basic structure:
139
+
140
+ ```json
141
+ {
142
+ "version": "1.0.0",
143
+ "sections": {
144
+ "main": [
145
+ { "verb1": { /* configuration */ } },
146
+ { "verb2": { /* configuration */ } }
147
+ ],
148
+ "section1": [
149
+ { "verb3": { /* configuration */ } }
150
+ ]
151
+ }
152
+ }
153
+ ```
154
+
155
+ ### Document Methods
156
+
157
+ - `reset_document()`: Reset the document to an empty state
158
+ - `add_verb(verb_name, config)`: Add a verb to the main section
159
+ - `add_section(section_name)`: Add a new section
160
+ - `add_verb_to_section(section_name, verb_name, config)`: Add a verb to a specific section
161
+ - `get_document()`: Get the current document as a dictionary
162
+ - `render_document()`: Get the current document as a JSON string
163
+
164
+ ### Common Verb Shortcuts
165
+
166
+ - `add_verb(verb_name, config)`: Add any SWML verb with configuration
167
+
168
+ ## Verb Handling
169
+
170
+ The `SWMLService` class provides validation for SWML verbs using the SignalWire schema.
171
+
172
+ ### Verb Validation
173
+
174
+ When adding a verb, the service validates it against the schema to ensure it has the correct structure and parameters.
175
+
176
+ ```python
177
+ # This will validate the configuration against the schema
178
+ self.add_verb("play", {
179
+ "url": "say:Hello, world!",
180
+ "volume": 5
181
+ })
182
+
183
+ # This would fail validation (invalid parameter)
184
+ self.add_verb("play", {
185
+ "invalid_param": "value"
186
+ })
187
+ ```
188
+
189
+ ### Custom Verb Handlers
190
+
191
+ You can register custom verb handlers for specialized verb processing:
192
+
193
+ ```python
194
+ from signalwire_agents.core.swml_handler import SWMLVerbHandler
195
+
196
+ class CustomPlayHandler(SWMLVerbHandler):
197
+ def __init__(self):
198
+ super().__init__("play")
199
+
200
+ def validate_config(self, config):
201
+ # Custom validation logic
202
+ return True, []
203
+
204
+ def build_config(self, **kwargs):
205
+ # Custom configuration building
206
+ return kwargs
207
+
208
+ service.register_verb_handler(CustomPlayHandler())
209
+ ```
210
+
211
+ ## Web Service Features
212
+
213
+ The `SWMLService` class includes built-in web service capabilities for serving SWML documents.
214
+
215
+ ### Endpoints
216
+
217
+ By default, a service provides the following endpoints:
218
+
219
+ - `GET /route`: Return the SWML document
220
+ - `POST /route`: Process request data and return the SWML document
221
+ - `GET /route/`: Same as above but with trailing slash
222
+ - `POST /route/`: Same as above but with trailing slash
223
+
224
+ Where `route` is the route path specified when creating the service.
225
+
226
+ ### Authentication
227
+
228
+ Basic authentication is automatically set up for all endpoints. Credentials are generated if not provided, or can be specified:
229
+
230
+ ```python
231
+ service = SWMLService(
232
+ name="my-service",
233
+ basic_auth=("username", "password")
234
+ )
235
+ ```
236
+
237
+ You can also set credentials using environment variables:
238
+ - `SWML_BASIC_AUTH_USER`
239
+ - `SWML_BASIC_AUTH_PASSWORD`
240
+
241
+ ### Dynamic SWML Generation
242
+
243
+ You can override the `on_swml_request` method to customize SWML documents based on request data:
244
+
245
+ ```python
246
+ def on_swml_request(self, request_data=None):
247
+ if not request_data:
248
+ return None
249
+
250
+ # Customize document based on request_data
251
+ self.reset_document()
252
+ self.add_answer_verb()
253
+
254
+ # Add custom verbs based on request_data
255
+ if request_data.get("caller_type") == "vip":
256
+ self.add_verb("play", {
257
+ "url": "say:Welcome VIP caller!"
258
+ })
259
+ else:
260
+ self.add_verb("play", {
261
+ "url": "say:Welcome caller!"
262
+ })
263
+
264
+ # Return modifications to the document
265
+ # or None to use the document we've built without modifications
266
+ return None
267
+ ```
268
+
269
+ ## Custom Routing Callbacks
270
+
271
+ The `SWMLService` class allows you to register custom routing callbacks that can examine incoming requests and determine where they should be routed.
272
+
273
+ ### Registering a Routing Callback
274
+
275
+ You can use the `register_routing_callback` method to register a function that will be called to process requests to a specific path:
276
+
277
+ ```python
278
+ def my_routing_callback(request, body):
279
+ """
280
+ Process incoming requests and determine routing
281
+
282
+ Args:
283
+ request: FastAPI Request object
284
+ body: Parsed JSON body as a dictionary
285
+
286
+ Returns:
287
+ Optional[str]: If a string is returned, the request will be redirected to that URL.
288
+ If None is returned, the request will be processed normally.
289
+ """
290
+ # Example: Route based on a field in the request body
291
+ if "customer_id" in body:
292
+ customer_id = body["customer_id"]
293
+ return f"/customer/{customer_id}"
294
+
295
+ # Process request normally
296
+ return None
297
+
298
+ # Register the callback for a specific path
299
+ service.register_routing_callback(my_routing_callback, path="/customer")
300
+ ```
301
+
302
+ ### How Routing Works
303
+
304
+ 1. When a request is received at the registered path, the routing callback is executed
305
+ 2. The callback inspects the request and can decide whether to redirect it
306
+ 3. If the callback returns a URL string, the request is redirected with HTTP 307 (temporary redirect)
307
+ 4. If the callback returns `None`, the request is processed normally by the `on_request` method
308
+
309
+ ### Serving Different Content for Different Paths
310
+
311
+ You can use the `callback_path` parameter passed to `on_request` to serve different content for different paths:
312
+
313
+ ```python
314
+ def on_request(self, request_data=None, callback_path=None):
315
+ """
316
+ Called when SWML is requested
317
+
318
+ Args:
319
+ request_data: Optional dictionary containing the parsed POST body
320
+ callback_path: Optional callback path from the request
321
+
322
+ Returns:
323
+ Optional dict to modify/augment the SWML document
324
+ """
325
+ # Serve different content based on the callback path
326
+ if callback_path == "/customer":
327
+ return {
328
+ "sections": {
329
+ "main": [
330
+ {"answer": {}},
331
+ {"play": {"url": "say:Welcome to customer service!"}}
332
+ ]
333
+ }
334
+ }
335
+ elif callback_path == "/product":
336
+ return {
337
+ "sections": {
338
+ "main": [
339
+ {"answer": {}},
340
+ {"play": {"url": "say:Welcome to product support!"}}
341
+ ]
342
+ }
343
+ }
344
+
345
+ # Default content
346
+ return None
347
+ ```
348
+
349
+ ### Example: Multi-Section Service
350
+
351
+ Here's an example of a service that uses routing callbacks to handle different types of requests:
352
+
353
+ ```python
354
+ from signalwire_agents.core.swml_service import SWMLService
355
+ from fastapi import Request
356
+ from typing import Dict, Any, Optional
357
+
358
+ class MultiSectionService(SWMLService):
359
+ def __init__(self):
360
+ super().__init__(
361
+ name="multi-section",
362
+ route="/main"
363
+ )
364
+
365
+ # Create the main document
366
+ self.reset_document()
367
+ self.add_verb("answer", {})
368
+ self.add_verb("play", {"url": "say:Hello from the main service!"})
369
+ self.add_verb("hangup", {})
370
+
371
+ # Register customer and product routes
372
+ self.register_customer_route()
373
+ self.register_product_route()
374
+
375
+ def register_customer_route(self):
376
+ def customer_callback(request: Request, body: Dict[str, Any]) -> Optional[str]:
377
+ # Check if we need to route to a specific customer ID
378
+ if "customer_id" in body:
379
+ customer_id = body["customer_id"]
380
+ # In a real implementation, you might redirect to another service
381
+ # Here we just log it and process normally
382
+ print(f"Processing request for customer ID: {customer_id}")
383
+ return None
384
+
385
+ # Register the callback at the /customer path
386
+ self.register_routing_callback(customer_callback, path="/customer")
387
+
388
+ # Create the customer SWML section
389
+ self.add_section("customer_section")
390
+ self.add_verb_to_section("customer_section", "answer", {})
391
+ self.add_verb_to_section("customer_section", "play",
392
+ {"url": "say:Welcome to customer service!"})
393
+ self.add_verb_to_section("customer_section", "hangup", {})
394
+
395
+ def register_product_route(self):
396
+ def product_callback(request: Request, body: Dict[str, Any]) -> Optional[str]:
397
+ # Check if we need to route to a specific product ID
398
+ if "product_id" in body:
399
+ product_id = body["product_id"]
400
+ print(f"Processing request for product ID: {product_id}")
401
+ return None
402
+
403
+ # Register the callback at the /product path
404
+ self.register_routing_callback(product_callback, path="/product")
405
+
406
+ # Create the product SWML section
407
+ self.add_section("product_section")
408
+ self.add_verb_to_section("product_section", "answer", {})
409
+ self.add_verb_to_section("product_section", "play",
410
+ {"url": "say:Welcome to product support!"})
411
+ self.add_verb_to_section("product_section", "hangup", {})
412
+
413
+ def on_request(self, request_data=None, callback_path=None):
414
+ # Serve different content based on the callback path
415
+ if callback_path == "/customer":
416
+ return {
417
+ "sections": {
418
+ "main": self.get_document()["sections"]["customer_section"]
419
+ }
420
+ }
421
+ elif callback_path == "/product":
422
+ return {
423
+ "sections": {
424
+ "main": self.get_document()["sections"]["product_section"]
425
+ }
426
+ }
427
+ return None
428
+ ```
429
+
430
+ In this example:
431
+ 1. The service registers two custom route paths: `/customer` and `/product`
432
+ 2. Each path has its own callback function to handle routing decisions
433
+ 3. The `on_request` method uses the `callback_path` to determine which content to serve
434
+ 4. Different SWML sections are served for different paths
435
+
436
+ ## Advanced Usage
437
+
438
+ ### Creating a FastAPI Router
439
+
440
+ You can get a FastAPI router for the service to include in a larger application:
441
+
442
+ ```python
443
+ from fastapi import FastAPI
444
+
445
+ app = FastAPI()
446
+ service = SWMLService(name="my-service")
447
+ router = service.as_router()
448
+ app.include_router(router, prefix="/voice")
449
+ ```
450
+
451
+ ### Schema Path Customization
452
+
453
+ You can specify a custom path to the schema file:
454
+
455
+ ```python
456
+ service = SWMLService(
457
+ name="my-service",
458
+ schema_path="/path/to/schema.json"
459
+ )
460
+ ```
461
+
462
+ ## API Reference
463
+
464
+ ### Constructor Parameters
465
+
466
+ - `name`: Service name/identifier (required)
467
+ - `route`: HTTP route path (default: "/")
468
+ - `host`: Host to bind to (default: "0.0.0.0")
469
+ - `port`: Port to bind to (default: 3000)
470
+ - `basic_auth`: Optional tuple of (username, password)
471
+ - `schema_path`: Optional path to schema.json
472
+ - `suppress_logs`: Whether to suppress structured logs (default: False)
473
+
474
+ ### Document Methods
475
+
476
+ - `reset_document()`
477
+ - `add_verb(verb_name, config)`
478
+ - `add_section(section_name)`
479
+ - `add_verb_to_section(section_name, verb_name, config)`
480
+ - `get_document()`
481
+ - `render_document()`
482
+
483
+ ### Service Methods
484
+
485
+ - `as_router()`: Get a FastAPI router for the service
486
+ - `run()`: Start the service
487
+ - `stop()`: Stop the service
488
+ - `get_basic_auth_credentials(include_source=False)`: Get the basic auth credentials
489
+ - `on_swml_request(request_data=None)`: Called when SWML is requested
490
+ - `register_routing_callback(callback_fn, path="/sip")`: Register a callback for request routing
491
+
492
+ ### Verb Helper Methods
493
+
494
+ - `add_verb(verb_name, config)`: Add any SWML verb with configuration
495
+
496
+ ## Examples
497
+
498
+ ### Basic Voicemail Service
499
+
500
+ ```python
501
+ from signalwire_agents.core.swml_service import SWMLService
502
+
503
+ class VoicemailService(SWMLService):
504
+ def __init__(self, host="0.0.0.0", port=3000):
505
+ super().__init__(
506
+ name="voicemail",
507
+ route="/voicemail",
508
+ host=host,
509
+ port=port
510
+ )
511
+
512
+ # Build the SWML document
513
+ self.build_voicemail_document()
514
+
515
+ def build_voicemail_document(self):
516
+ """Build the voicemail SWML document"""
517
+ # Reset the document
518
+ self.reset_document()
519
+
520
+ # Add answer verb
521
+ self.add_verb("answer", {})
522
+
523
+ # Add play verb for greeting
524
+ self.add_verb("play", {
525
+ "url": "say:Hello, you've reached the voicemail service. Please leave a message after the beep."
526
+ })
527
+
528
+ # Play a beep
529
+ self.add_verb("play", {
530
+ "url": "https://example.com/beep.wav"
531
+ })
532
+
533
+ # Record the message
534
+ self.add_verb("record", {
535
+ "format": "mp3",
536
+ "stereo": False,
537
+ "max_length": 120, # 2 minutes max
538
+ "terminators": "#"
539
+ })
540
+
541
+ # Thank the caller
542
+ self.add_verb("play", {
543
+ "url": "say:Thank you for your message. Goodbye!"
544
+ })
545
+
546
+ # Hang up
547
+ self.add_verb("hangup", {})
548
+
549
+ self.log.debug("voicemail_document_built")
550
+ ```
551
+
552
+ ### Dynamic Call Routing Service
553
+
554
+ ```python
555
+ class CallRouterService(SWMLService):
556
+ def on_swml_request(self, request_data=None):
557
+ # If there's no request data, use default routing
558
+ if not request_data:
559
+ self.log.debug("no_request_data_using_default")
560
+ return None
561
+
562
+ # Create a new document
563
+ self.reset_document()
564
+ self.add_verb("answer", {})
565
+
566
+ # Get routing parameters
567
+ department = request_data.get("department", "").lower()
568
+
569
+ # Add play verb for greeting
570
+ self.add_verb("play", {
571
+ "url": f"say:Thank you for calling our {department} department. Please hold."
572
+ })
573
+
574
+ # Route based on department
575
+ phone_numbers = {
576
+ "sales": "+15551112222",
577
+ "support": "+15553334444",
578
+ "billing": "+15555556666"
579
+ }
580
+
581
+ # Get the appropriate number or use default
582
+ to_number = phone_numbers.get(department, "+15559990000")
583
+
584
+ # Connect to the department
585
+ self.add_verb("connect", {
586
+ "to": to_number,
587
+ "timeout": 30,
588
+ "answer_on_bridge": True
589
+ })
590
+
591
+ # Add fallback message and hangup
592
+ self.add_verb("play", {
593
+ "url": "say:We're sorry, but all of our agents are currently busy. Please try again later."
594
+ })
595
+ self.add_verb("hangup", {})
596
+
597
+ return None # Use the document we've built
598
+ ```
599
+
600
+ For more examples, see the `examples` directory in the SignalWire AI Agent SDK repository.