@signalwire/sdk 2.0.4 → 3.5.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.
- package/CHANGELOG.md +785 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +550 -163
- package/dist/AgentBase.js +1640 -514
- package/dist/AgentBase.js.map +1 -1
- package/dist/AgentServer.d.ts +21 -0
- package/dist/AgentServer.js +154 -47
- package/dist/AgentServer.js.map +1 -1
- package/dist/AuthHandler.d.ts +14 -2
- package/dist/AuthHandler.js +7 -2
- package/dist/AuthHandler.js.map +1 -1
- package/dist/ConfigLoader.d.ts +5 -13
- package/dist/ConfigLoader.js +15 -29
- package/dist/ConfigLoader.js.map +1 -1
- package/dist/ContextBuilder.d.ts +202 -9
- package/dist/ContextBuilder.js +219 -36
- package/dist/ContextBuilder.js.map +1 -1
- package/dist/DataMap.d.ts +158 -45
- package/dist/DataMap.js +167 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +277 -83
- package/dist/FunctionResult.js +444 -116
- package/dist/FunctionResult.js.map +1 -1
- package/dist/Logger.d.ts +30 -5
- package/dist/Logger.js +77 -19
- package/dist/Logger.js.map +1 -1
- package/dist/POM/PromptObjectModel.d.ts +163 -0
- package/dist/POM/PromptObjectModel.js +481 -0
- package/dist/POM/PromptObjectModel.js.map +1 -0
- package/dist/ParameterSchema.d.ts +306 -0
- package/dist/ParameterSchema.js +251 -0
- package/dist/ParameterSchema.js.map +1 -0
- package/dist/PlatformContracts.d.ts +21 -0
- package/dist/PlatformContracts.generated.d.ts +109 -0
- package/dist/PlatformContracts.generated.js +8 -0
- package/dist/PlatformContracts.generated.js.map +1 -0
- package/dist/PlatformContracts.js +2 -0
- package/dist/PlatformContracts.js.map +1 -0
- package/dist/PomBuilder.d.ts +28 -0
- package/dist/PomBuilder.js +81 -3
- package/dist/PomBuilder.js.map +1 -1
- package/dist/PostPrompt.d.ts +110 -0
- package/dist/PostPrompt.js +204 -0
- package/dist/PostPrompt.js.map +1 -0
- package/dist/PromptManager.d.ts +29 -1
- package/dist/PromptManager.js +37 -1
- package/dist/PromptManager.js.map +1 -1
- package/dist/PublicFetch.d.ts +132 -0
- package/dist/PublicFetch.js +311 -0
- package/dist/PublicFetch.js.map +1 -0
- package/dist/RobotsTxt.d.ts +41 -0
- package/dist/RobotsTxt.js +152 -0
- package/dist/RobotsTxt.js.map +1 -0
- package/dist/SWMLHandler.js.map +1 -1
- package/dist/SWMLService.d.ts +265 -66
- package/dist/SWMLService.js +652 -112
- package/dist/SWMLService.js.map +1 -1
- package/dist/SchemaUtils.d.ts +115 -2
- package/dist/SchemaUtils.js +444 -12
- package/dist/SchemaUtils.js.map +1 -1
- package/dist/SecurityUtils.d.ts +55 -8
- package/dist/SecurityUtils.js +162 -49
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/ServerlessAdapter.d.ts +156 -7
- package/dist/ServerlessAdapter.js +399 -42
- package/dist/ServerlessAdapter.js.map +1 -1
- package/dist/SessionManager.d.ts +11 -2
- package/dist/SessionManager.js +50 -18
- package/dist/SessionManager.js.map +1 -1
- package/dist/SslConfig.d.ts +2 -1
- package/dist/SslConfig.js +4 -1
- package/dist/SslConfig.js.map +1 -1
- package/dist/SwaigActions.generated.d.ts +23 -0
- package/dist/SwaigActions.generated.js +8 -0
- package/dist/SwaigActions.generated.js.map +1 -0
- package/dist/SwaigContracts.d.ts +15 -0
- package/dist/SwaigContracts.generated.d.ts +264 -0
- package/dist/SwaigContracts.generated.js +12 -0
- package/dist/SwaigContracts.generated.js.map +1 -0
- package/dist/SwaigContracts.js +2 -0
- package/dist/SwaigContracts.js.map +1 -0
- package/dist/SwaigFunction.d.ts +110 -4
- package/dist/SwaigFunction.js +151 -19
- package/dist/SwaigFunction.js.map +1 -1
- package/dist/SwmlBuilder.d.ts +68 -19
- package/dist/SwmlBuilder.js +74 -38
- package/dist/SwmlBuilder.js.map +1 -1
- package/dist/SwmlVerbMethods.generated.d.ts +41 -4
- package/dist/SwmlVerbMethods.generated.js +1 -1
- package/dist/TypeInference.d.ts +39 -3
- package/dist/TypeInference.js +256 -16
- package/dist/TypeInference.js.map +1 -1
- package/dist/WebService.d.ts +79 -11
- package/dist/WebService.js +320 -109
- package/dist/WebService.js.map +1 -1
- package/dist/WebhookMiddleware.d.ts +119 -0
- package/dist/WebhookMiddleware.js +271 -0
- package/dist/WebhookMiddleware.js.map +1 -0
- package/dist/WebhookValidator.d.ts +92 -0
- package/dist/WebhookValidator.js +409 -0
- package/dist/WebhookValidator.js.map +1 -0
- package/dist/agents/BedrockAgent.d.ts +162 -0
- package/dist/agents/BedrockAgent.js +323 -0
- package/dist/agents/BedrockAgent.js.map +1 -0
- package/dist/ai-chat/AIChatClient.d.ts +316 -0
- package/dist/ai-chat/AIChatClient.js +535 -0
- package/dist/ai-chat/AIChatClient.js.map +1 -0
- package/dist/ai-chat/ChatGateway.d.ts +408 -0
- package/dist/ai-chat/ChatGateway.js +747 -0
- package/dist/ai-chat/ChatGateway.js.map +1 -0
- package/dist/ai-chat/HandoffRouter.d.ts +282 -0
- package/dist/ai-chat/HandoffRouter.js +518 -0
- package/dist/ai-chat/HandoffRouter.js.map +1 -0
- package/dist/ai-chat/index.d.ts +12 -0
- package/dist/ai-chat/index.js +10 -0
- package/dist/ai-chat/index.js.map +1 -0
- package/dist/capabilities.d.ts +64 -0
- package/dist/capabilities.js +95 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +32 -6
- package/dist/cli/agent-loader.js +95 -34
- package/dist/cli/agent-loader.js.map +1 -1
- package/dist/cli/datamap-exec.d.ts +175 -0
- package/dist/cli/datamap-exec.js +1284 -0
- package/dist/cli/datamap-exec.js.map +1 -0
- package/dist/cli/function-args.d.ts +40 -0
- package/dist/cli/function-args.js +146 -0
- package/dist/cli/function-args.js.map +1 -0
- package/dist/cli/simulation.d.ts +99 -0
- package/dist/cli/simulation.js +490 -0
- package/dist/cli/simulation.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +12 -25
- package/dist/cli/swaig-test.js +935 -367
- package/dist/cli/swaig-test.js.map +1 -1
- package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
- package/dist/cli/tsdocs/agentsNote.js +92 -0
- package/dist/cli/tsdocs/agentsNote.js.map +1 -0
- package/dist/cli/tsdocs/api-index.json +1 -0
- package/dist/cli/tsdocs/api.d.ts +91 -0
- package/dist/cli/tsdocs/api.js +372 -0
- package/dist/cli/tsdocs/api.js.map +1 -0
- package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
- package/dist/cli/tsdocs/apiTypes.js +7 -0
- package/dist/cli/tsdocs/apiTypes.js.map +1 -0
- package/dist/cli/tsdocs/bin.d.ts +6 -0
- package/dist/cli/tsdocs/bin.js +23 -0
- package/dist/cli/tsdocs/bin.js.map +1 -0
- package/dist/cli/tsdocs/files.d.ts +108 -0
- package/dist/cli/tsdocs/files.js +287 -0
- package/dist/cli/tsdocs/files.js.map +1 -0
- package/dist/cli/tsdocs/index.d.ts +28 -0
- package/dist/cli/tsdocs/index.js +307 -0
- package/dist/cli/tsdocs/index.js.map +1 -0
- package/dist/cli/tsdocs/live.d.ts +41 -0
- package/dist/cli/tsdocs/live.js +202 -0
- package/dist/cli/tsdocs/live.js.map +1 -0
- package/dist/cli/tsdocs/locate.d.ts +51 -0
- package/dist/cli/tsdocs/locate.js +75 -0
- package/dist/cli/tsdocs/locate.js.map +1 -0
- package/dist/cli/tsdocs/render.d.ts +75 -0
- package/dist/cli/tsdocs/render.js +323 -0
- package/dist/cli/tsdocs/render.js.map +1 -0
- package/dist/cli/tsdocs/topics.d.ts +43 -0
- package/dist/cli/tsdocs/topics.js +916 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +102 -39
- package/dist/index.js +107 -30
- package/dist/index.js.map +1 -1
- package/dist/livewire/index.d.ts +229 -155
- package/dist/livewire/index.js +298 -195
- package/dist/livewire/index.js.map +1 -1
- package/dist/llms.txt +65 -0
- package/dist/prefabs/CallSessionStore.d.ts +52 -0
- package/dist/prefabs/CallSessionStore.js +72 -0
- package/dist/prefabs/CallSessionStore.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +13 -1
- package/dist/prefabs/ConciergeAgent.js +36 -31
- package/dist/prefabs/ConciergeAgent.js.map +1 -1
- package/dist/prefabs/FAQBotAgent.d.ts +9 -1
- package/dist/prefabs/FAQBotAgent.js +113 -47
- package/dist/prefabs/FAQBotAgent.js.map +1 -1
- package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
- package/dist/prefabs/InfoGathererAgent.js +67 -58
- package/dist/prefabs/InfoGathererAgent.js.map +1 -1
- package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
- package/dist/prefabs/ReceptionistAgent.js +39 -31
- package/dist/prefabs/ReceptionistAgent.js.map +1 -1
- package/dist/prefabs/SurveyAgent.d.ts +22 -4
- package/dist/prefabs/SurveyAgent.js +84 -68
- package/dist/prefabs/SurveyAgent.js.map +1 -1
- package/dist/relay/Action.d.ts +44 -21
- package/dist/relay/Action.js +75 -17
- package/dist/relay/Action.js.map +1 -1
- package/dist/relay/Call.d.ts +312 -47
- package/dist/relay/Call.js +369 -18
- package/dist/relay/Call.js.map +1 -1
- package/dist/relay/Deferred.js.map +1 -1
- package/dist/relay/Message.d.ts +26 -5
- package/dist/relay/Message.js +36 -6
- package/dist/relay/Message.js.map +1 -1
- package/dist/relay/RelayClient.d.ts +79 -14
- package/dist/relay/RelayClient.js +268 -61
- package/dist/relay/RelayClient.js.map +1 -1
- package/dist/relay/RelayError.d.ts +14 -0
- package/dist/relay/RelayError.js +15 -0
- package/dist/relay/RelayError.js.map +1 -1
- package/dist/relay/RelayEvent.d.ts +96 -65
- package/dist/relay/RelayEvent.js +85 -56
- package/dist/relay/RelayEvent.js.map +1 -1
- package/dist/relay/closedSets.d.ts +111 -0
- package/dist/relay/closedSets.js +83 -0
- package/dist/relay/closedSets.js.map +1 -0
- package/dist/relay/index.d.ts +3 -1
- package/dist/relay/index.js +1 -0
- package/dist/relay/index.js.map +1 -1
- package/dist/relay/normalize.js.map +1 -1
- package/dist/relay/protocol.types.generated.d.ts +1195 -0
- package/dist/relay/protocol.types.generated.js +8 -0
- package/dist/relay/protocol.types.generated.js.map +1 -0
- package/dist/relay/types.d.ts +81 -39
- package/dist/rest/HttpClient.d.ts +36 -8
- package/dist/rest/HttpClient.js +233 -40
- package/dist/rest/HttpClient.js.map +1 -1
- package/dist/rest/RequestOptions.d.ts +110 -0
- package/dist/rest/RequestOptions.js +113 -0
- package/dist/rest/RequestOptions.js.map +1 -0
- package/dist/rest/RestError.d.ts +52 -6
- package/dist/rest/RestError.js +89 -5
- package/dist/rest/RestError.js.map +1 -1
- package/dist/rest/base/CrudResource.d.ts +16 -26
- package/dist/rest/base/CrudResource.js +19 -33
- package/dist/rest/base/CrudResource.js.map +1 -1
- package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
- package/dist/rest/base/CrudWithAddresses.js +2 -2
- package/dist/rest/base/CrudWithAddresses.js.map +1 -1
- package/dist/rest/base/FabricResource.d.ts +15 -0
- package/dist/rest/base/FabricResource.js +16 -0
- package/dist/rest/base/FabricResource.js.map +1 -0
- package/dist/rest/base/ReadResource.d.ts +62 -0
- package/dist/rest/base/ReadResource.js +69 -0
- package/dist/rest/base/ReadResource.js.map +1 -0
- package/dist/rest/callHandler.d.ts +63 -0
- package/dist/rest/callHandler.js +62 -0
- package/dist/rest/callHandler.js.map +1 -0
- package/dist/rest/index.d.ts +19 -76
- package/dist/rest/index.js +49 -120
- package/dist/rest/index.js.map +1 -1
- package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
- package/dist/rest/namespaces/_client_tree_generated.js +171 -0
- package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +3 -42
- package/dist/rest/namespaces/addresses.js +3 -50
- package/dist/rest/namespaces/addresses.js.map +1 -1
- package/dist/rest/namespaces/calling.d.ts +6 -378
- package/dist/rest/namespaces/calling.js +6 -473
- package/dist/rest/namespaces/calling.js.map +1 -1
- package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
- package/dist/rest/namespaces/calling.resources.generated.js +477 -0
- package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
- package/dist/rest/namespaces/calling.types.generated.js +8 -0
- package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +4 -18
- package/dist/rest/namespaces/chat.js +4 -21
- package/dist/rest/namespaces/chat.js.map +1 -1
- package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/chat.resources.generated.js +29 -0
- package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
- package/dist/rest/namespaces/chat.types.generated.js +8 -0
- package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +6 -62
- package/dist/rest/namespaces/datasphere.js +6 -72
- package/dist/rest/namespaces/datasphere.js.map +1 -1
- package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
- package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
- package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +11 -273
- package/dist/rest/namespaces/fabric.js +14 -363
- package/dist/rest/namespaces/fabric.js.map +1 -1
- package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
- package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
- package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
- package/dist/rest/namespaces/fabric.types.generated.js +8 -0
- package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/fax.resources.generated.js +14 -0
- package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/fax.types.generated.js +8 -0
- package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
- package/dist/rest/namespaces/imported-numbers.js +3 -21
- package/dist/rest/namespaces/imported-numbers.js.map +1 -1
- package/dist/rest/namespaces/logs.d.ts +10 -101
- package/dist/rest/namespaces/logs.js +10 -128
- package/dist/rest/namespaces/logs.js.map +1 -1
- package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/logs.resources.generated.js +17 -0
- package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/logs.types.generated.js +8 -0
- package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +3 -25
- package/dist/rest/namespaces/lookup.js +3 -27
- package/dist/rest/namespaces/lookup.js.map +1 -1
- package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/message.resources.generated.js +14 -0
- package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
- package/dist/rest/namespaces/message.types.generated.js +8 -0
- package/dist/rest/namespaces/message.types.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
- package/dist/rest/namespaces/messages.resources.generated.js +44 -0
- package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
- package/dist/rest/namespaces/messages.types.generated.js +8 -0
- package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +3 -42
- package/dist/rest/namespaces/mfa.js +3 -49
- package/dist/rest/namespaces/mfa.js.map +1 -1
- package/dist/rest/namespaces/number-groups.d.ts +3 -45
- package/dist/rest/namespaces/number-groups.js +3 -53
- package/dist/rest/namespaces/number-groups.js.map +1 -1
- package/dist/rest/namespaces/phone-numbers.d.ts +9 -57
- package/dist/rest/namespaces/phone-numbers.js +9 -63
- package/dist/rest/namespaces/phone-numbers.js.map +1 -1
- package/dist/rest/namespaces/project.d.ts +6 -42
- package/dist/rest/namespaces/project.js +6 -51
- package/dist/rest/namespaces/project.js.map +1 -1
- package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
- package/dist/rest/namespaces/project.resources.generated.js +44 -0
- package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
- package/dist/rest/namespaces/project.types.generated.js +8 -0
- package/dist/rest/namespaces/project.types.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/projects.resources.generated.js +25 -0
- package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
- package/dist/rest/namespaces/projects.types.generated.js +8 -0
- package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +4 -18
- package/dist/rest/namespaces/pubsub.js +4 -21
- package/dist/rest/namespaces/pubsub.js.map +1 -1
- package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
- package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
- package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +3 -38
- package/dist/rest/namespaces/queues.js +3 -44
- package/dist/rest/namespaces/queues.js.map +1 -1
- package/dist/rest/namespaces/recordings.d.ts +3 -34
- package/dist/rest/namespaces/recordings.js +3 -40
- package/dist/rest/namespaces/recordings.js.map +1 -1
- package/dist/rest/namespaces/registry.d.ts +6 -137
- package/dist/rest/namespaces/registry.js +6 -173
- package/dist/rest/namespaces/registry.js.map +1 -1
- package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +3 -35
- package/dist/rest/namespaces/short-codes.js +3 -41
- package/dist/rest/namespaces/short-codes.js.map +1 -1
- package/dist/rest/namespaces/sip-profile.d.ts +3 -24
- package/dist/rest/namespaces/sip-profile.js +3 -29
- package/dist/rest/namespaces/sip-profile.js.map +1 -1
- package/dist/rest/namespaces/verified-callers.d.ts +3 -29
- package/dist/rest/namespaces/verified-callers.js +3 -34
- package/dist/rest/namespaces/verified-callers.js.map +1 -1
- package/dist/rest/namespaces/video.d.ts +10 -227
- package/dist/rest/namespaces/video.js +10 -288
- package/dist/rest/namespaces/video.js.map +1 -1
- package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
- package/dist/rest/namespaces/video.resources.generated.js +171 -0
- package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
- package/dist/rest/namespaces/video.types.generated.js +8 -0
- package/dist/rest/namespaces/video.types.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/voice.resources.generated.js +17 -0
- package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
- package/dist/rest/namespaces/voice.types.generated.js +8 -0
- package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
- package/dist/rest/pagination.d.ts +5 -1
- package/dist/rest/pagination.js +40 -20
- package/dist/rest/pagination.js.map +1 -1
- package/dist/rest/types.d.ts +21 -3
- package/dist/schema.json +299 -98
- package/dist/skills/SkillBase.d.ts +97 -20
- package/dist/skills/SkillBase.js +100 -17
- package/dist/skills/SkillBase.js.map +1 -1
- package/dist/skills/SkillManager.d.ts +66 -13
- package/dist/skills/SkillManager.js +101 -20
- package/dist/skills/SkillManager.js.map +1 -1
- package/dist/skills/SkillName.d.ts +44 -0
- package/dist/skills/SkillName.js +2 -0
- package/dist/skills/SkillName.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +47 -7
- package/dist/skills/SkillRegistry.js +85 -13
- package/dist/skills/SkillRegistry.js.map +1 -1
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
- package/dist/skills/builtin/api_ninjas_trivia.js +24 -8
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
- package/dist/skills/builtin/ask_claude.d.ts +14 -4
- package/dist/skills/builtin/ask_claude.js +36 -14
- package/dist/skills/builtin/ask_claude.js.map +1 -1
- package/dist/skills/builtin/claude_skills.d.ts +3 -1
- package/dist/skills/builtin/claude_skills.js +19 -15
- package/dist/skills/builtin/claude_skills.js.map +1 -1
- package/dist/skills/builtin/custom_skills.d.ts +10 -3
- package/dist/skills/builtin/custom_skills.js +26 -9
- package/dist/skills/builtin/custom_skills.js.map +1 -1
- package/dist/skills/builtin/datasphere.d.ts +5 -3
- package/dist/skills/builtin/datasphere.js +34 -25
- package/dist/skills/builtin/datasphere.js.map +1 -1
- package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
- package/dist/skills/builtin/datasphere_serverless.js +17 -6
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
- package/dist/skills/builtin/datetime.d.ts +3 -1
- package/dist/skills/builtin/datetime.js +11 -7
- package/dist/skills/builtin/datetime.js.map +1 -1
- package/dist/skills/builtin/google_maps.d.ts +29 -14
- package/dist/skills/builtin/google_maps.js +89 -269
- package/dist/skills/builtin/google_maps.js.map +1 -1
- package/dist/skills/builtin/index.d.ts +8 -6
- package/dist/skills/builtin/index.js +8 -6
- package/dist/skills/builtin/index.js.map +1 -1
- package/dist/skills/builtin/info_gatherer.d.ts +4 -2
- package/dist/skills/builtin/info_gatherer.js +20 -12
- package/dist/skills/builtin/info_gatherer.js.map +1 -1
- package/dist/skills/builtin/joke.d.ts +16 -6
- package/dist/skills/builtin/joke.js +54 -37
- package/dist/skills/builtin/joke.js.map +1 -1
- package/dist/skills/builtin/math.d.ts +3 -1
- package/dist/skills/builtin/math.js +14 -9
- package/dist/skills/builtin/math.js.map +1 -1
- package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
- package/dist/skills/builtin/mcp_gateway.js +77 -46
- package/dist/skills/builtin/mcp_gateway.js.map +1 -1
- package/dist/skills/builtin/native_vector_search.d.ts +19 -5
- package/dist/skills/builtin/native_vector_search.js +179 -61
- package/dist/skills/builtin/native_vector_search.js.map +1 -1
- package/dist/skills/builtin/play_background_file.d.ts +21 -15
- package/dist/skills/builtin/play_background_file.js +43 -122
- package/dist/skills/builtin/play_background_file.js.map +1 -1
- package/dist/skills/builtin/spider.d.ts +46 -1
- package/dist/skills/builtin/spider.js +317 -101
- package/dist/skills/builtin/spider.js.map +1 -1
- package/dist/skills/builtin/swml_transfer.d.ts +14 -3
- package/dist/skills/builtin/swml_transfer.js +45 -24
- package/dist/skills/builtin/swml_transfer.js.map +1 -1
- package/dist/skills/builtin/weather_api.d.ts +24 -13
- package/dist/skills/builtin/weather_api.js +57 -31
- package/dist/skills/builtin/weather_api.js.map +1 -1
- package/dist/skills/builtin/web_search.d.ts +48 -10
- package/dist/skills/builtin/web_search.js +301 -84
- package/dist/skills/builtin/web_search.js.map +1 -1
- package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
- package/dist/skills/builtin/wikipedia_search.js +32 -14
- package/dist/skills/builtin/wikipedia_search.js.map +1 -1
- package/dist/skills/index.d.ts +3 -2
- package/dist/skills/index.js +1 -1
- package/dist/skills/index.js.map +1 -1
- package/dist/swml_verbs_generated.d.ts +2824 -0
- package/dist/swml_verbs_generated.js +12 -0
- package/dist/swml_verbs_generated.js.map +1 -0
- package/dist/types.d.ts +65 -6
- package/dist/web.d.ts +27 -0
- package/dist/web.js +20 -0
- package/dist/web.js.map +1 -0
- package/docs/agent-guide.md +1034 -0
- package/docs/ai_chat.md +560 -0
- package/docs/api-reference.md +3534 -0
- package/docs/architecture.md +846 -0
- package/docs/bedrock_agent.md +411 -0
- package/docs/cli-guide.md +403 -0
- package/docs/cloud_functions_guide.md +399 -0
- package/docs/configuration.md +548 -0
- package/docs/contexts-guide.md +884 -0
- package/docs/datamap-guide.md +1160 -0
- package/docs/developer_pain_points.md +548 -0
- package/docs/llm_parameters.md +298 -0
- package/docs/mcp_gateway_reference.md +354 -0
- package/docs/mcp_integration.md +162 -0
- package/docs/pgi_agent_guide.md +1820 -0
- package/docs/prefabs-guide.md +815 -0
- package/docs/programmatically_governed_inference.md +301 -0
- package/docs/sdk_features.md +501 -0
- package/docs/security.md +559 -0
- package/docs/serverless-guide.md +520 -0
- package/docs/skills-guide.md +1223 -0
- package/docs/skills-system.md +405 -0
- package/docs/skills_parameter_schema.md +417 -0
- package/docs/swaig-reference.md +1938 -0
- package/docs/swml_service_guide.md +573 -0
- package/docs/third_party_skills.md +410 -0
- package/docs/web_service.md +666 -0
- package/examples/README.md +202 -0
- package/examples/advanced-datamap.ts +108 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +95 -0
- package/examples/call-flow.ts +65 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +51 -0
- package/examples/datasphere-multi-instance.ts +66 -0
- package/examples/datasphere-serverless-env.ts +87 -0
- package/examples/datasphere-webhook-env.ts +65 -0
- package/examples/datasphere.ts +56 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +95 -0
- package/examples/gather-per-question-functions-demo.ts +139 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +75 -0
- package/examples/mcp-agent.ts +89 -0
- package/examples/mcp-gateway.ts +81 -0
- package/examples/multi-agent.ts +80 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pgi/case-domain.ts +114 -0
- package/examples/pgi/serve.ts +16 -0
- package/examples/pgi/support-agent.ts +265 -0
- package/examples/pom-prompt.ts +70 -0
- package/examples/prefab-concierge.ts +42 -0
- package/examples/prefab-faq.ts +58 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +69 -0
- package/examples/quickstart-agent.ts +29 -0
- package/examples/quickstart-relay.ts +25 -0
- package/examples/quickstart-rest.ts +25 -0
- package/examples/record-call.ts +65 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +93 -0
- package/examples/serverless-lambda.ts +43 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +41 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +193 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/swmlservice_ai_sidecar.ts +104 -0
- package/examples/swmlservice_swaig_standalone.ts +79 -0
- package/examples/tap.ts +67 -0
- package/examples/typed-tools.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +75 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +164 -0
- package/livewire/docs/migration-guide.md +251 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +196 -0
- package/livewire/examples/livewire-multi-tool.ts +121 -0
- package/package.json +88 -13
- package/relay/README.md +101 -0
- package/relay/docs/call-methods.md +622 -0
- package/relay/docs/client-reference.md +281 -0
- package/relay/docs/events.md +193 -0
- package/relay/docs/getting-started.md +221 -0
- package/relay/docs/guide.md +386 -0
- package/relay/docs/messaging.md +246 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +74 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +141 -0
- package/rest/docs/calling.md +313 -0
- package/rest/docs/client-reference.md +149 -0
- package/rest/docs/fabric.md +192 -0
- package/rest/docs/getting-started.md +138 -0
- package/rest/docs/guide.md +421 -0
- package/rest/docs/namespaces.md +367 -0
- package/rest/docs/phone-binding.md +116 -0
- package/rest/examples/rest-10dlc-registration.ts +177 -0
- package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
- package/rest/examples/rest-calling-play-and-record.ts +98 -0
- package/rest/examples/rest-client.ts +59 -0
- package/rest/examples/rest-datasphere-search.ts +81 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
- package/rest/examples/rest-manage-resources.ts +64 -0
- package/rest/examples/rest-phone-number-management.ts +200 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/tutorial/fred/fred.ts +218 -0
- package/tutorial/fred/tutorial/01-introduction.md +141 -0
- package/tutorial/fred/tutorial/02-setup.md +304 -0
- package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
- package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
- package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
- package/tutorial/fred/tutorial/06-running-testing.md +642 -0
- package/tutorial/fred/tutorial/README.md +56 -0
- package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
- package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
- package/tutorial/full-guardrails-agent/handlers.ts +436 -0
- package/tutorial/full-guardrails-agent/penny.ts +305 -0
- package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
- package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
- package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
- package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
- package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
- package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
- package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
- package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
- package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
- package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
- package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
- package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
- package/tutorial/full-guardrails-agent/workflow.ts +219 -0
- package/tutorial/multi_agents/README.md +175 -0
- package/tutorial/multi_agents/advanced_agent.ts +395 -0
- package/tutorial/multi_agents/extending_agents.ts +641 -0
- package/tutorial/multi_agents/knowledge.ts +59 -0
- package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
- package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
- package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
- package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
- package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
- package/tutorial/multi_agents/pc_builder.ts +529 -0
- package/tutorial/multi_agents/sales_agent.ts +88 -0
- package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
- package/tutorial/multi_agents/sales_knowledge.md +139 -0
- package/tutorial/multi_agents/support_knowledge.md +256 -0
- package/dist/cli/mock-data.d.ts +0 -37
- package/dist/cli/mock-data.js +0 -80
- package/dist/cli/mock-data.js.map +0 -1
- package/dist/generateVerbTypes.d.ts +0 -11
- package/dist/generateVerbTypes.js +0 -265
- package/dist/generateVerbTypes.js.map +0 -1
- package/dist/rest/namespaces/compat.d.ts +0 -585
- package/dist/rest/namespaces/compat.js +0 -735
- package/dist/rest/namespaces/compat.js.map +0 -1
|
@@ -0,0 +1,368 @@
|
|
|
1
|
+
# Lesson 1: Creating Your First Agent
|
|
2
|
+
|
|
3
|
+
This lesson builds Morgan, a sales agent for PC Builder Pro that helps callers choose a PC build. Morgan is an AI voice agent built with the SignalWire Agents SDK for TypeScript: an HTTP service that tells SignalWire how to run the call.
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
1. [How an agent works](#how-an-agent-works)
|
|
8
|
+
2. [Creating a basic agent](#creating-a-basic-agent)
|
|
9
|
+
3. [Configuring agent prompts](#configuring-agent-prompts)
|
|
10
|
+
4. [Adding voice and language](#adding-voice-and-language)
|
|
11
|
+
5. [Running your agent](#running-your-agent)
|
|
12
|
+
6. [Testing your agent](#testing-your-agent)
|
|
13
|
+
7. [Enabling SSL/HTTPS](#enabling-sslhttps)
|
|
14
|
+
8. [Summary](#summary)
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## How an agent works
|
|
19
|
+
|
|
20
|
+
An agent is an `AgentBase` instance. You configure it with method calls, as this lesson does, or by extending the class. Every agent has these parts:
|
|
21
|
+
|
|
22
|
+
- **Name**: identifies the agent in logs
|
|
23
|
+
- **Route**: the HTTP path the agent answers on, such as `/` or `/sales`
|
|
24
|
+
- **Host and port**: where its HTTP server listens
|
|
25
|
+
- **Prompt**: the instructions that define the agent's behavior
|
|
26
|
+
- **Languages and voices**: the text-to-speech configuration
|
|
27
|
+
|
|
28
|
+
When a call arrives, SignalWire requests the agent's route. The agent answers with SWML (SignalWire Markup Language), a JSON document that describes the call. For Morgan, it says: answer the call, then run an AI with this prompt and this voice.
|
|
29
|
+
|
|
30
|
+
## Creating a basic agent
|
|
31
|
+
|
|
32
|
+
This section creates Morgan's agent in `tutorial/multi_agents/sales_agent.ts`.
|
|
33
|
+
|
|
34
|
+
### Step 1: Create the agent
|
|
35
|
+
|
|
36
|
+
Import `AgentBase` and create the agent with a name, a route and a host:
|
|
37
|
+
|
|
38
|
+
<!-- snippet: no-compile a region of tutorial/multi_agents/sales_agent.ts; the file itself is type-checked --> <!-- include: tutorial/multi_agents/sales_agent.ts#construct -->
|
|
39
|
+
```typescript
|
|
40
|
+
import { pathToFileURL } from 'node:url';
|
|
41
|
+
import { AgentBase } from '@signalwire/sdk';
|
|
42
|
+
|
|
43
|
+
export const agent = new AgentBase({
|
|
44
|
+
name: 'PC Builder Sales Agent - Morgan',
|
|
45
|
+
route: '/',
|
|
46
|
+
host: '0.0.0.0',
|
|
47
|
+
});
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
The `pathToFileURL` import is for the last step, which starts the server.
|
|
51
|
+
|
|
52
|
+
### Step 2: Understand the options
|
|
53
|
+
|
|
54
|
+
The constructor takes an options object. These are the ones Morgan uses:
|
|
55
|
+
|
|
56
|
+
- `name`: identifies the agent in logs and debugging
|
|
57
|
+
- `route`: the URL path the agent answers on. Use `/` for the root.
|
|
58
|
+
- `host`: the network interface to listen on. `0.0.0.0`, the default, listens on all of them.
|
|
59
|
+
|
|
60
|
+
The agent listens on the port in the `PORT` environment variable, or 3000 when it's unset. A `port` option overrides both.
|
|
61
|
+
|
|
62
|
+
## Configuring agent prompts
|
|
63
|
+
|
|
64
|
+
The Prompt Object Model (POM) structures a prompt as titled sections instead of one long string. Each call to `promptAddSection()` adds a section with a body, bullets, or both.
|
|
65
|
+
|
|
66
|
+
### Step 3: Add the agent's role
|
|
67
|
+
|
|
68
|
+
Add a section that names Morgan and describes the character:
|
|
69
|
+
|
|
70
|
+
<!-- snippet: no-compile a region of tutorial/multi_agents/sales_agent.ts; the file itself is type-checked --> <!-- include: tutorial/multi_agents/sales_agent.ts#role -->
|
|
71
|
+
```typescript
|
|
72
|
+
// Configure the agent's personality and role
|
|
73
|
+
agent.promptAddSection('AI Role', {
|
|
74
|
+
body:
|
|
75
|
+
'You are Morgan, a passionate PC building expert and sales specialist ' +
|
|
76
|
+
"at PC Builder Pro. You're known for your deep knowledge of components " +
|
|
77
|
+
'and your ability to match customers with their perfect build. You get ' +
|
|
78
|
+
'excited about the latest hardware and love sharing that enthusiasm. ' +
|
|
79
|
+
'Always introduce yourself by name.',
|
|
80
|
+
});
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Step 4: Define areas of expertise
|
|
84
|
+
|
|
85
|
+
Add a second section that lists what Morgan specializes in:
|
|
86
|
+
|
|
87
|
+
<!-- snippet: no-compile a region of tutorial/multi_agents/sales_agent.ts; the file itself is type-checked --> <!-- include: tutorial/multi_agents/sales_agent.ts#expertise -->
|
|
88
|
+
```typescript
|
|
89
|
+
// Add expertise section
|
|
90
|
+
agent.promptAddSection('Your Expertise', {
|
|
91
|
+
body: 'Areas of specialization:',
|
|
92
|
+
bullets: [
|
|
93
|
+
'Custom PC builds for all budgets',
|
|
94
|
+
'Component compatibility and optimization',
|
|
95
|
+
'Performance recommendations',
|
|
96
|
+
'Price/performance analysis',
|
|
97
|
+
'Current market trends',
|
|
98
|
+
],
|
|
99
|
+
});
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### Step 5: Define tasks and workflow
|
|
103
|
+
|
|
104
|
+
Add the steps Morgan follows during a sales call:
|
|
105
|
+
|
|
106
|
+
<!-- snippet: no-compile a region of tutorial/multi_agents/sales_agent.ts; the file itself is type-checked --> <!-- include: tutorial/multi_agents/sales_agent.ts#tasks -->
|
|
107
|
+
```typescript
|
|
108
|
+
// Define the sales workflow
|
|
109
|
+
agent.promptAddSection('Your Tasks', {
|
|
110
|
+
body: 'Complete sales process workflow with passion and expertise:',
|
|
111
|
+
bullets: [
|
|
112
|
+
'Greet customers warmly and introduce yourself',
|
|
113
|
+
'Understand their specific PC building requirements',
|
|
114
|
+
'Ask about budget, intended use, and preferences',
|
|
115
|
+
'Provide knowledgeable recommendations',
|
|
116
|
+
'Share your enthusiasm for PC building',
|
|
117
|
+
'Offer to explain technical details when helpful',
|
|
118
|
+
],
|
|
119
|
+
});
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Step 6: Add voice instructions
|
|
123
|
+
|
|
124
|
+
Add a section that describes how Morgan should sound:
|
|
125
|
+
|
|
126
|
+
<!-- snippet: no-compile a region of tutorial/multi_agents/sales_agent.ts; the file itself is type-checked --> <!-- include: tutorial/multi_agents/sales_agent.ts#voice-instructions -->
|
|
127
|
+
```typescript
|
|
128
|
+
// Voice and tone instructions
|
|
129
|
+
agent.promptAddSection('Voice Instructions', {
|
|
130
|
+
body:
|
|
131
|
+
'Share your passion for PC building and get excited about ' +
|
|
132
|
+
'helping customers create their perfect system. Your enthusiasm ' +
|
|
133
|
+
'should be genuine and infectious.',
|
|
134
|
+
});
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
The prompt's warm tone belongs to the persona. The model reads these sections as instructions, and callers hear the result.
|
|
138
|
+
|
|
139
|
+
## Adding voice and language
|
|
140
|
+
|
|
141
|
+
A language entry tells SignalWire which language the caller speaks and which text-to-speech voice answers.
|
|
142
|
+
|
|
143
|
+
### Step 7: Configure the voice
|
|
144
|
+
|
|
145
|
+
Add English with the `rime.marsh` voice:
|
|
146
|
+
|
|
147
|
+
<!-- snippet: no-compile a region of tutorial/multi_agents/sales_agent.ts; the file itself is type-checked --> <!-- include: tutorial/multi_agents/sales_agent.ts#language -->
|
|
148
|
+
```typescript
|
|
149
|
+
// Configure language and voice
|
|
150
|
+
agent.addLanguage({
|
|
151
|
+
name: 'English',
|
|
152
|
+
code: 'en-US',
|
|
153
|
+
voice: 'rime.marsh', // A friendly, enthusiastic voice
|
|
154
|
+
});
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
This tutorial gives each persona its own Rime voice: `rime.marsh` for Morgan, `rime.spore` for Alex and `rime.cove` for Sam. For the full list of voices, see the [SignalWire documentation](https://signalwire.com/docs).
|
|
158
|
+
|
|
159
|
+
## Running your agent
|
|
160
|
+
|
|
161
|
+
The last step starts the HTTP server, but only when you run the file. Tests and `swaig-test` import the file to reach `agent`, and don't need a server.
|
|
162
|
+
|
|
163
|
+
### Step 8: Start the server
|
|
164
|
+
|
|
165
|
+
Add the code that prints where the agent is and starts it:
|
|
166
|
+
|
|
167
|
+
<!-- snippet: no-compile a region of tutorial/multi_agents/sales_agent.ts; the file itself is type-checked --> <!-- include: tutorial/multi_agents/sales_agent.ts#main -->
|
|
168
|
+
```typescript
|
|
169
|
+
// Start the server only when this file is run, not when it's imported
|
|
170
|
+
if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href) {
|
|
171
|
+
console.log('Starting PC Builder Sales Agent - Morgan');
|
|
172
|
+
console.log(`Agent running at: ${agent.getFullUrl()}/`);
|
|
173
|
+
console.log('Press Ctrl+C to stop');
|
|
174
|
+
await agent.run();
|
|
175
|
+
}
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
Apart from the comment at the top, steps 1 and 3 through 8, in order, make up the whole file.
|
|
179
|
+
|
|
180
|
+
### Step 9: Run the agent
|
|
181
|
+
|
|
182
|
+
Every request to the agent needs basic auth. Without `SWML_BASIC_AUTH_USER` and `SWML_BASIC_AUTH_PASSWORD`, the agent generates a password and keeps it out of the logs, so set both first. Then run the file with `tsx` from the root of the SDK repository:
|
|
183
|
+
|
|
184
|
+
```bash
|
|
185
|
+
export SWML_BASIC_AUTH_USER=devuser
|
|
186
|
+
export SWML_BASIC_AUTH_PASSWORD=devpassword
|
|
187
|
+
npx tsx tutorial/multi_agents/sales_agent.ts
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
The agent prints its address, and the SDK logs the address it listens on and the credentials' source:
|
|
191
|
+
|
|
192
|
+
```text
|
|
193
|
+
2026-09-29T17:33:51.165Z [WARN] [AgentBase] [signalwire] webhook signature validation is disabled — set signingKey or SIGNALWIRE_SIGNING_KEY to enable
|
|
194
|
+
Starting PC Builder Sales Agent - Morgan
|
|
195
|
+
Agent running at: http://localhost:3000/
|
|
196
|
+
Press Ctrl+C to stop
|
|
197
|
+
2026-09-29T17:33:51.170Z [INFO] [AgentBase] Agent 'PC Builder Sales Agent - Morgan' running at http://0.0.0.0:3000/
|
|
198
|
+
2026-09-29T17:33:51.170Z [INFO] [AgentBase] Auth: devuser:**** (source: environment)
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
The warning says the agent can't yet tell whether a request came from SignalWire. Lesson 4 sets `SIGNALWIRE_SIGNING_KEY` for production.
|
|
202
|
+
|
|
203
|
+
## Testing your agent
|
|
204
|
+
|
|
205
|
+
You can test the agent over HTTP while it runs, or load it with `swaig-test` without a server.
|
|
206
|
+
|
|
207
|
+
### Method 1: Request the SWML document
|
|
208
|
+
|
|
209
|
+
From a second terminal, request the SWML with curl, and pretty-print it with `jq`:
|
|
210
|
+
|
|
211
|
+
```bash
|
|
212
|
+
curl -u devuser:devpassword http://localhost:3000/ | jq .
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
A request without the credentials gets `401 Unauthorized`.
|
|
216
|
+
|
|
217
|
+
### Method 2: Use swaig-test
|
|
218
|
+
|
|
219
|
+
`swaig-test` loads the file, finds the agent it exports, and prints its SWML without starting a server:
|
|
220
|
+
|
|
221
|
+
```bash
|
|
222
|
+
npx tsx src/cli/swaig-test.ts tutorial/multi_agents/sales_agent.ts --dump-swml
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
In a project that installs the SDK, the same command is `npx swaig-test tutorial/multi_agents/sales_agent.ts --dump-swml`.
|
|
226
|
+
|
|
227
|
+
### Understanding the SWML output
|
|
228
|
+
|
|
229
|
+
The agent returns this document, shortened here to its first prompt section. `answer` picks up the call, and `ai` carries the prompt and the voice:
|
|
230
|
+
|
|
231
|
+
```json
|
|
232
|
+
{
|
|
233
|
+
"version": "1.0.0",
|
|
234
|
+
"sections": {
|
|
235
|
+
"main": [
|
|
236
|
+
{
|
|
237
|
+
"answer": {}
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
"ai": {
|
|
241
|
+
"prompt": {
|
|
242
|
+
"pom": [
|
|
243
|
+
{
|
|
244
|
+
"body": "You are Morgan, a passionate PC building expert and sales specialist at PC Builder Pro. You're known for your deep knowledge of components and your ability to match customers with their perfect build. You get excited about the latest hardware and love sharing that enthusiasm. Always introduce yourself by name.",
|
|
245
|
+
"title": "AI Role"
|
|
246
|
+
}
|
|
247
|
+
]
|
|
248
|
+
},
|
|
249
|
+
"languages": [
|
|
250
|
+
{
|
|
251
|
+
"name": "English",
|
|
252
|
+
"code": "en-US",
|
|
253
|
+
"voice": "rime.marsh"
|
|
254
|
+
}
|
|
255
|
+
]
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
]
|
|
259
|
+
}
|
|
260
|
+
}
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
The other three sections follow `AI Role` in the `pom` list, in the order you added them.
|
|
264
|
+
|
|
265
|
+
## Enabling SSL/HTTPS
|
|
266
|
+
|
|
267
|
+
SignalWire needs to reach the agent over the internet, and production traffic should be encrypted. The agent serves HTTPS itself when three environment variables name a certificate and key:
|
|
268
|
+
|
|
269
|
+
- `SWML_SSL_ENABLED`: `true`, `1` or `yes`
|
|
270
|
+
- `SWML_SSL_CERT_PATH`: the PEM certificate file
|
|
271
|
+
- `SWML_SSL_KEY_PATH`: the PEM private key file
|
|
272
|
+
|
|
273
|
+
With HTTPS on, the URLs the agent puts in its SWML for SignalWire to call back (its webhook URLs) use `https`. Set `SWML_SSL_DOMAIN` to the domain in the certificate, so those URLs use it instead of `localhost`. If a certificate or key file doesn't exist, the agent stops at startup with an `ENOENT` error that names the file.
|
|
274
|
+
|
|
275
|
+
### Method 1: Export the variables
|
|
276
|
+
|
|
277
|
+
Export the variables in the shell, then run the agent:
|
|
278
|
+
|
|
279
|
+
```bash
|
|
280
|
+
export SWML_SSL_ENABLED=true
|
|
281
|
+
export SWML_SSL_CERT_PATH=/path/to/your/certificate.pem
|
|
282
|
+
export SWML_SSL_KEY_PATH=/path/to/your/private-key.pem
|
|
283
|
+
export SWML_SSL_DOMAIN=agents.example.com
|
|
284
|
+
|
|
285
|
+
npx tsx tutorial/multi_agents/sales_agent.ts
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
### Method 2: Set them for one command
|
|
289
|
+
|
|
290
|
+
Set the same variables on the command that starts the agent:
|
|
291
|
+
|
|
292
|
+
```bash
|
|
293
|
+
SWML_SSL_ENABLED=true \
|
|
294
|
+
SWML_SSL_CERT_PATH=/path/to/cert.pem \
|
|
295
|
+
SWML_SSL_KEY_PATH=/path/to/key.pem \
|
|
296
|
+
SWML_SSL_DOMAIN=agents.example.com \
|
|
297
|
+
npx tsx tutorial/multi_agents/sales_agent.ts
|
|
298
|
+
```
|
|
299
|
+
|
|
300
|
+
### Self-signed certificates for development
|
|
301
|
+
|
|
302
|
+
For local testing, create a self-signed certificate with `openssl`:
|
|
303
|
+
|
|
304
|
+
```bash
|
|
305
|
+
openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 365 -nodes \
|
|
306
|
+
-subj "/CN=localhost"
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
Run the agent with it:
|
|
310
|
+
|
|
311
|
+
```bash
|
|
312
|
+
SWML_SSL_ENABLED=true \
|
|
313
|
+
SWML_SSL_CERT_PATH=cert.pem \
|
|
314
|
+
SWML_SSL_KEY_PATH=key.pem \
|
|
315
|
+
npx tsx tutorial/multi_agents/sales_agent.ts
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
The agent now reports HTTPS addresses:
|
|
319
|
+
|
|
320
|
+
```text
|
|
321
|
+
Agent running at: https://localhost:3000/
|
|
322
|
+
Press Ctrl+C to stop
|
|
323
|
+
2026-09-29T17:33:32.151Z [INFO] [AgentBase] Agent 'PC Builder Sales Agent - Morgan' running at https://0.0.0.0:3000/
|
|
324
|
+
```
|
|
325
|
+
|
|
326
|
+
curl rejects a self-signed certificate unless you pass `-k`:
|
|
327
|
+
|
|
328
|
+
```bash
|
|
329
|
+
curl -k -u devuser:devpassword https://localhost:3000/
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
A self-signed certificate is for development only. SignalWire won't trust it, so use a certificate from a certificate authority in production. You can also terminate TLS at a reverse proxy or load balancer, and set `SWML_PROXY_URL_BASE` to the agent's public `https://` URL. For more information, see [SSL/TLS](../../docs/security.md#ssltls) in the security guide.
|
|
333
|
+
|
|
334
|
+
## Summary
|
|
335
|
+
|
|
336
|
+
This lesson built a working agent. The main points:
|
|
337
|
+
|
|
338
|
+
- An agent is an `AgentBase` instance, configured with method calls
|
|
339
|
+
- `promptAddSection()` builds a structured prompt from titled sections
|
|
340
|
+
- `addLanguage()` sets the language and the voice
|
|
341
|
+
- `agent.run()` serves the SWML, over HTTPS when `SWML_SSL_ENABLED` and the certificate paths are set
|
|
342
|
+
- `curl` and `swaig-test` show the SWML without placing a call
|
|
343
|
+
|
|
344
|
+
### Practice exercises
|
|
345
|
+
|
|
346
|
+
Try these changes before you move on:
|
|
347
|
+
|
|
348
|
+
1. **Change Morgan's voice**: try `rime.spore` or `rime.cove`.
|
|
349
|
+
2. **Change the personality**: make Morgan more formal, or more casual.
|
|
350
|
+
3. **Add a section**: add a section about return policies or warranties.
|
|
351
|
+
4. **Change the port**: run the agent on port 3001 with `PORT=3001`.
|
|
352
|
+
|
|
353
|
+
### Troubleshooting
|
|
354
|
+
|
|
355
|
+
These problems come up most often in this lesson:
|
|
356
|
+
|
|
357
|
+
- **Port in use**: set `PORT` to another port, or stop the process that holds it.
|
|
358
|
+
- **`Cannot find module '@signalwire/sdk'`**: run `npm install`, and run the commands from the project root.
|
|
359
|
+
- **The agent serves HTTP when you expected HTTPS**: check that `SWML_SSL_ENABLED` is `true`. Set both path variables in the shell that starts the agent.
|
|
360
|
+
- **`ENOENT` at startup with SSL on**: a certificate or key path is wrong. The error names the file it couldn't open.
|
|
361
|
+
|
|
362
|
+
### Next steps
|
|
363
|
+
|
|
364
|
+
Next, give Morgan a knowledge base to search. Continue with [Lesson 2: Adding Intelligence with Knowledge Bases](lesson2_knowledge_bases.md).
|
|
365
|
+
|
|
366
|
+
---
|
|
367
|
+
|
|
368
|
+
[Tutorial Overview](README.md) | [Next: Lesson 2 - Adding Intelligence with Knowledge Bases](lesson2_knowledge_bases.md)
|