@signalwire/sdk 2.0.5 → 3.6.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 +821 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +510 -126
- package/dist/AgentBase.js +1581 -455
- 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 +186 -45
- package/dist/DataMap.js +210 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +309 -83
- package/dist/FunctionResult.js +483 -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 +12 -1
- package/dist/POM/PromptObjectModel.js +25 -9
- package/dist/POM/PromptObjectModel.js.map +1 -1
- 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 +18 -0
- package/dist/PomBuilder.js +53 -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 +22 -1
- package/dist/PromptManager.js +28 -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 +169 -59
- package/dist/SWMLService.js +456 -129
- 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 +49 -9
- package/dist/SecurityUtils.js +153 -51
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/SemanticGate.d.ts +183 -0
- package/dist/SemanticGate.js +533 -0
- package/dist/SemanticGate.js.map +1 -0
- 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 +139 -7
- package/dist/SwaigFunction.js +170 -22
- 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 +92 -33
- 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 -371
- 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 +920 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +49 -68
- package/dist/index.js +45 -73
- 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 +44 -17
- package/dist/relay/RelayClient.js +175 -65
- 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 +73 -42
- 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 +5 -2
- package/dist/rest/callHandler.js +4 -1
- package/dist/rest/callHandler.js.map +1 -1
- package/dist/rest/index.d.ts +18 -77
- package/dist/rest/index.js +47 -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 -327
- package/dist/rest/namespaces/fabric.js +14 -439
- 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 +8 -196
- package/dist/rest/namespaces/phone-numbers.js +8 -230
- 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 +111 -21
- 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 +22 -11
- package/dist/skills/SkillRegistry.js +47 -17
- 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 +18 -6
- 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 +21 -22
- 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 +42 -4
- package/dist/skills/builtin/spider.js +277 -104
- 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 +38 -30
- 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 +294 -100
- 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 +14 -13
- 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 +59 -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 +3641 -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 +1207 -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 +1986 -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 +85 -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,399 @@
|
|
|
1
|
+
# SignalWire AI Agents - Cloud Functions Deployment Guide
|
|
2
|
+
|
|
3
|
+
This guide covers deploying SignalWire AI Agents (TypeScript SDK) to Google Cloud Functions and Azure Functions. For the full serverless reference, including AWS Lambda and CGI, see the [Serverless Guide](serverless-guide.md).
|
|
4
|
+
|
|
5
|
+
<!-- snippet-setup -->
|
|
6
|
+
```ts
|
|
7
|
+
export {}; // treat each example as a module (top-level await)
|
|
8
|
+
declare global {
|
|
9
|
+
const MyAgent: any; // the AgentBase subclass defined in the entry-file example
|
|
10
|
+
}
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Overview
|
|
14
|
+
|
|
15
|
+
The SDK runs on these serverless platforms, each with its identifier:
|
|
16
|
+
|
|
17
|
+
- **Google Cloud Functions** (`gcf`)
|
|
18
|
+
- **Azure Functions** (`azure`)
|
|
19
|
+
- **AWS Lambda** (`lambda`, see the [Serverless Guide](serverless-guide.md))
|
|
20
|
+
|
|
21
|
+
Each platform has a static helper on `ServerlessAdapter` that wraps the agent's Hono app in the platform's handler shape. You can also call `agent.runServerless(event, context, platform)` with a Lambda-style event.
|
|
22
|
+
|
|
23
|
+
Build the agent once, at module scope, so warm invocations reuse it. Set its basic auth credentials: a password the SDK generates changes with every cold start, and SignalWire can't use it.
|
|
24
|
+
|
|
25
|
+
## Google Cloud Functions
|
|
26
|
+
|
|
27
|
+
### Environment Detection
|
|
28
|
+
|
|
29
|
+
The SDK detects Google Cloud Functions from these environment variables:
|
|
30
|
+
|
|
31
|
+
- `FUNCTION_TARGET`: the function's entry point
|
|
32
|
+
- `K_SERVICE`: the service name, which Cloud Run also sets
|
|
33
|
+
- `GOOGLE_CLOUD_PROJECT`: the project ID, which `getExecutionMode()` also checks
|
|
34
|
+
|
|
35
|
+
Cloud Run sets `K_SERVICE` but not `FUNCTION_TARGET`, so `run()` starts the agent's HTTP server there. On Cloud Functions, the Functions Framework sets `FUNCTION_TARGET`, and `run()` handles the request instead.
|
|
36
|
+
|
|
37
|
+
### Deployment Steps
|
|
38
|
+
|
|
39
|
+
1. **Create your agent entry file** (`index.ts`). It builds the agent and exports the handler:
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
import { AgentBase, ServerlessAdapter } from '@signalwire/sdk';
|
|
43
|
+
|
|
44
|
+
class MyAgent extends AgentBase {
|
|
45
|
+
constructor() {
|
|
46
|
+
super({
|
|
47
|
+
name: 'my-agent',
|
|
48
|
+
basicAuth: [process.env.AGENT_USER ?? 'admin', process.env.AGENT_PASSWORD ?? 'a-long-random-password'],
|
|
49
|
+
});
|
|
50
|
+
this.setPromptText('You are a helpful assistant.');
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
const agent = new MyAgent();
|
|
55
|
+
|
|
56
|
+
// HTTP Cloud Function entry point (Functions Framework)
|
|
57
|
+
export const agentHandler = ServerlessAdapter.createGcfHandler(agent.getApp());
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
2. **Add the dependencies** to `package.json`:
|
|
61
|
+
|
|
62
|
+
```json
|
|
63
|
+
{
|
|
64
|
+
"type": "module",
|
|
65
|
+
"engines": { "node": ">=22" },
|
|
66
|
+
"dependencies": {
|
|
67
|
+
"@google-cloud/functions-framework": "^3",
|
|
68
|
+
"@signalwire/sdk": "^3"
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
3. **Deploy using gcloud** with the Node.js 22 runtime:
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
gcloud functions deploy my-agent \
|
|
77
|
+
--runtime nodejs22 \
|
|
78
|
+
--trigger-http \
|
|
79
|
+
--entry-point agentHandler \
|
|
80
|
+
--allow-unauthenticated
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
`--allow-unauthenticated` lets SignalWire reach the function without Google credentials. The agent's basic auth still applies.
|
|
84
|
+
|
|
85
|
+
### Environment Variables
|
|
86
|
+
|
|
87
|
+
Set these variables for the function:
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
# Agent auth
|
|
91
|
+
SWML_BASIC_AUTH_USER="your-username"
|
|
92
|
+
SWML_BASIC_AUTH_PASSWORD="a-long-random-password"
|
|
93
|
+
|
|
94
|
+
# Check SignalWire's signatures on incoming requests
|
|
95
|
+
SIGNALWIRE_SIGNING_KEY="your-signing-key"
|
|
96
|
+
|
|
97
|
+
# The same secret on every instance, so tool tokens validate on any of them
|
|
98
|
+
SIGNALWIRE_SWAIG_SECRET="a-long-random-secret"
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
The example's constructor reads its own `AGENT_USER` and `AGENT_PASSWORD`, and a `basicAuth` option wins over `SWML_BASIC_AUTH_USER` and `SWML_BASIC_AUTH_PASSWORD`. Use one pair or the other. Set `SIGNALWIRE_PROJECT_ID` and `SIGNALWIRE_API_TOKEN` only if your tool handlers use the REST client.
|
|
102
|
+
|
|
103
|
+
### Webhook URLs
|
|
104
|
+
|
|
105
|
+
The agent builds its webhook URLs from the request's host. A `cloudfunctions.net` host gets the function's name (`K_SERVICE`, or `FUNCTION_TARGET`) added, so the URL follows this pattern:
|
|
106
|
+
|
|
107
|
+
```text
|
|
108
|
+
https://{region}-{project-id}.cloudfunctions.net/{function-name}/swaig
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Any other host, such as a Cloud Run URL, is used as it is. `FUNCTION_URL`, when set, replaces the host-based URL, and `SWML_PROXY_URL_BASE` replaces both. The agent puts its basic auth credentials in the URL:
|
|
112
|
+
|
|
113
|
+
```text
|
|
114
|
+
https://username:password@{region}-{project-id}.cloudfunctions.net/{function-name}/swaig
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
## Azure Functions
|
|
118
|
+
|
|
119
|
+
### Environment Detection
|
|
120
|
+
|
|
121
|
+
The SDK detects Azure Functions from these environment variables:
|
|
122
|
+
|
|
123
|
+
- `FUNCTIONS_WORKER_RUNTIME`: the runtime language, such as `node`
|
|
124
|
+
- `AZURE_FUNCTIONS_ENVIRONMENT`: the Azure Functions environment
|
|
125
|
+
|
|
126
|
+
### Programming Model
|
|
127
|
+
|
|
128
|
+
`ServerlessAdapter.createAzureHandler()` returns a handler with the programming model v3 signature, `(context, req)`, which sets `context.res`. The v4 model's `app.http()` calls a handler with `(request, context)` and expects a returned response, so the handler doesn't fit it. Deploy the agent with the v3 model and a `function.json` file.
|
|
129
|
+
|
|
130
|
+
### Deployment Steps
|
|
131
|
+
|
|
132
|
+
1. **Create your function entry file** (`agent/index.ts`). It builds the agent and exports the handler:
|
|
133
|
+
|
|
134
|
+
```typescript
|
|
135
|
+
import { AgentBase, ServerlessAdapter } from '@signalwire/sdk';
|
|
136
|
+
|
|
137
|
+
class MyAgent extends AgentBase {
|
|
138
|
+
constructor() {
|
|
139
|
+
super({
|
|
140
|
+
name: 'my-agent',
|
|
141
|
+
basicAuth: [process.env.AGENT_USER ?? 'admin', process.env.AGENT_PASSWORD ?? 'a-long-random-password'],
|
|
142
|
+
});
|
|
143
|
+
this.setPromptText('You are a helpful assistant.');
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
const agent = new MyAgent();
|
|
148
|
+
|
|
149
|
+
export default ServerlessAdapter.createAzureHandler(agent.getApp());
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
2. **Create `agent/function.json`**. The catch-all route lets the one function receive `/api/agent`, `/api/agent/swaig` and `/api/agent/post_prompt`:
|
|
153
|
+
|
|
154
|
+
```json
|
|
155
|
+
{
|
|
156
|
+
"bindings": [
|
|
157
|
+
{
|
|
158
|
+
"authLevel": "anonymous",
|
|
159
|
+
"type": "httpTrigger",
|
|
160
|
+
"direction": "in",
|
|
161
|
+
"name": "req",
|
|
162
|
+
"methods": ["get", "post"],
|
|
163
|
+
"route": "agent/{*path}"
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
"type": "http",
|
|
167
|
+
"direction": "out",
|
|
168
|
+
"name": "res"
|
|
169
|
+
}
|
|
170
|
+
]
|
|
171
|
+
}
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
3. **Add the dependency** to `package.json`:
|
|
175
|
+
|
|
176
|
+
```json
|
|
177
|
+
{
|
|
178
|
+
"type": "module",
|
|
179
|
+
"engines": { "node": ">=22" },
|
|
180
|
+
"dependencies": {
|
|
181
|
+
"@signalwire/sdk": "^3"
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
4. **Deploy using the Azure CLI**:
|
|
187
|
+
|
|
188
|
+
```bash
|
|
189
|
+
# Create function app (Node.js 22)
|
|
190
|
+
az functionapp create \
|
|
191
|
+
--resource-group myResourceGroup \
|
|
192
|
+
--consumption-plan-location westus \
|
|
193
|
+
--runtime node \
|
|
194
|
+
--runtime-version 22 \
|
|
195
|
+
--functions-version 4 \
|
|
196
|
+
--name my-agent-function \
|
|
197
|
+
--storage-account mystorageaccount
|
|
198
|
+
|
|
199
|
+
# Deploy code
|
|
200
|
+
func azure functionapp publish my-agent-function
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### Environment Variables
|
|
204
|
+
|
|
205
|
+
Set the same variables as for Google Cloud Functions in your Function App settings:
|
|
206
|
+
|
|
207
|
+
```bash
|
|
208
|
+
SWML_BASIC_AUTH_USER="your-username"
|
|
209
|
+
SWML_BASIC_AUTH_PASSWORD="a-long-random-password"
|
|
210
|
+
SIGNALWIRE_SIGNING_KEY="your-signing-key"
|
|
211
|
+
SIGNALWIRE_SWAIG_SECRET="a-long-random-secret"
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
### Webhook URLs
|
|
215
|
+
|
|
216
|
+
The agent builds its webhook URLs from the URL of the request it's answering, up to `/api/<function>`:
|
|
217
|
+
|
|
218
|
+
```text
|
|
219
|
+
https://{function-app-name}.azurewebsites.net/api/{function-name}/swaig
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
Before the first request, it uses `AZURE_FUNCTION_URL`, or `https://<WEBSITE_SITE_NAME>.azurewebsites.net/api/<AZURE_FUNCTION_NAME>`. `SWML_PROXY_URL_BASE` replaces all of these. The agent puts its basic auth credentials in the URL:
|
|
223
|
+
|
|
224
|
+
```text
|
|
225
|
+
https://username:password@{function-app-name}.azurewebsites.net/api/{function-name}/swaig
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
## Authentication
|
|
229
|
+
|
|
230
|
+
Both platforms use the agent's HTTP basic auth. The credentials come from the constructor's `basicAuth` option, or from `SWML_BASIC_AUTH_USER` and `SWML_BASIC_AUTH_PASSWORD`:
|
|
231
|
+
|
|
232
|
+
<!-- snippet: no-run illustrative fragment: references the assumed `MyAgent` from the page prelude (declared type-only in the shared snippet-setup), not a standalone program -->
|
|
233
|
+
```typescript
|
|
234
|
+
const agent = new MyAgent(); // uses its basicAuth option, or SWML_BASIC_AUTH_USER and SWML_BASIC_AUTH_PASSWORD
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
### Authentication Flow
|
|
238
|
+
|
|
239
|
+
The agent handles each request in these steps:
|
|
240
|
+
|
|
241
|
+
1. The client sends a request with an `Authorization: Basic <credentials>` header.
|
|
242
|
+
2. The agent compares the credentials with its configured username and password.
|
|
243
|
+
3. If they don't match, it returns `401` with `WWW-Authenticate: Basic realm="Secure Area"` and `{"error":"Unauthorized"}`.
|
|
244
|
+
4. If a signing key is set, a POST to the SWML, `/swaig` or `/post_prompt` route must also carry a valid SignalWire signature. Without one, it gets `403`.
|
|
245
|
+
5. Otherwise, it handles the request.
|
|
246
|
+
|
|
247
|
+
`/health` and `/ready` need no credentials.
|
|
248
|
+
|
|
249
|
+
### Signatures on Each Platform
|
|
250
|
+
|
|
251
|
+
With `SIGNALWIRE_SIGNING_KEY` set, the agent checks each POST's signature against the URL the platform received it on. On Google Cloud Functions, that's the webhook base URL, which includes the function's name, plus `req.originalUrl`. On Azure, it's `req.url`. If SignalWire's requests are refused with `403`, set `SWML_PROXY_URL_BASE` to the function's public URL. For more information, see [Webhook URLs and Signatures](serverless-guide.md#webhook-urls-and-signatures).
|
|
252
|
+
|
|
253
|
+
## Testing
|
|
254
|
+
|
|
255
|
+
### swaig-test CLI
|
|
256
|
+
|
|
257
|
+
`swaig-test` can run the agent file with each platform's environment before you deploy. These commands print the SWML, whose webhook URLs are the platform's, and call a function:
|
|
258
|
+
|
|
259
|
+
```bash
|
|
260
|
+
# Google Cloud Functions
|
|
261
|
+
npx tsx src/cli/swaig-test.ts index.ts --simulate-serverless gcf \
|
|
262
|
+
--gcp-function-url https://us-central1-my-project.cloudfunctions.net/my-agent --dump-swml
|
|
263
|
+
|
|
264
|
+
# Azure Functions
|
|
265
|
+
npx tsx src/cli/swaig-test.ts agent/index.ts --simulate-serverless azure \
|
|
266
|
+
--azure-function-url https://my-agent-function.azurewebsites.net/api/agent --dump-swml
|
|
267
|
+
|
|
268
|
+
# Call a function (swaig-test's options go before --exec)
|
|
269
|
+
npx tsx src/cli/swaig-test.ts index.ts --simulate-serverless gcf --exec my_function --param value
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
The Google options are `--gcp-project`, `--gcp-function-url`, `--gcp-region` and `--gcp-service`. The Azure options are `--azure-env` and `--azure-function-url`. `swaig-test` clears `SWML_PROXY_URL_BASE` for the run. See the [CLI Guide](cli-guide.md#serverless-simulation) for the full set of flags.
|
|
273
|
+
|
|
274
|
+
### Local Testing
|
|
275
|
+
|
|
276
|
+
Each platform has a local runtime.
|
|
277
|
+
|
|
278
|
+
**Google Cloud Functions:**
|
|
279
|
+
|
|
280
|
+
```bash
|
|
281
|
+
# Install the Functions Framework
|
|
282
|
+
npm install @google-cloud/functions-framework
|
|
283
|
+
|
|
284
|
+
# Run locally
|
|
285
|
+
npx functions-framework --target=agentHandler
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
**Azure Functions:**
|
|
289
|
+
|
|
290
|
+
```bash
|
|
291
|
+
# Install Azure Functions Core Tools
|
|
292
|
+
npm install -g azure-functions-core-tools@4
|
|
293
|
+
|
|
294
|
+
# Run locally
|
|
295
|
+
func start
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
### Testing Authentication
|
|
299
|
+
|
|
300
|
+
These requests check that the deployed function refuses a request without credentials and accepts one with them:
|
|
301
|
+
|
|
302
|
+
```bash
|
|
303
|
+
# Without credentials: 401
|
|
304
|
+
curl -i https://your-function-url/
|
|
305
|
+
|
|
306
|
+
# With credentials: the SWML document
|
|
307
|
+
curl -u username:password https://your-function-url/
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
A secure tool needs the token its call's SWML carries, so a hand-made call to `/swaig` must use the function's URL from the SWML. This script requests the SWML for a test call, takes the function's `web_hook_url`, and calls it with the same `call_id`:
|
|
311
|
+
|
|
312
|
+
```bash
|
|
313
|
+
URL=$(curl -s -u username:password "https://your-function-url/?call_id=test" | node -e '
|
|
314
|
+
let s = ""; process.stdin.on("data", (d) => (s += d)).on("end", () => {
|
|
315
|
+
const ai = JSON.parse(s).sections.main.find((v) => v.ai).ai;
|
|
316
|
+
console.log(ai.SWAIG.functions.find((f) => f.function === "your_function_name").web_hook_url);
|
|
317
|
+
});')
|
|
318
|
+
|
|
319
|
+
# The URL includes the credentials and the token
|
|
320
|
+
curl -H "Content-Type: application/json" \
|
|
321
|
+
-d '{"function": "your_function_name", "call_id": "test", "argument": {"parsed": [{"param": "value"}]}}' \
|
|
322
|
+
"$URL"
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
With a signing key set, every POST also needs SignalWire's signature, so these hand-made POSTs are refused. Test functions with `swaig-test`, which signs its requests, or through SignalWire.
|
|
326
|
+
|
|
327
|
+
## Best Practices
|
|
328
|
+
|
|
329
|
+
### Performance
|
|
330
|
+
|
|
331
|
+
These practices reduce cold starts and repeated work:
|
|
332
|
+
|
|
333
|
+
- Keep deployment packages small to shorten cold starts.
|
|
334
|
+
- Construct the agent at module scope, not per request.
|
|
335
|
+
- Cache data your handlers fetch, where it's safe to.
|
|
336
|
+
|
|
337
|
+
### Security
|
|
338
|
+
|
|
339
|
+
These settings protect a deployed function:
|
|
340
|
+
|
|
341
|
+
- Use the platform's HTTPS URL, and don't expose the function over plain HTTP.
|
|
342
|
+
- Keep secrets in environment variables or the platform's secret manager.
|
|
343
|
+
- Set explicit basic auth credentials.
|
|
344
|
+
- Set `SIGNALWIRE_SIGNING_KEY` so the agent checks SignalWire's signatures.
|
|
345
|
+
- Set `SIGNALWIRE_SWAIG_SECRET` to the same value on every instance, so tool tokens validate on any of them. See [Security](security.md#the-signing-secret).
|
|
346
|
+
|
|
347
|
+
### Monitoring
|
|
348
|
+
|
|
349
|
+
Use the platform's tools to watch the function:
|
|
350
|
+
|
|
351
|
+
- Turn on the platform's logging.
|
|
352
|
+
- Monitor execution times, and set alerts for errors and timeouts.
|
|
353
|
+
|
|
354
|
+
## Troubleshooting
|
|
355
|
+
|
|
356
|
+
### Environment Detection
|
|
357
|
+
|
|
358
|
+
`getExecutionMode()` returns the environment the SDK detected, as a string: `cgi`, `lambda`, `google_cloud_function`, `azure_function` or `server`:
|
|
359
|
+
|
|
360
|
+
```typescript
|
|
361
|
+
import { getExecutionMode } from '@signalwire/sdk';
|
|
362
|
+
|
|
363
|
+
console.log(`Detected mode: ${getExecutionMode()}`);
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
### URL Generation
|
|
367
|
+
|
|
368
|
+
`getFullUrl()` returns the base URL the agent uses for its webhooks, and `getFullUrl(true)` includes the credentials. On Azure and on Google hosts, the URL comes from the request, so the value can change after the first request:
|
|
369
|
+
|
|
370
|
+
<!-- snippet: no-run illustrative fragment: references the assumed `MyAgent` from the page prelude (declared type-only in the shared snippet-setup), not a standalone program -->
|
|
371
|
+
```typescript
|
|
372
|
+
const agent = new MyAgent();
|
|
373
|
+
console.log(`Base URL: ${agent.getFullUrl()}`);
|
|
374
|
+
console.log(`Auth URL: ${agent.getFullUrl(true)}`);
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
### Authentication Issues
|
|
378
|
+
|
|
379
|
+
If requests get `401`, check these items:
|
|
380
|
+
|
|
381
|
+
- The username and password are set, and match exactly (they're case-sensitive).
|
|
382
|
+
- The client sends the `Authorization` header.
|
|
383
|
+
- A `basicAuth` option in the code isn't overriding the environment variables you set.
|
|
384
|
+
|
|
385
|
+
### Signature Issues
|
|
386
|
+
|
|
387
|
+
If requests get `403`, the signature check failed. Check that `SIGNALWIRE_SIGNING_KEY` is your space's signing key, and set `SWML_PROXY_URL_BASE` to the function's public URL if the platform's URL differs from the one SignalWire called.
|
|
388
|
+
|
|
389
|
+
### Debugging
|
|
390
|
+
|
|
391
|
+
This variable turns on debug logging:
|
|
392
|
+
|
|
393
|
+
```bash
|
|
394
|
+
export SIGNALWIRE_LOG_LEVEL=debug
|
|
395
|
+
```
|
|
396
|
+
|
|
397
|
+
## Examples
|
|
398
|
+
|
|
399
|
+
See the [Serverless Guide](serverless-guide.md) for AWS Lambda and CGI examples, and for the adapter's details.
|