@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
package/examples/tap.ts
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TAP (Media Tap) Example
|
|
3
|
+
*
|
|
4
|
+
* Demonstrates using the TAP action to stream call audio to an
|
|
5
|
+
* external RTP endpoint for real-time processing (e.g., analytics,
|
|
6
|
+
* transcription, or recording to an external system).
|
|
7
|
+
* Run: npx tsx examples/tap.ts
|
|
8
|
+
*/
|
|
9
|
+
|
|
10
|
+
import { AgentBase, FunctionResult } from '@signalwire/sdk';
|
|
11
|
+
|
|
12
|
+
export const agent = new AgentBase({
|
|
13
|
+
name: 'tap-agent',
|
|
14
|
+
route: '/',
|
|
15
|
+
basicAuth: [
|
|
16
|
+
process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
|
|
17
|
+
process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
|
|
18
|
+
],
|
|
19
|
+
});
|
|
20
|
+
|
|
21
|
+
agent.setPromptText(
|
|
22
|
+
'You are a helpful assistant. The call audio can be streamed to ' +
|
|
23
|
+
'an external system for real-time processing. You can start and stop ' +
|
|
24
|
+
'the audio tap when the caller requests it.',
|
|
25
|
+
);
|
|
26
|
+
|
|
27
|
+
// Start audio streaming via TAP
|
|
28
|
+
agent.defineTool({
|
|
29
|
+
name: 'start_tap',
|
|
30
|
+
description: 'Start streaming call audio to an external RTP endpoint',
|
|
31
|
+
parameters: {
|
|
32
|
+
uri: {
|
|
33
|
+
type: 'string',
|
|
34
|
+
description: 'RTP URI to stream audio to (e.g., rtp://192.168.1.100:5000)',
|
|
35
|
+
},
|
|
36
|
+
},
|
|
37
|
+
required: ['uri'],
|
|
38
|
+
handler: (args) => {
|
|
39
|
+
const result = new FunctionResult(
|
|
40
|
+
'Audio streaming started. Call audio is now being sent to the external system.',
|
|
41
|
+
);
|
|
42
|
+
result.tap({
|
|
43
|
+
uri: args.uri,
|
|
44
|
+
controlId: 'main-tap',
|
|
45
|
+
direction: 'both',
|
|
46
|
+
codec: 'PCMU',
|
|
47
|
+
});
|
|
48
|
+
return result;
|
|
49
|
+
},
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
// Stop audio streaming
|
|
53
|
+
agent.defineTool({
|
|
54
|
+
name: 'stop_tap',
|
|
55
|
+
description: 'Stop streaming call audio to the external endpoint',
|
|
56
|
+
parameters: {},
|
|
57
|
+
handler: () => {
|
|
58
|
+
const result = new FunctionResult('Audio streaming stopped.');
|
|
59
|
+
result.stopTap('main-tap');
|
|
60
|
+
return result;
|
|
61
|
+
},
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
|
|
65
|
+
agent.addHints(['tap', 'stream', 'RTP', 'audio']);
|
|
66
|
+
|
|
67
|
+
agent.serve();
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Typed Tools Example
|
|
3
|
+
*
|
|
4
|
+
* `defineTool` is generic over its `parameters` schema: write the parameter map
|
|
5
|
+
* inline and the handler's `args` is inferred precisely — no annotation, no
|
|
6
|
+
* casts. `args.<name>` is typed from the schema, an `enum` narrows to its
|
|
7
|
+
* literal union, and `required` decides which keys are present vs optional.
|
|
8
|
+
*
|
|
9
|
+
* This is the recommended way to define tools. The runtime is unchanged — the
|
|
10
|
+
* model still extracts arguments at call time; the types are an authoring
|
|
11
|
+
* convenience that catch typos and wrong-type usage at compile time.
|
|
12
|
+
*
|
|
13
|
+
* Run: npx tsx examples/typed-tools.ts
|
|
14
|
+
* Test: curl http://user:pass@localhost:3000/
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
import { AgentBase, FunctionResult } from '@signalwire/sdk';
|
|
18
|
+
|
|
19
|
+
export const agent = new AgentBase({
|
|
20
|
+
name: 'typed-tools',
|
|
21
|
+
route: '/',
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
agent.setPromptText('You help users book and check appointments.');
|
|
25
|
+
agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
|
|
26
|
+
|
|
27
|
+
// Inline schema → fully inferred args. `required` makes those keys present;
|
|
28
|
+
// the rest are optional. Hover `args` in your editor to see the inferred type.
|
|
29
|
+
agent.defineTool({
|
|
30
|
+
name: 'book_appointment',
|
|
31
|
+
description: 'Book an appointment for the caller.',
|
|
32
|
+
parameters: {
|
|
33
|
+
service: {
|
|
34
|
+
type: 'string',
|
|
35
|
+
description: 'What to book',
|
|
36
|
+
enum: ['haircut', 'massage', 'consultation'] as const,
|
|
37
|
+
},
|
|
38
|
+
party_size: { type: 'integer', description: 'How many people' },
|
|
39
|
+
notes: { type: 'string', description: 'Optional notes for the booking' },
|
|
40
|
+
},
|
|
41
|
+
required: ['service', 'party_size'],
|
|
42
|
+
handler: (args) => {
|
|
43
|
+
// args.service: 'haircut' | 'massage' | 'consultation' (enum → literal union, required)
|
|
44
|
+
// args.party_size: number (integer, required)
|
|
45
|
+
// args.notes: string | undefined (optional)
|
|
46
|
+
const note = args.notes ? ` (${args.notes})` : '';
|
|
47
|
+
return new FunctionResult(
|
|
48
|
+
`Booked a ${args.service} for ${args.party_size}${note}. See you soon!`,
|
|
49
|
+
);
|
|
50
|
+
},
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
// The second handler argument is the raw SWAIG webhook body (SwaigRequestData)
|
|
54
|
+
// when you need call context alongside the typed args.
|
|
55
|
+
agent.defineTool({
|
|
56
|
+
name: 'check_status',
|
|
57
|
+
description: 'Check the status of the current call by its ID.',
|
|
58
|
+
parameters: {
|
|
59
|
+
verbose: { type: 'boolean', description: 'Include extra detail' },
|
|
60
|
+
},
|
|
61
|
+
handler: (args, rawData) => {
|
|
62
|
+
// args.verbose: boolean | undefined; rawData.call_id is the typed webhook field.
|
|
63
|
+
const detail = args.verbose ? ` (session ${rawData.ai_session_id})` : '';
|
|
64
|
+
return new FunctionResult(`Call ${rawData.call_id} is active${detail}.`);
|
|
65
|
+
},
|
|
66
|
+
});
|
|
67
|
+
|
|
68
|
+
agent.serve();
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Verb Methods Example
|
|
3
|
+
*
|
|
4
|
+
* Demonstrates SwmlBuilder's auto-vivified verb methods for
|
|
5
|
+
* building SWML call flows with fluent chaining.
|
|
6
|
+
* Run: npx tsx examples/verb-methods.ts
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
import { AgentBase, SwmlBuilder } from '@signalwire/sdk';
|
|
10
|
+
|
|
11
|
+
export const agent = new AgentBase({
|
|
12
|
+
name: 'verb-demo',
|
|
13
|
+
route: '/',
|
|
14
|
+
basicAuth: [
|
|
15
|
+
process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
|
|
16
|
+
process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
|
|
17
|
+
],
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
agent.setPromptText('You are a helpful assistant.');
|
|
21
|
+
agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
|
|
22
|
+
|
|
23
|
+
// Use SwmlBuilder verb methods to control the call flow
|
|
24
|
+
// Phase 1: Pre-answer — play ringing
|
|
25
|
+
agent.addPreAnswerVerb('play', { urls: ['ring:us'], auto_answer: false });
|
|
26
|
+
|
|
27
|
+
// Phase 3: Post-answer — play a welcome message, then a short pause
|
|
28
|
+
agent.addPostAnswerVerb('play', {
|
|
29
|
+
url: 'say:Welcome! Please hold while I connect you.',
|
|
30
|
+
});
|
|
31
|
+
agent.addPostAnswerVerb('sleep', 1);
|
|
32
|
+
|
|
33
|
+
// Phase 5: Post-AI — hangup after the AI conversation
|
|
34
|
+
agent.addPostAiVerb('hangup', {});
|
|
35
|
+
|
|
36
|
+
// You can also build standalone SWML documents with SwmlBuilder directly:
|
|
37
|
+
const ivr = new SwmlBuilder();
|
|
38
|
+
ivr.addVerb('answer', { max_duration: 300 });
|
|
39
|
+
ivr.addVerb('play', { url: 'say:Hello from the SWML builder!' });
|
|
40
|
+
ivr.addVerb('sleep', 2);
|
|
41
|
+
ivr.addVerb('hangup', {});
|
|
42
|
+
|
|
43
|
+
console.log('Standalone SWML:', JSON.stringify(ivr.build(), null, 2));
|
|
44
|
+
|
|
45
|
+
agent.serve();
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Web Search Multiple Instance Demo
|
|
3
|
+
*
|
|
4
|
+
* Loads the web search skill multiple times with different configurations and
|
|
5
|
+
* custom tool names (general search, news search, quick search).
|
|
6
|
+
*
|
|
7
|
+
* Requires GOOGLE_SEARCH_API_KEY and GOOGLE_SEARCH_CX environment variables.
|
|
8
|
+
* Run: npx tsx examples/web-search-multi-instance.ts
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
import {
|
|
12
|
+
AgentBase,
|
|
13
|
+
WebSearchSkill,
|
|
14
|
+
WikipediaSearchSkill,
|
|
15
|
+
DateTimeSkill,
|
|
16
|
+
MathSkill,
|
|
17
|
+
} from '@signalwire/sdk';
|
|
18
|
+
|
|
19
|
+
export const agent = new AgentBase({
|
|
20
|
+
name: 'multi-search',
|
|
21
|
+
route: '/',
|
|
22
|
+
basicAuth: [
|
|
23
|
+
process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
|
|
24
|
+
process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
|
|
25
|
+
],
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
agent.setPromptText(
|
|
29
|
+
'You are a research assistant with access to multiple search tools. ' +
|
|
30
|
+
'Use the most appropriate search tool for each query: ' +
|
|
31
|
+
'general web search, news search, quick search, or Wikipedia.',
|
|
32
|
+
);
|
|
33
|
+
|
|
34
|
+
agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
|
|
35
|
+
agent.addHints(['search', 'look up', 'find', 'news', 'Wikipedia']);
|
|
36
|
+
|
|
37
|
+
// Utility skills
|
|
38
|
+
await agent.addSkill(new DateTimeSkill());
|
|
39
|
+
await agent.addSkill(new MathSkill());
|
|
40
|
+
|
|
41
|
+
// Wikipedia search
|
|
42
|
+
await agent.addSkill(new WikipediaSearchSkill({ max_results: 2 }));
|
|
43
|
+
|
|
44
|
+
// Instance 1: General web search (default tool name)
|
|
45
|
+
await agent.addSkill(
|
|
46
|
+
new WebSearchSkill({
|
|
47
|
+
max_results: 3,
|
|
48
|
+
safe_search: 'medium',
|
|
49
|
+
}),
|
|
50
|
+
);
|
|
51
|
+
|
|
52
|
+
// Instance 2: News-focused search
|
|
53
|
+
await agent.addSkill(
|
|
54
|
+
new WebSearchSkill({
|
|
55
|
+
tool_name: 'search_news',
|
|
56
|
+
max_results: 5,
|
|
57
|
+
safe_search: 'medium',
|
|
58
|
+
}),
|
|
59
|
+
);
|
|
60
|
+
|
|
61
|
+
// Instance 3: Quick single-result search
|
|
62
|
+
await agent.addSkill(
|
|
63
|
+
new WebSearchSkill({
|
|
64
|
+
tool_name: 'quick_search',
|
|
65
|
+
max_results: 1,
|
|
66
|
+
}),
|
|
67
|
+
);
|
|
68
|
+
|
|
69
|
+
console.log(
|
|
70
|
+
'Loaded skills:',
|
|
71
|
+
agent.listSkills().map((s) => s.name),
|
|
72
|
+
);
|
|
73
|
+
console.log('Search tools: web_search (general), search_news, quick_search, search_wiki');
|
|
74
|
+
|
|
75
|
+
agent.serve();
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Web Search Skill Example
|
|
3
|
+
*
|
|
4
|
+
* Agent with the web search skill for looking up current information.
|
|
5
|
+
* Requires GOOGLE_SEARCH_API_KEY and GOOGLE_SEARCH_CX environment variables.
|
|
6
|
+
* Run: npx tsx examples/web-search.ts
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
import { AgentBase, WebSearchSkill } from '@signalwire/sdk';
|
|
10
|
+
|
|
11
|
+
export const agent = new AgentBase({
|
|
12
|
+
name: 'search-agent',
|
|
13
|
+
route: '/',
|
|
14
|
+
basicAuth: [
|
|
15
|
+
process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
|
|
16
|
+
process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
|
|
17
|
+
],
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
agent.setPromptText(
|
|
21
|
+
'You are a research assistant with access to web search. ' +
|
|
22
|
+
'When the user asks about current events, facts, or anything you are not sure about, ' +
|
|
23
|
+
'use the web_search tool to find up-to-date information. ' +
|
|
24
|
+
'Summarize search results concisely.',
|
|
25
|
+
);
|
|
26
|
+
|
|
27
|
+
// Add web search skill with custom configuration
|
|
28
|
+
await agent.addSkill(
|
|
29
|
+
new WebSearchSkill({
|
|
30
|
+
max_results: 5,
|
|
31
|
+
safe_search: 'medium',
|
|
32
|
+
}),
|
|
33
|
+
);
|
|
34
|
+
|
|
35
|
+
agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
|
|
36
|
+
agent.addHints(['search', 'look up', 'find out', 'Google']);
|
|
37
|
+
|
|
38
|
+
agent.serve();
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Wikipedia Skill Example
|
|
3
|
+
*
|
|
4
|
+
* Agent with the Wikipedia search skill for encyclopedic knowledge.
|
|
5
|
+
* No API key required — uses the public Wikipedia REST API.
|
|
6
|
+
* Run: npx tsx examples/wikipedia.ts
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
import { AgentBase, WikipediaSearchSkill, DateTimeSkill } from '@signalwire/sdk';
|
|
10
|
+
|
|
11
|
+
export const agent = new AgentBase({
|
|
12
|
+
name: 'wiki-agent',
|
|
13
|
+
route: '/',
|
|
14
|
+
basicAuth: [
|
|
15
|
+
process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
|
|
16
|
+
process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
|
|
17
|
+
],
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
agent.setPromptText(
|
|
21
|
+
'You are a knowledgeable assistant with access to Wikipedia. ' +
|
|
22
|
+
'When the user asks about a topic, person, place, or concept, ' +
|
|
23
|
+
'search Wikipedia to provide accurate encyclopedic information. ' +
|
|
24
|
+
'Summarize the information naturally rather than reading it verbatim.',
|
|
25
|
+
);
|
|
26
|
+
|
|
27
|
+
// Add Wikipedia search skill — no API key needed
|
|
28
|
+
await agent.addSkill(new WikipediaSearchSkill());
|
|
29
|
+
|
|
30
|
+
// Also add datetime for general utility
|
|
31
|
+
await agent.addSkill(new DateTimeSkill());
|
|
32
|
+
|
|
33
|
+
agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
|
|
34
|
+
agent.addHints(['Wikipedia', 'encyclopedia', 'article']);
|
|
35
|
+
|
|
36
|
+
agent.serve();
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
# LiveWire: LiveKit-Compatible Agents on SignalWire
|
|
2
|
+
|
|
3
|
+
`runApp()` prints this banner when a LiveWire app starts:
|
|
4
|
+
|
|
5
|
+
```text
|
|
6
|
+
__ _ _ ___
|
|
7
|
+
/ / (_) _____ | | / (_)_______
|
|
8
|
+
/ / / / | / / _ \ | | /| / / / ___/ _ \
|
|
9
|
+
/ /___/ /| |/ / __/ | |/ |/ / / / / __/
|
|
10
|
+
/_____/_/ |___/\___/ |__/|__/_/_/ \___/
|
|
11
|
+
|
|
12
|
+
LiveKit-compatible agents powered by SignalWire
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
LiveWire lets you run agents written against the LiveKit agents API (`@livekit/agents`) on SignalWire. It provides the same class and function names, so you change the import path and keep your agent code. SignalWire runs speech recognition, text-to-speech, voice activity detection and the LLM. Under the hood, each LiveWire session builds a SignalWire `AgentBase`.
|
|
16
|
+
|
|
17
|
+
## Quick Start
|
|
18
|
+
|
|
19
|
+
This example defines a weather tool and an agent, then starts the app with `runApp()`, which serves the agent over HTTP on port 3000 (or `PORT`):
|
|
20
|
+
|
|
21
|
+
<!-- snippet: no-run imports the @signalwire/sdk/livewire subpath, which resolves only from the built+installed package, not from the source tree -->
|
|
22
|
+
```typescript
|
|
23
|
+
import {
|
|
24
|
+
Agent, AgentSession, tool,
|
|
25
|
+
defineAgent, JobContext, runApp,
|
|
26
|
+
} from '@signalwire/sdk/livewire';
|
|
27
|
+
|
|
28
|
+
const getWeather = tool({
|
|
29
|
+
description: 'Get weather for a location',
|
|
30
|
+
parameters: {
|
|
31
|
+
type: 'object',
|
|
32
|
+
properties: {
|
|
33
|
+
location: { type: 'string', description: 'City name' },
|
|
34
|
+
},
|
|
35
|
+
required: ['location'],
|
|
36
|
+
},
|
|
37
|
+
execute: (params: { location: string }) => {
|
|
38
|
+
return `The weather in ${params.location} is sunny, 72F with clear skies.`;
|
|
39
|
+
},
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
const agentDef = defineAgent({
|
|
43
|
+
entry: async (ctx: JobContext) => {
|
|
44
|
+
await ctx.connect();
|
|
45
|
+
|
|
46
|
+
const session = new AgentSession({
|
|
47
|
+
stt: 'deepgram',
|
|
48
|
+
llm: 'openai/gpt-4o',
|
|
49
|
+
tts: 'elevenlabs',
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
const agent = new Agent({
|
|
53
|
+
instructions: 'You are a helpful weather assistant.',
|
|
54
|
+
tools: { get_weather: getWeather },
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
await session.start({ agent });
|
|
58
|
+
session.generateReply({ instructions: 'Greet the user and ask how you can help.' });
|
|
59
|
+
},
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
runApp(agentDef);
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
`tools` is an object keyed by tool name, as in LiveKit agents-js, and each key becomes the name of a SWAIG function. `tools` also takes an array, as the Python SDK does; each tool in the array needs a `name`, which `tool()` leaves empty, so set it: `tools: [{ ...getWeather, name: 'get_weather' }]`. The `@signalwire/sdk/livewire` subpath exports the same names as the `livewire` namespace of `@signalwire/sdk`.
|
|
66
|
+
|
|
67
|
+
## Why LiveWire
|
|
68
|
+
|
|
69
|
+
A LiveKit agent configures its own STT, TTS, VAD and LLM providers, and each is a service you run or pay for separately. LiveWire keeps the same developer-facing API, and SignalWire's control plane runs the media pipeline:
|
|
70
|
+
|
|
71
|
+
- **STT**: speech recognition runs on SignalWire.
|
|
72
|
+
- **TTS**: text-to-speech runs on SignalWire.
|
|
73
|
+
- **VAD**: voice activity detection needs no configuration.
|
|
74
|
+
- **LLM**: the platform runs the model; the `llm` option picks it.
|
|
75
|
+
- **Call control**: barge-in, hold, transfer and conferencing are platform features.
|
|
76
|
+
|
|
77
|
+
## Feature Mapping
|
|
78
|
+
|
|
79
|
+
The table maps each LiveKit concept to what LiveWire does with it:
|
|
80
|
+
|
|
81
|
+
| LiveKit Concept | LiveWire | Notes |
|
|
82
|
+
|---|---|---|
|
|
83
|
+
| `voice.Agent` | `Agent` | `instructions` becomes the prompt; `tools` become SWAIG functions |
|
|
84
|
+
| `voice.AgentSession` | `AgentSession` | `start()` builds a SignalWire `AgentBase` |
|
|
85
|
+
| `llm.tool()` | `tool()` | Registered as a SWAIG function when the session starts |
|
|
86
|
+
| `llm.handoff()` | `handoff()` | Returns an `AgentHandoff`; LiveWire doesn't act on it |
|
|
87
|
+
| `RunContext` | `RunContext` | Passed to tool handlers as `context.ctx` |
|
|
88
|
+
| `defineAgent()` | `defineAgent()` | Returns the `{ entry, prewarm }` object unchanged |
|
|
89
|
+
| `cli.runApp()` | `runApp()` | Prints a banner and a tip, runs prewarm, calls the entry function, then serves the agent of the session it started |
|
|
90
|
+
| `stt: 'deepgram'` | Ignored (logged once) | The platform handles STT |
|
|
91
|
+
| `tts: 'elevenlabs'` | Ignored (logged once) | The platform handles TTS |
|
|
92
|
+
| `vad: plugins.SileroVAD.load()` | Ignored (logged once) | The platform handles VAD |
|
|
93
|
+
| `llm: 'openai/gpt-4o'` | Sets the `model` AI param | The `openai/` prefix is removed. An LLM plugin object sets it from its `model` |
|
|
94
|
+
| `allowInterruptions: false` | Sets the `enable_barge` AI param to `false` | The caller can't interrupt the AI |
|
|
95
|
+
| `minEndpointingDelay` / `maxEndpointingDelay` | Set `end_of_speech_timeout` / `attention_timeout` | Seconds, converted to milliseconds; defaults 0.5 and 3.0 |
|
|
96
|
+
| `AgentSession.interrupt()` | Does nothing (logged once) | The platform handles barge-in |
|
|
97
|
+
| `JobContext.connect()` | Does nothing (logged once) | The platform connects when it requests the agent's SWML |
|
|
98
|
+
| `prewarm` | Runs (logged once) | There are no worker processes to prewarm |
|
|
99
|
+
| `StopResponse`, `ToolError` | Exported | Thrown from a tool, each gets the SDK's generic tool error response |
|
|
100
|
+
|
|
101
|
+
## What LiveWire Ignores
|
|
102
|
+
|
|
103
|
+
Several LiveKit options have no effect on SignalWire, because the platform handles what they configure:
|
|
104
|
+
|
|
105
|
+
- **STT, TTS and VAD providers**: SignalWire's control plane runs the speech pipeline. `stt: 'deepgram'` is accepted and ignored.
|
|
106
|
+
- **`JobContext.connect()`**: SignalWire connects when the platform requests the agent's SWML. There's no separate connection step.
|
|
107
|
+
- **Worker prewarming**: SignalWire manages the media infrastructure. The `prewarm` callback still runs.
|
|
108
|
+
- **`interrupt()`**: SignalWire handles barge-in, when the caller speaks over the agent.
|
|
109
|
+
|
|
110
|
+
Each ignored option logs a message to stderr the first time it's used, so you can see which settings had no effect.
|
|
111
|
+
|
|
112
|
+
Some LiveKit behaviors aren't implemented. LiveWire doesn't call the `onEnter()`, `onExit()` or `onUserTurnCompleted()` hooks. `session.history` stays empty. `session.say()` and `generateReply()` add text to the prompt; they don't make the agent speak it word for word. `tool()` doesn't convert a Zod schema, so pass JSON Schema as `parameters`.
|
|
113
|
+
|
|
114
|
+
## Plugin Stubs
|
|
115
|
+
|
|
116
|
+
LiveWire includes stub classes for common LiveKit plugin providers:
|
|
117
|
+
|
|
118
|
+
- `plugins.DeepgramSTT`: STT stub
|
|
119
|
+
- `plugins.ElevenLabsTTS`: TTS stub
|
|
120
|
+
- `plugins.CartesiaTTS`: TTS stub
|
|
121
|
+
- `plugins.OpenAILLM`: LLM stub
|
|
122
|
+
- `plugins.SileroVAD`: VAD stub
|
|
123
|
+
|
|
124
|
+
These exist so that LiveKit code that creates provider instances still compiles. The STT, TTS and VAD stubs have no effect at runtime. A `plugins.OpenAILLM` instance passed as the `llm` option sets the `model` AI param from its `model` option, so `llm: new plugins.OpenAILLM({ model: 'gpt-4o' })` and `llm: 'openai/gpt-4o'` do the same thing.
|
|
125
|
+
|
|
126
|
+
## Inference Stubs
|
|
127
|
+
|
|
128
|
+
LiveWire also includes stubs for LiveKit's `inference` classes. Each one stores the model name you pass and runs nothing. An `inference.LLM` passed as the `llm` option sets the `model` AI param from that name:
|
|
129
|
+
|
|
130
|
+
- `inference.STT`: STT model stub
|
|
131
|
+
- `inference.LLM`: LLM model stub
|
|
132
|
+
- `inference.TTS`: TTS model stub
|
|
133
|
+
|
|
134
|
+
## Documentation
|
|
135
|
+
|
|
136
|
+
The [Migration Guide](docs/migration-guide.md) moves a LiveKit agent to LiveWire step by step. The implementation is in `src/livewire/index.ts` in the SDK repository.
|
|
137
|
+
|
|
138
|
+
## Examples
|
|
139
|
+
|
|
140
|
+
These examples are in the repository:
|
|
141
|
+
|
|
142
|
+
- [livewire-basic-agent.ts](examples/livewire-basic-agent.ts): an agent with a single tool
|
|
143
|
+
- [livewire-multi-tool.ts](examples/livewire-multi-tool.ts): an agent with several function tools and `RunContext`
|
|
144
|
+
- [livewire-handoff.ts](examples/livewire-handoff.ts): several agents and handoff tools
|
|
145
|
+
|
|
146
|
+
## Running the Agent
|
|
147
|
+
|
|
148
|
+
`runApp()` calls the entry function. When the entry function returns, `runApp()` serves the SignalWire `AgentBase` built by the last `session.start()` the entry function called, and the HTTP server runs until the process exits. If the entry function starts no session, `runApp()` writes a message to stderr and serves nothing. Under the `swaig-test` CLI (`SWAIG_CLI_MODE=true`), it serves nothing, so the CLI can list and run the agent's tools:
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
npx swaig-test my-livewire-agent.ts --list-tools
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
A session started outside `runApp()` isn't served. Call `session.getSwAgent()` for its `AgentBase`, and serve that yourself.
|
|
155
|
+
|
|
156
|
+
## Environment Variables
|
|
157
|
+
|
|
158
|
+
A LiveWire session builds a SignalWire `AgentBase` named `LiveWireAgent`, with the route `/`. It reads the same environment variables as any SignalWire agent. These are the common ones:
|
|
159
|
+
|
|
160
|
+
| Variable | Description |
|
|
161
|
+
|----------|-------------|
|
|
162
|
+
| `SWML_BASIC_AUTH_USER` | HTTP Basic Auth username. Defaults to the agent name, `LiveWireAgent`. |
|
|
163
|
+
| `SWML_BASIC_AUTH_PASSWORD` | HTTP Basic Auth password. If unset, the SDK generates a random password for the process and logs a warning. |
|
|
164
|
+
| `PORT` | HTTP server port (default: 3000) |
|