@signalwire/sdk 2.0.4 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +785 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +550 -163
- package/dist/AgentBase.js +1640 -514
- package/dist/AgentBase.js.map +1 -1
- package/dist/AgentServer.d.ts +21 -0
- package/dist/AgentServer.js +154 -47
- package/dist/AgentServer.js.map +1 -1
- package/dist/AuthHandler.d.ts +14 -2
- package/dist/AuthHandler.js +7 -2
- package/dist/AuthHandler.js.map +1 -1
- package/dist/ConfigLoader.d.ts +5 -13
- package/dist/ConfigLoader.js +15 -29
- package/dist/ConfigLoader.js.map +1 -1
- package/dist/ContextBuilder.d.ts +202 -9
- package/dist/ContextBuilder.js +219 -36
- package/dist/ContextBuilder.js.map +1 -1
- package/dist/DataMap.d.ts +158 -45
- package/dist/DataMap.js +167 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +277 -83
- package/dist/FunctionResult.js +444 -116
- package/dist/FunctionResult.js.map +1 -1
- package/dist/Logger.d.ts +30 -5
- package/dist/Logger.js +77 -19
- package/dist/Logger.js.map +1 -1
- package/dist/POM/PromptObjectModel.d.ts +163 -0
- package/dist/POM/PromptObjectModel.js +481 -0
- package/dist/POM/PromptObjectModel.js.map +1 -0
- package/dist/ParameterSchema.d.ts +306 -0
- package/dist/ParameterSchema.js +251 -0
- package/dist/ParameterSchema.js.map +1 -0
- package/dist/PlatformContracts.d.ts +21 -0
- package/dist/PlatformContracts.generated.d.ts +109 -0
- package/dist/PlatformContracts.generated.js +8 -0
- package/dist/PlatformContracts.generated.js.map +1 -0
- package/dist/PlatformContracts.js +2 -0
- package/dist/PlatformContracts.js.map +1 -0
- package/dist/PomBuilder.d.ts +28 -0
- package/dist/PomBuilder.js +81 -3
- package/dist/PomBuilder.js.map +1 -1
- package/dist/PostPrompt.d.ts +110 -0
- package/dist/PostPrompt.js +204 -0
- package/dist/PostPrompt.js.map +1 -0
- package/dist/PromptManager.d.ts +29 -1
- package/dist/PromptManager.js +37 -1
- package/dist/PromptManager.js.map +1 -1
- package/dist/PublicFetch.d.ts +132 -0
- package/dist/PublicFetch.js +311 -0
- package/dist/PublicFetch.js.map +1 -0
- package/dist/RobotsTxt.d.ts +41 -0
- package/dist/RobotsTxt.js +152 -0
- package/dist/RobotsTxt.js.map +1 -0
- package/dist/SWMLHandler.js.map +1 -1
- package/dist/SWMLService.d.ts +265 -66
- package/dist/SWMLService.js +652 -112
- package/dist/SWMLService.js.map +1 -1
- package/dist/SchemaUtils.d.ts +115 -2
- package/dist/SchemaUtils.js +444 -12
- package/dist/SchemaUtils.js.map +1 -1
- package/dist/SecurityUtils.d.ts +55 -8
- package/dist/SecurityUtils.js +162 -49
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/ServerlessAdapter.d.ts +156 -7
- package/dist/ServerlessAdapter.js +399 -42
- package/dist/ServerlessAdapter.js.map +1 -1
- package/dist/SessionManager.d.ts +11 -2
- package/dist/SessionManager.js +50 -18
- package/dist/SessionManager.js.map +1 -1
- package/dist/SslConfig.d.ts +2 -1
- package/dist/SslConfig.js +4 -1
- package/dist/SslConfig.js.map +1 -1
- package/dist/SwaigActions.generated.d.ts +23 -0
- package/dist/SwaigActions.generated.js +8 -0
- package/dist/SwaigActions.generated.js.map +1 -0
- package/dist/SwaigContracts.d.ts +15 -0
- package/dist/SwaigContracts.generated.d.ts +264 -0
- package/dist/SwaigContracts.generated.js +12 -0
- package/dist/SwaigContracts.generated.js.map +1 -0
- package/dist/SwaigContracts.js +2 -0
- package/dist/SwaigContracts.js.map +1 -0
- package/dist/SwaigFunction.d.ts +110 -4
- package/dist/SwaigFunction.js +151 -19
- package/dist/SwaigFunction.js.map +1 -1
- package/dist/SwmlBuilder.d.ts +68 -19
- package/dist/SwmlBuilder.js +74 -38
- package/dist/SwmlBuilder.js.map +1 -1
- package/dist/SwmlVerbMethods.generated.d.ts +41 -4
- package/dist/SwmlVerbMethods.generated.js +1 -1
- package/dist/TypeInference.d.ts +39 -3
- package/dist/TypeInference.js +256 -16
- package/dist/TypeInference.js.map +1 -1
- package/dist/WebService.d.ts +79 -11
- package/dist/WebService.js +320 -109
- package/dist/WebService.js.map +1 -1
- package/dist/WebhookMiddleware.d.ts +119 -0
- package/dist/WebhookMiddleware.js +271 -0
- package/dist/WebhookMiddleware.js.map +1 -0
- package/dist/WebhookValidator.d.ts +92 -0
- package/dist/WebhookValidator.js +409 -0
- package/dist/WebhookValidator.js.map +1 -0
- package/dist/agents/BedrockAgent.d.ts +162 -0
- package/dist/agents/BedrockAgent.js +323 -0
- package/dist/agents/BedrockAgent.js.map +1 -0
- package/dist/ai-chat/AIChatClient.d.ts +316 -0
- package/dist/ai-chat/AIChatClient.js +535 -0
- package/dist/ai-chat/AIChatClient.js.map +1 -0
- package/dist/ai-chat/ChatGateway.d.ts +408 -0
- package/dist/ai-chat/ChatGateway.js +747 -0
- package/dist/ai-chat/ChatGateway.js.map +1 -0
- package/dist/ai-chat/HandoffRouter.d.ts +282 -0
- package/dist/ai-chat/HandoffRouter.js +518 -0
- package/dist/ai-chat/HandoffRouter.js.map +1 -0
- package/dist/ai-chat/index.d.ts +12 -0
- package/dist/ai-chat/index.js +10 -0
- package/dist/ai-chat/index.js.map +1 -0
- package/dist/capabilities.d.ts +64 -0
- package/dist/capabilities.js +95 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +32 -6
- package/dist/cli/agent-loader.js +95 -34
- package/dist/cli/agent-loader.js.map +1 -1
- package/dist/cli/datamap-exec.d.ts +175 -0
- package/dist/cli/datamap-exec.js +1284 -0
- package/dist/cli/datamap-exec.js.map +1 -0
- package/dist/cli/function-args.d.ts +40 -0
- package/dist/cli/function-args.js +146 -0
- package/dist/cli/function-args.js.map +1 -0
- package/dist/cli/simulation.d.ts +99 -0
- package/dist/cli/simulation.js +490 -0
- package/dist/cli/simulation.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +12 -25
- package/dist/cli/swaig-test.js +935 -367
- package/dist/cli/swaig-test.js.map +1 -1
- package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
- package/dist/cli/tsdocs/agentsNote.js +92 -0
- package/dist/cli/tsdocs/agentsNote.js.map +1 -0
- package/dist/cli/tsdocs/api-index.json +1 -0
- package/dist/cli/tsdocs/api.d.ts +91 -0
- package/dist/cli/tsdocs/api.js +372 -0
- package/dist/cli/tsdocs/api.js.map +1 -0
- package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
- package/dist/cli/tsdocs/apiTypes.js +7 -0
- package/dist/cli/tsdocs/apiTypes.js.map +1 -0
- package/dist/cli/tsdocs/bin.d.ts +6 -0
- package/dist/cli/tsdocs/bin.js +23 -0
- package/dist/cli/tsdocs/bin.js.map +1 -0
- package/dist/cli/tsdocs/files.d.ts +108 -0
- package/dist/cli/tsdocs/files.js +287 -0
- package/dist/cli/tsdocs/files.js.map +1 -0
- package/dist/cli/tsdocs/index.d.ts +28 -0
- package/dist/cli/tsdocs/index.js +307 -0
- package/dist/cli/tsdocs/index.js.map +1 -0
- package/dist/cli/tsdocs/live.d.ts +41 -0
- package/dist/cli/tsdocs/live.js +202 -0
- package/dist/cli/tsdocs/live.js.map +1 -0
- package/dist/cli/tsdocs/locate.d.ts +51 -0
- package/dist/cli/tsdocs/locate.js +75 -0
- package/dist/cli/tsdocs/locate.js.map +1 -0
- package/dist/cli/tsdocs/render.d.ts +75 -0
- package/dist/cli/tsdocs/render.js +323 -0
- package/dist/cli/tsdocs/render.js.map +1 -0
- package/dist/cli/tsdocs/topics.d.ts +43 -0
- package/dist/cli/tsdocs/topics.js +916 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +102 -39
- package/dist/index.js +107 -30
- package/dist/index.js.map +1 -1
- package/dist/livewire/index.d.ts +229 -155
- package/dist/livewire/index.js +298 -195
- package/dist/livewire/index.js.map +1 -1
- package/dist/llms.txt +65 -0
- package/dist/prefabs/CallSessionStore.d.ts +52 -0
- package/dist/prefabs/CallSessionStore.js +72 -0
- package/dist/prefabs/CallSessionStore.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +13 -1
- package/dist/prefabs/ConciergeAgent.js +36 -31
- package/dist/prefabs/ConciergeAgent.js.map +1 -1
- package/dist/prefabs/FAQBotAgent.d.ts +9 -1
- package/dist/prefabs/FAQBotAgent.js +113 -47
- package/dist/prefabs/FAQBotAgent.js.map +1 -1
- package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
- package/dist/prefabs/InfoGathererAgent.js +67 -58
- package/dist/prefabs/InfoGathererAgent.js.map +1 -1
- package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
- package/dist/prefabs/ReceptionistAgent.js +39 -31
- package/dist/prefabs/ReceptionistAgent.js.map +1 -1
- package/dist/prefabs/SurveyAgent.d.ts +22 -4
- package/dist/prefabs/SurveyAgent.js +84 -68
- package/dist/prefabs/SurveyAgent.js.map +1 -1
- package/dist/relay/Action.d.ts +44 -21
- package/dist/relay/Action.js +75 -17
- package/dist/relay/Action.js.map +1 -1
- package/dist/relay/Call.d.ts +312 -47
- package/dist/relay/Call.js +369 -18
- package/dist/relay/Call.js.map +1 -1
- package/dist/relay/Deferred.js.map +1 -1
- package/dist/relay/Message.d.ts +26 -5
- package/dist/relay/Message.js +36 -6
- package/dist/relay/Message.js.map +1 -1
- package/dist/relay/RelayClient.d.ts +79 -14
- package/dist/relay/RelayClient.js +268 -61
- package/dist/relay/RelayClient.js.map +1 -1
- package/dist/relay/RelayError.d.ts +14 -0
- package/dist/relay/RelayError.js +15 -0
- package/dist/relay/RelayError.js.map +1 -1
- package/dist/relay/RelayEvent.d.ts +96 -65
- package/dist/relay/RelayEvent.js +85 -56
- package/dist/relay/RelayEvent.js.map +1 -1
- package/dist/relay/closedSets.d.ts +111 -0
- package/dist/relay/closedSets.js +83 -0
- package/dist/relay/closedSets.js.map +1 -0
- package/dist/relay/index.d.ts +3 -1
- package/dist/relay/index.js +1 -0
- package/dist/relay/index.js.map +1 -1
- package/dist/relay/normalize.js.map +1 -1
- package/dist/relay/protocol.types.generated.d.ts +1195 -0
- package/dist/relay/protocol.types.generated.js +8 -0
- package/dist/relay/protocol.types.generated.js.map +1 -0
- package/dist/relay/types.d.ts +81 -39
- package/dist/rest/HttpClient.d.ts +36 -8
- package/dist/rest/HttpClient.js +233 -40
- package/dist/rest/HttpClient.js.map +1 -1
- package/dist/rest/RequestOptions.d.ts +110 -0
- package/dist/rest/RequestOptions.js +113 -0
- package/dist/rest/RequestOptions.js.map +1 -0
- package/dist/rest/RestError.d.ts +52 -6
- package/dist/rest/RestError.js +89 -5
- package/dist/rest/RestError.js.map +1 -1
- package/dist/rest/base/CrudResource.d.ts +16 -26
- package/dist/rest/base/CrudResource.js +19 -33
- package/dist/rest/base/CrudResource.js.map +1 -1
- package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
- package/dist/rest/base/CrudWithAddresses.js +2 -2
- package/dist/rest/base/CrudWithAddresses.js.map +1 -1
- package/dist/rest/base/FabricResource.d.ts +15 -0
- package/dist/rest/base/FabricResource.js +16 -0
- package/dist/rest/base/FabricResource.js.map +1 -0
- package/dist/rest/base/ReadResource.d.ts +62 -0
- package/dist/rest/base/ReadResource.js +69 -0
- package/dist/rest/base/ReadResource.js.map +1 -0
- package/dist/rest/callHandler.d.ts +63 -0
- package/dist/rest/callHandler.js +62 -0
- package/dist/rest/callHandler.js.map +1 -0
- package/dist/rest/index.d.ts +19 -76
- package/dist/rest/index.js +49 -120
- package/dist/rest/index.js.map +1 -1
- package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
- package/dist/rest/namespaces/_client_tree_generated.js +171 -0
- package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +3 -42
- package/dist/rest/namespaces/addresses.js +3 -50
- package/dist/rest/namespaces/addresses.js.map +1 -1
- package/dist/rest/namespaces/calling.d.ts +6 -378
- package/dist/rest/namespaces/calling.js +6 -473
- package/dist/rest/namespaces/calling.js.map +1 -1
- package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
- package/dist/rest/namespaces/calling.resources.generated.js +477 -0
- package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
- package/dist/rest/namespaces/calling.types.generated.js +8 -0
- package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +4 -18
- package/dist/rest/namespaces/chat.js +4 -21
- package/dist/rest/namespaces/chat.js.map +1 -1
- package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/chat.resources.generated.js +29 -0
- package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
- package/dist/rest/namespaces/chat.types.generated.js +8 -0
- package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +6 -62
- package/dist/rest/namespaces/datasphere.js +6 -72
- package/dist/rest/namespaces/datasphere.js.map +1 -1
- package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
- package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
- package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +11 -273
- package/dist/rest/namespaces/fabric.js +14 -363
- package/dist/rest/namespaces/fabric.js.map +1 -1
- package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
- package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
- package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
- package/dist/rest/namespaces/fabric.types.generated.js +8 -0
- package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/fax.resources.generated.js +14 -0
- package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/fax.types.generated.js +8 -0
- package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
- package/dist/rest/namespaces/imported-numbers.js +3 -21
- package/dist/rest/namespaces/imported-numbers.js.map +1 -1
- package/dist/rest/namespaces/logs.d.ts +10 -101
- package/dist/rest/namespaces/logs.js +10 -128
- package/dist/rest/namespaces/logs.js.map +1 -1
- package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/logs.resources.generated.js +17 -0
- package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/logs.types.generated.js +8 -0
- package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +3 -25
- package/dist/rest/namespaces/lookup.js +3 -27
- package/dist/rest/namespaces/lookup.js.map +1 -1
- package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/message.resources.generated.js +14 -0
- package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
- package/dist/rest/namespaces/message.types.generated.js +8 -0
- package/dist/rest/namespaces/message.types.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
- package/dist/rest/namespaces/messages.resources.generated.js +44 -0
- package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
- package/dist/rest/namespaces/messages.types.generated.js +8 -0
- package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +3 -42
- package/dist/rest/namespaces/mfa.js +3 -49
- package/dist/rest/namespaces/mfa.js.map +1 -1
- package/dist/rest/namespaces/number-groups.d.ts +3 -45
- package/dist/rest/namespaces/number-groups.js +3 -53
- package/dist/rest/namespaces/number-groups.js.map +1 -1
- package/dist/rest/namespaces/phone-numbers.d.ts +9 -57
- package/dist/rest/namespaces/phone-numbers.js +9 -63
- package/dist/rest/namespaces/phone-numbers.js.map +1 -1
- package/dist/rest/namespaces/project.d.ts +6 -42
- package/dist/rest/namespaces/project.js +6 -51
- package/dist/rest/namespaces/project.js.map +1 -1
- package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
- package/dist/rest/namespaces/project.resources.generated.js +44 -0
- package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
- package/dist/rest/namespaces/project.types.generated.js +8 -0
- package/dist/rest/namespaces/project.types.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/projects.resources.generated.js +25 -0
- package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
- package/dist/rest/namespaces/projects.types.generated.js +8 -0
- package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +4 -18
- package/dist/rest/namespaces/pubsub.js +4 -21
- package/dist/rest/namespaces/pubsub.js.map +1 -1
- package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
- package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
- package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +3 -38
- package/dist/rest/namespaces/queues.js +3 -44
- package/dist/rest/namespaces/queues.js.map +1 -1
- package/dist/rest/namespaces/recordings.d.ts +3 -34
- package/dist/rest/namespaces/recordings.js +3 -40
- package/dist/rest/namespaces/recordings.js.map +1 -1
- package/dist/rest/namespaces/registry.d.ts +6 -137
- package/dist/rest/namespaces/registry.js +6 -173
- package/dist/rest/namespaces/registry.js.map +1 -1
- package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +3 -35
- package/dist/rest/namespaces/short-codes.js +3 -41
- package/dist/rest/namespaces/short-codes.js.map +1 -1
- package/dist/rest/namespaces/sip-profile.d.ts +3 -24
- package/dist/rest/namespaces/sip-profile.js +3 -29
- package/dist/rest/namespaces/sip-profile.js.map +1 -1
- package/dist/rest/namespaces/verified-callers.d.ts +3 -29
- package/dist/rest/namespaces/verified-callers.js +3 -34
- package/dist/rest/namespaces/verified-callers.js.map +1 -1
- package/dist/rest/namespaces/video.d.ts +10 -227
- package/dist/rest/namespaces/video.js +10 -288
- package/dist/rest/namespaces/video.js.map +1 -1
- package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
- package/dist/rest/namespaces/video.resources.generated.js +171 -0
- package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
- package/dist/rest/namespaces/video.types.generated.js +8 -0
- package/dist/rest/namespaces/video.types.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/voice.resources.generated.js +17 -0
- package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
- package/dist/rest/namespaces/voice.types.generated.js +8 -0
- package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
- package/dist/rest/pagination.d.ts +5 -1
- package/dist/rest/pagination.js +40 -20
- package/dist/rest/pagination.js.map +1 -1
- package/dist/rest/types.d.ts +21 -3
- package/dist/schema.json +299 -98
- package/dist/skills/SkillBase.d.ts +97 -20
- package/dist/skills/SkillBase.js +100 -17
- package/dist/skills/SkillBase.js.map +1 -1
- package/dist/skills/SkillManager.d.ts +66 -13
- package/dist/skills/SkillManager.js +101 -20
- package/dist/skills/SkillManager.js.map +1 -1
- package/dist/skills/SkillName.d.ts +44 -0
- package/dist/skills/SkillName.js +2 -0
- package/dist/skills/SkillName.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +47 -7
- package/dist/skills/SkillRegistry.js +85 -13
- package/dist/skills/SkillRegistry.js.map +1 -1
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
- package/dist/skills/builtin/api_ninjas_trivia.js +24 -8
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
- package/dist/skills/builtin/ask_claude.d.ts +14 -4
- package/dist/skills/builtin/ask_claude.js +36 -14
- package/dist/skills/builtin/ask_claude.js.map +1 -1
- package/dist/skills/builtin/claude_skills.d.ts +3 -1
- package/dist/skills/builtin/claude_skills.js +19 -15
- package/dist/skills/builtin/claude_skills.js.map +1 -1
- package/dist/skills/builtin/custom_skills.d.ts +10 -3
- package/dist/skills/builtin/custom_skills.js +26 -9
- package/dist/skills/builtin/custom_skills.js.map +1 -1
- package/dist/skills/builtin/datasphere.d.ts +5 -3
- package/dist/skills/builtin/datasphere.js +34 -25
- package/dist/skills/builtin/datasphere.js.map +1 -1
- package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
- package/dist/skills/builtin/datasphere_serverless.js +17 -6
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
- package/dist/skills/builtin/datetime.d.ts +3 -1
- package/dist/skills/builtin/datetime.js +11 -7
- package/dist/skills/builtin/datetime.js.map +1 -1
- package/dist/skills/builtin/google_maps.d.ts +29 -14
- package/dist/skills/builtin/google_maps.js +89 -269
- package/dist/skills/builtin/google_maps.js.map +1 -1
- package/dist/skills/builtin/index.d.ts +8 -6
- package/dist/skills/builtin/index.js +8 -6
- package/dist/skills/builtin/index.js.map +1 -1
- package/dist/skills/builtin/info_gatherer.d.ts +4 -2
- package/dist/skills/builtin/info_gatherer.js +20 -12
- package/dist/skills/builtin/info_gatherer.js.map +1 -1
- package/dist/skills/builtin/joke.d.ts +16 -6
- package/dist/skills/builtin/joke.js +54 -37
- package/dist/skills/builtin/joke.js.map +1 -1
- package/dist/skills/builtin/math.d.ts +3 -1
- package/dist/skills/builtin/math.js +14 -9
- package/dist/skills/builtin/math.js.map +1 -1
- package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
- package/dist/skills/builtin/mcp_gateway.js +77 -46
- package/dist/skills/builtin/mcp_gateway.js.map +1 -1
- package/dist/skills/builtin/native_vector_search.d.ts +19 -5
- package/dist/skills/builtin/native_vector_search.js +179 -61
- package/dist/skills/builtin/native_vector_search.js.map +1 -1
- package/dist/skills/builtin/play_background_file.d.ts +21 -15
- package/dist/skills/builtin/play_background_file.js +43 -122
- package/dist/skills/builtin/play_background_file.js.map +1 -1
- package/dist/skills/builtin/spider.d.ts +46 -1
- package/dist/skills/builtin/spider.js +317 -101
- package/dist/skills/builtin/spider.js.map +1 -1
- package/dist/skills/builtin/swml_transfer.d.ts +14 -3
- package/dist/skills/builtin/swml_transfer.js +45 -24
- package/dist/skills/builtin/swml_transfer.js.map +1 -1
- package/dist/skills/builtin/weather_api.d.ts +24 -13
- package/dist/skills/builtin/weather_api.js +57 -31
- package/dist/skills/builtin/weather_api.js.map +1 -1
- package/dist/skills/builtin/web_search.d.ts +48 -10
- package/dist/skills/builtin/web_search.js +301 -84
- package/dist/skills/builtin/web_search.js.map +1 -1
- package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
- package/dist/skills/builtin/wikipedia_search.js +32 -14
- package/dist/skills/builtin/wikipedia_search.js.map +1 -1
- package/dist/skills/index.d.ts +3 -2
- package/dist/skills/index.js +1 -1
- package/dist/skills/index.js.map +1 -1
- package/dist/swml_verbs_generated.d.ts +2824 -0
- package/dist/swml_verbs_generated.js +12 -0
- package/dist/swml_verbs_generated.js.map +1 -0
- package/dist/types.d.ts +65 -6
- package/dist/web.d.ts +27 -0
- package/dist/web.js +20 -0
- package/dist/web.js.map +1 -0
- package/docs/agent-guide.md +1034 -0
- package/docs/ai_chat.md +560 -0
- package/docs/api-reference.md +3534 -0
- package/docs/architecture.md +846 -0
- package/docs/bedrock_agent.md +411 -0
- package/docs/cli-guide.md +403 -0
- package/docs/cloud_functions_guide.md +399 -0
- package/docs/configuration.md +548 -0
- package/docs/contexts-guide.md +884 -0
- package/docs/datamap-guide.md +1160 -0
- package/docs/developer_pain_points.md +548 -0
- package/docs/llm_parameters.md +298 -0
- package/docs/mcp_gateway_reference.md +354 -0
- package/docs/mcp_integration.md +162 -0
- package/docs/pgi_agent_guide.md +1820 -0
- package/docs/prefabs-guide.md +815 -0
- package/docs/programmatically_governed_inference.md +301 -0
- package/docs/sdk_features.md +501 -0
- package/docs/security.md +559 -0
- package/docs/serverless-guide.md +520 -0
- package/docs/skills-guide.md +1223 -0
- package/docs/skills-system.md +405 -0
- package/docs/skills_parameter_schema.md +417 -0
- package/docs/swaig-reference.md +1938 -0
- package/docs/swml_service_guide.md +573 -0
- package/docs/third_party_skills.md +410 -0
- package/docs/web_service.md +666 -0
- package/examples/README.md +202 -0
- package/examples/advanced-datamap.ts +108 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +95 -0
- package/examples/call-flow.ts +65 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +51 -0
- package/examples/datasphere-multi-instance.ts +66 -0
- package/examples/datasphere-serverless-env.ts +87 -0
- package/examples/datasphere-webhook-env.ts +65 -0
- package/examples/datasphere.ts +56 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +95 -0
- package/examples/gather-per-question-functions-demo.ts +139 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +75 -0
- package/examples/mcp-agent.ts +89 -0
- package/examples/mcp-gateway.ts +81 -0
- package/examples/multi-agent.ts +80 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pgi/case-domain.ts +114 -0
- package/examples/pgi/serve.ts +16 -0
- package/examples/pgi/support-agent.ts +265 -0
- package/examples/pom-prompt.ts +70 -0
- package/examples/prefab-concierge.ts +42 -0
- package/examples/prefab-faq.ts +58 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +69 -0
- package/examples/quickstart-agent.ts +29 -0
- package/examples/quickstart-relay.ts +25 -0
- package/examples/quickstart-rest.ts +25 -0
- package/examples/record-call.ts +65 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +93 -0
- package/examples/serverless-lambda.ts +43 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +41 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +193 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/swmlservice_ai_sidecar.ts +104 -0
- package/examples/swmlservice_swaig_standalone.ts +79 -0
- package/examples/tap.ts +67 -0
- package/examples/typed-tools.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +75 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +164 -0
- package/livewire/docs/migration-guide.md +251 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +196 -0
- package/livewire/examples/livewire-multi-tool.ts +121 -0
- package/package.json +88 -13
- package/relay/README.md +101 -0
- package/relay/docs/call-methods.md +622 -0
- package/relay/docs/client-reference.md +281 -0
- package/relay/docs/events.md +193 -0
- package/relay/docs/getting-started.md +221 -0
- package/relay/docs/guide.md +386 -0
- package/relay/docs/messaging.md +246 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +74 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +141 -0
- package/rest/docs/calling.md +313 -0
- package/rest/docs/client-reference.md +149 -0
- package/rest/docs/fabric.md +192 -0
- package/rest/docs/getting-started.md +138 -0
- package/rest/docs/guide.md +421 -0
- package/rest/docs/namespaces.md +367 -0
- package/rest/docs/phone-binding.md +116 -0
- package/rest/examples/rest-10dlc-registration.ts +177 -0
- package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
- package/rest/examples/rest-calling-play-and-record.ts +98 -0
- package/rest/examples/rest-client.ts +59 -0
- package/rest/examples/rest-datasphere-search.ts +81 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
- package/rest/examples/rest-manage-resources.ts +64 -0
- package/rest/examples/rest-phone-number-management.ts +200 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/tutorial/fred/fred.ts +218 -0
- package/tutorial/fred/tutorial/01-introduction.md +141 -0
- package/tutorial/fred/tutorial/02-setup.md +304 -0
- package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
- package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
- package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
- package/tutorial/fred/tutorial/06-running-testing.md +642 -0
- package/tutorial/fred/tutorial/README.md +56 -0
- package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
- package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
- package/tutorial/full-guardrails-agent/handlers.ts +436 -0
- package/tutorial/full-guardrails-agent/penny.ts +305 -0
- package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
- package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
- package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
- package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
- package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
- package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
- package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
- package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
- package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
- package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
- package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
- package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
- package/tutorial/full-guardrails-agent/workflow.ts +219 -0
- package/tutorial/multi_agents/README.md +175 -0
- package/tutorial/multi_agents/advanced_agent.ts +395 -0
- package/tutorial/multi_agents/extending_agents.ts +641 -0
- package/tutorial/multi_agents/knowledge.ts +59 -0
- package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
- package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
- package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
- package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
- package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
- package/tutorial/multi_agents/pc_builder.ts +529 -0
- package/tutorial/multi_agents/sales_agent.ts +88 -0
- package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
- package/tutorial/multi_agents/sales_knowledge.md +139 -0
- package/tutorial/multi_agents/support_knowledge.md +256 -0
- package/dist/cli/mock-data.d.ts +0 -37
- package/dist/cli/mock-data.js +0 -80
- package/dist/cli/mock-data.js.map +0 -1
- package/dist/generateVerbTypes.d.ts +0 -11
- package/dist/generateVerbTypes.js +0 -265
- package/dist/generateVerbTypes.js.map +0 -1
- package/dist/rest/namespaces/compat.d.ts +0 -585
- package/dist/rest/namespaces/compat.js +0 -735
- package/dist/rest/namespaces/compat.js.map +0 -1
|
@@ -0,0 +1,411 @@
|
|
|
1
|
+
# BedrockAgent
|
|
2
|
+
|
|
3
|
+
`BedrockAgent` is an `AgentBase` subclass for Amazon Bedrock's voice-to-voice model. It keeps the standard agent features: prompts, skills, tools, DataMap tools, post-prompt and dynamic configuration. Its SWML uses the `amazon_bedrock` verb in place of the `ai` verb.
|
|
4
|
+
|
|
5
|
+
## Contents
|
|
6
|
+
|
|
7
|
+
The guide has these sections:
|
|
8
|
+
|
|
9
|
+
- [Create a BedrockAgent](#create-a-bedrockagent)
|
|
10
|
+
- [Constructor options](#constructor-options)
|
|
11
|
+
- [Voices](#voices)
|
|
12
|
+
- [Inference settings](#inference-settings)
|
|
13
|
+
- [Methods that behave differently](#methods-that-behave-differently)
|
|
14
|
+
- [What the agent renders](#what-the-agent-renders)
|
|
15
|
+
- [What the amazon_bedrock verb leaves out](#what-the-amazon_bedrock-verb-leaves-out)
|
|
16
|
+
- [Test with swaig-test](#test-with-swaig-test)
|
|
17
|
+
- [Complete example](#complete-example)
|
|
18
|
+
- [Deployment](#deployment)
|
|
19
|
+
- [Migrate from AgentBase](#migrate-from-agentbase)
|
|
20
|
+
- [Troubleshooting](#troubleshooting)
|
|
21
|
+
- [Related documentation](#related-documentation)
|
|
22
|
+
|
|
23
|
+
## Create a BedrockAgent
|
|
24
|
+
|
|
25
|
+
`BedrockAgent` and the `createBedrockAgent()` factory are exported from the package root. Construct the agent with a configuration object, then serve it the way you serve any agent:
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import { BedrockAgent } from '@signalwire/sdk';
|
|
29
|
+
|
|
30
|
+
const agent = new BedrockAgent({
|
|
31
|
+
name: 'my_bedrock_agent',
|
|
32
|
+
systemPrompt: 'You are a helpful assistant.',
|
|
33
|
+
voiceId: 'tiffany',
|
|
34
|
+
temperature: 0.7,
|
|
35
|
+
});
|
|
36
|
+
|
|
37
|
+
await agent.serve();
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
`createBedrockAgent(config)` takes the same `BedrockAgentConfig` and returns `new BedrockAgent(config)`. The default export of the module is the class itself.
|
|
41
|
+
|
|
42
|
+
Tools, skills and prompt sections work as they do on `AgentBase`. This agent adds a skill and a tool:
|
|
43
|
+
|
|
44
|
+
```typescript
|
|
45
|
+
import { BedrockAgent, DateTimeSkill, FunctionResult } from '@signalwire/sdk';
|
|
46
|
+
|
|
47
|
+
const agent = new BedrockAgent({ name: 'calculator', voiceId: 'matthew' });
|
|
48
|
+
|
|
49
|
+
agent.promptAddSection('Role', { body: 'You answer arithmetic questions.' });
|
|
50
|
+
await agent.addSkill(new DateTimeSkill());
|
|
51
|
+
|
|
52
|
+
agent.defineTool({
|
|
53
|
+
name: 'calculate_sum',
|
|
54
|
+
description: 'Add two numbers together',
|
|
55
|
+
parameters: {
|
|
56
|
+
a: { type: 'integer', description: 'The first number' },
|
|
57
|
+
b: { type: 'integer', description: 'The second number' },
|
|
58
|
+
},
|
|
59
|
+
required: ['a', 'b'],
|
|
60
|
+
handler: (args) => new FunctionResult(`The sum is ${args.a + args.b}.`),
|
|
61
|
+
});
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
`systemPrompt` sets the prompt as raw text. When a raw text prompt is set, the rendered prompt is that text alone: sections added with `promptAddSection()`, including the sections a skill adds, aren't rendered. That's `AgentBase` behavior, not specific to Bedrock. Use `promptAddSection()` in place of `systemPrompt` when you load skills that add prompt sections.
|
|
65
|
+
|
|
66
|
+
## Constructor options
|
|
67
|
+
|
|
68
|
+
The constructor takes one optional `BedrockAgentConfig` object. Every field is optional:
|
|
69
|
+
|
|
70
|
+
| Option | Type | Default | Description |
|
|
71
|
+
|---|---|---|---|
|
|
72
|
+
| `name` | `string` | `'bedrock_agent'` | Agent name |
|
|
73
|
+
| `route` | `string` | `'/bedrock'` | HTTP route the agent serves |
|
|
74
|
+
| `systemPrompt` | `string` | none | Initial prompt, set with `setPromptText()` |
|
|
75
|
+
| `voiceId` | `string` | `'matthew'` | Bedrock voice; see [Voices](#voices) |
|
|
76
|
+
| `temperature` | `number \| string` | `0.7` | Sent as `prompt.temperature`; see [Inference settings](#inference-settings) |
|
|
77
|
+
| `topP` | `number \| string` | `0.9` | Sent as `prompt.top_p` |
|
|
78
|
+
| `maxTokens` | `number \| string` | `1024` | Sent as `prompt.max_tokens`; must be an integer. The platform's Bedrock session doesn't read it, and uses 1024 |
|
|
79
|
+
| `agentOptions` | `Partial<AgentOptions>` | none | Other `AgentBase` options, such as `basicAuth`, `port`, `swaigSecret` or `signingKey` |
|
|
80
|
+
|
|
81
|
+
`agentOptions` is spread after `name` and `route`, so a `name` or `route` inside it wins over the top-level fields.
|
|
82
|
+
|
|
83
|
+
## Voices
|
|
84
|
+
|
|
85
|
+
The SWML schema's `amazon_bedrock` prompt accepts five `voice_id` values:
|
|
86
|
+
|
|
87
|
+
- `tiffany`
|
|
88
|
+
- `matthew` (the schema's default, and the SDK's)
|
|
89
|
+
- `amy`
|
|
90
|
+
- `lupe`
|
|
91
|
+
- `carlos`
|
|
92
|
+
|
|
93
|
+
`BedrockAgent` doesn't check the value: `voiceId` and `setVoice()` accept any string and render it as `voice_id`. The schema rejects any other value, and the SDK doesn't validate the rendered verb against the schema.
|
|
94
|
+
|
|
95
|
+
## Inference settings
|
|
96
|
+
|
|
97
|
+
The `amazon_bedrock` prompt object carries the model settings. The SDK always sends `voice_id`, `temperature`, `top_p` and `max_tokens`, from the constructor options or the latest call to `setInferenceParams()`:
|
|
98
|
+
|
|
99
|
+
```typescript
|
|
100
|
+
import { BedrockAgent } from '@signalwire/sdk';
|
|
101
|
+
|
|
102
|
+
const agent = new BedrockAgent();
|
|
103
|
+
|
|
104
|
+
agent.setVoice('amy');
|
|
105
|
+
agent.setInferenceParams(0.5, 0.95, 2048); // temperature, topP, maxTokens
|
|
106
|
+
agent.setInferenceParams(undefined, undefined, 512); // change maxTokens only
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
An argument left `undefined` keeps its current value. Each value must be a number, and `max_tokens` an integer. A numeric string such as `'0.5'` is converted. `temperature` and `top_p` also accept a SWML variable reference such as `'${temperature}'`, which is sent as written. Anything else throws an `Error`, from the constructor, `setInferenceParams()`, `setLlmTemperature()` or `setPromptLlmParams()`, and a call that throws changes none of the settings:
|
|
110
|
+
|
|
111
|
+
```text
|
|
112
|
+
Error: BedrockAgent temperature must be a number, got "hot"
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
The platform's Bedrock session applies `temperature` from 0 to 2 and `top_p` from 0 to 1. It doesn't read `max_tokens`, and uses 1024. The schema allows `temperature` only up to 1.5 and `max_tokens` from 0 to 4096. The SDK doesn't clamp or check these ranges.
|
|
116
|
+
|
|
117
|
+
`setPromptLlmParams()` takes the settings by their SWML names. On a `BedrockAgent` it sorts them into two groups:
|
|
118
|
+
|
|
119
|
+
- `temperature`, `top_p` and `max_tokens` update the inference settings, as `setInferenceParams()` does, so a value that isn't a number throws.
|
|
120
|
+
- Any other key is left out, and the SDK logs a warning that names it. The platform's Bedrock session reads no other prompt setting, so this includes `confidence`, `presence_penalty` and `frequency_penalty`, which the schema's Bedrock prompt lists, and `barge_confidence`.
|
|
121
|
+
|
|
122
|
+
This call sets `max_tokens` and four settings the Bedrock session doesn't use:
|
|
123
|
+
|
|
124
|
+
```typescript
|
|
125
|
+
import { BedrockAgent } from '@signalwire/sdk';
|
|
126
|
+
|
|
127
|
+
const agent = new BedrockAgent({
|
|
128
|
+
systemPrompt: 'You answer questions about order status.',
|
|
129
|
+
voiceId: 'tiffany',
|
|
130
|
+
});
|
|
131
|
+
|
|
132
|
+
agent.setPromptLlmParams({
|
|
133
|
+
max_tokens: 512,
|
|
134
|
+
confidence: 0.7,
|
|
135
|
+
presence_penalty: 0.2,
|
|
136
|
+
frequency_penalty: 0.1,
|
|
137
|
+
barge_confidence: 0.5,
|
|
138
|
+
});
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
The SDK logs this warning for the keys it leaves out:
|
|
142
|
+
|
|
143
|
+
```text
|
|
144
|
+
2026-09-29T22:06:32.030Z [WARN] [AgentBase] setPromptLlmParams(): the platform's Bedrock session doesn't use barge_confidence, confidence, frequency_penalty, presence_penalty, so they're ignored
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
The rendered prompt then carries the text, the voice and the inference settings:
|
|
148
|
+
|
|
149
|
+
```json
|
|
150
|
+
{
|
|
151
|
+
"text": "You answer questions about order status.",
|
|
152
|
+
"voice_id": "tiffany",
|
|
153
|
+
"temperature": 0.7,
|
|
154
|
+
"top_p": 0.9,
|
|
155
|
+
"max_tokens": 512
|
|
156
|
+
}
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
## Methods that behave differently
|
|
160
|
+
|
|
161
|
+
Four `AgentBase` methods behave differently on a `BedrockAgent`:
|
|
162
|
+
|
|
163
|
+
| Method | On a `BedrockAgent` |
|
|
164
|
+
|---|---|
|
|
165
|
+
| `setLlmModel(model)` | Logs a warning and changes nothing. The Bedrock voice-to-voice model is fixed. |
|
|
166
|
+
| `setLlmTemperature(temperature)` | Calls `setInferenceParams(temperature)`. |
|
|
167
|
+
| `setPostPromptLlmParams(params)` | Logs a warning and changes nothing. |
|
|
168
|
+
| `setPromptLlmParams(params)` | Sorts the settings as described in [Inference settings](#inference-settings). |
|
|
169
|
+
|
|
170
|
+
The warning from `setPostPromptLlmParams()` says the Bedrock post-prompt uses a model the engine configures. The SWML schema's `amazon_bedrock` `post_prompt` does accept `temperature`, `top_p`, `max_tokens`, `confidence` and the penalties, but the platform's Bedrock post-prompt reads only its text, with its other settings fixed in the engine, so `BedrockAgent` doesn't send them. Set the post-prompt text with `setPostPrompt()` as usual.
|
|
171
|
+
|
|
172
|
+
`BedrockAgent` adds two methods of its own: `setVoice(voiceId)` and `setInferenceParams(temperature?, topP?, maxTokens?)`. Both return the agent, so calls chain.
|
|
173
|
+
|
|
174
|
+
## What the agent renders
|
|
175
|
+
|
|
176
|
+
`BedrockAgent` overrides `renderSwml()`. It renders the document as `AgentBase` does, then replaces the `ai` verb with an `amazon_bedrock` verb that carries six of its keys. It adds `voice_id` and the inference settings to the prompt object, and keeps only `text` or `pom` from the `ai` prompt, since the platform's Bedrock session reads no other prompt setting.
|
|
177
|
+
|
|
178
|
+
Run `swaig-test` with `--dump-swml` to see the document an agent renders:
|
|
179
|
+
|
|
180
|
+
```bash
|
|
181
|
+
npx tsx src/cli/swaig-test.ts bedrock-support.ts --dump-swml
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
This is the output for the agent in [Complete example](#complete-example), with basic auth set to `user:pass`, the token shortened and three of the four functions removed:
|
|
185
|
+
|
|
186
|
+
```json
|
|
187
|
+
{
|
|
188
|
+
"version": "1.0.0",
|
|
189
|
+
"sections": {
|
|
190
|
+
"main": [
|
|
191
|
+
{
|
|
192
|
+
"answer": {}
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
"amazon_bedrock": {
|
|
196
|
+
"prompt": {
|
|
197
|
+
"text": "You help callers check the status of their orders.",
|
|
198
|
+
"voice_id": "tiffany",
|
|
199
|
+
"temperature": 0.5,
|
|
200
|
+
"top_p": 0.9,
|
|
201
|
+
"max_tokens": 512
|
|
202
|
+
},
|
|
203
|
+
"SWAIG": {
|
|
204
|
+
"functions": [
|
|
205
|
+
{
|
|
206
|
+
"function": "check_order_status",
|
|
207
|
+
"description": "Look up the status of an order by its ID",
|
|
208
|
+
"parameters": {
|
|
209
|
+
"type": "object",
|
|
210
|
+
"properties": {
|
|
211
|
+
"order_id": {
|
|
212
|
+
"type": "string",
|
|
213
|
+
"description": "The order ID to look up"
|
|
214
|
+
}
|
|
215
|
+
},
|
|
216
|
+
"required": [
|
|
217
|
+
"order_id"
|
|
218
|
+
]
|
|
219
|
+
},
|
|
220
|
+
"web_hook_url": "http://user:pass@localhost:3000/support/swaig?__token=..."
|
|
221
|
+
}
|
|
222
|
+
],
|
|
223
|
+
"defaults": {
|
|
224
|
+
"web_hook_url": "http://user:pass@localhost:3000/support/swaig"
|
|
225
|
+
}
|
|
226
|
+
},
|
|
227
|
+
"params": {},
|
|
228
|
+
"global_data": {}
|
|
229
|
+
}
|
|
230
|
+
}
|
|
231
|
+
]
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
The `amazon_bedrock` verb carries these keys:
|
|
237
|
+
|
|
238
|
+
| Key | Content |
|
|
239
|
+
|---|---|
|
|
240
|
+
| `prompt` | `text` or `pom`, `voice_id`, `temperature`, `top_p` and `max_tokens`. The platform's Bedrock session reads all but `max_tokens` |
|
|
241
|
+
| `SWAIG` | `functions`, `defaults` and any other SWAIG keys the agent built |
|
|
242
|
+
| `params` | The values from `setParams()`, such as `attention_timeout` or `inactivity_timeout` |
|
|
243
|
+
| `global_data` | The agent's global data |
|
|
244
|
+
| `post_prompt` | Present when a post-prompt is set |
|
|
245
|
+
| `post_prompt_url` | Present when a post-prompt is set |
|
|
246
|
+
|
|
247
|
+
`SWAIG`, `params` and `global_data` are always present, as empty objects when there's nothing to send. `post_prompt` and `post_prompt_url` appear only when the agent has a post-prompt.
|
|
248
|
+
|
|
249
|
+
## What the amazon_bedrock verb leaves out
|
|
250
|
+
|
|
251
|
+
`BedrockAgent` copies only the six keys in the preceding table from the `ai` verb, and only the keys the Bedrock prompt object defines from the `ai` prompt. Everything else that `AgentBase` puts on the `ai` verb or its prompt is left out of the SWML:
|
|
252
|
+
|
|
253
|
+
| Configured with | Key left out |
|
|
254
|
+
|---|---|
|
|
255
|
+
| `addHint()`, `addHints()`, `addPatternHint()`, and skills that add hints | `hints` |
|
|
256
|
+
| `addLanguage()` | `languages` |
|
|
257
|
+
| `addPronunciation()`, `setPronunciations()` | `pronounce` |
|
|
258
|
+
| `enableDebugEvents()` | `debug_webhook_url`, `debug_webhook_level` |
|
|
259
|
+
| `setMultilingual()` | `multilingual` |
|
|
260
|
+
| `defineContexts()` | `contexts`, in the prompt |
|
|
261
|
+
|
|
262
|
+
The SWML schema's `amazon_bedrock` verb has none of these keys, and its `prompt` object doesn't define `contexts`, so contexts and steps don't work with a `BedrockAgent`.
|
|
263
|
+
|
|
264
|
+
The agent logs one warning for each key it leaves out, the first time it renders SWML without it. Later renders, including the per-request copies that serve calls, don't repeat it. An agent with hints and contexts logs these two warnings once:
|
|
265
|
+
|
|
266
|
+
```text
|
|
267
|
+
2026-09-29T21:49:19.732Z [WARN] [AgentBase] BedrockAgent: the amazon_bedrock verb has no hints, so the agent's speech hints (addHint(), addHints(), addPatternHint() and skills' hints) are left out of the SWML
|
|
268
|
+
2026-09-29T21:49:19.732Z [WARN] [AgentBase] BedrockAgent: Bedrock's prompt has no contexts, so the agent's contexts and steps (defineContexts()) are left out of the SWML
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
`params` is passed through as it is. The schema's `amazon_bedrock` `params` lists `attention_timeout`, `inactivity_timeout`, `hard_stop_time`, `hard_stop_prompt` and the three video file URLs.
|
|
272
|
+
|
|
273
|
+
## Test with swaig-test
|
|
274
|
+
|
|
275
|
+
`swaig-test` loads a `BedrockAgent` file as it loads any agent file. Put options before `--exec`; the flags after `--exec <function>` are the function's arguments.
|
|
276
|
+
|
|
277
|
+
This command lists the agent's tools:
|
|
278
|
+
|
|
279
|
+
```bash
|
|
280
|
+
npx tsx src/cli/swaig-test.ts bedrock-support.ts --list-tools
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
The output lists the two `DateTimeSkill` tools and the two tools the file defines:
|
|
284
|
+
|
|
285
|
+
```text
|
|
286
|
+
Available SWAIG functions:
|
|
287
|
+
get_current_time - Get the current time, optionally in a specific timezone (LOCAL webhook)
|
|
288
|
+
Parameters:
|
|
289
|
+
timezone (string): Timezone name (e.g., 'America/New_York', 'Europe/London'). Defaults to UTC.
|
|
290
|
+
get_current_date - Get the current date (LOCAL webhook)
|
|
291
|
+
Parameters:
|
|
292
|
+
timezone (string): Timezone name for the date. Defaults to UTC.
|
|
293
|
+
check_order_status - Look up the status of an order by its ID (LOCAL webhook)
|
|
294
|
+
Parameters:
|
|
295
|
+
order_id (string) (required): The order ID to look up
|
|
296
|
+
transfer_to_support - Transfer the caller to the support team (LOCAL webhook)
|
|
297
|
+
Parameters: None
|
|
298
|
+
```
|
|
299
|
+
|
|
300
|
+
This command runs one tool with an argument:
|
|
301
|
+
|
|
302
|
+
```bash
|
|
303
|
+
npx tsx src/cli/swaig-test.ts bedrock-support.ts --exec check_order_status --order_id A-1001
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
The handler's result is printed:
|
|
307
|
+
|
|
308
|
+
```text
|
|
309
|
+
RESULT:
|
|
310
|
+
Response: Order A-1001: shipped, arriving Thursday.
|
|
311
|
+
```
|
|
312
|
+
|
|
313
|
+
In an installed package, the same commands run as `npx swaig-test`. For more information, see the [CLI guide](cli-guide.md).
|
|
314
|
+
|
|
315
|
+
## Complete example
|
|
316
|
+
|
|
317
|
+
This file, `bedrock-support.ts`, is the agent the earlier outputs came from. It sets a voice and inference settings, loads a skill, and defines two tools:
|
|
318
|
+
|
|
319
|
+
```typescript
|
|
320
|
+
import { BedrockAgent, DateTimeSkill, FunctionResult } from '@signalwire/sdk';
|
|
321
|
+
|
|
322
|
+
export const agent = new BedrockAgent({
|
|
323
|
+
name: 'order_support',
|
|
324
|
+
route: '/support',
|
|
325
|
+
systemPrompt: 'You help callers check the status of their orders.',
|
|
326
|
+
voiceId: 'tiffany',
|
|
327
|
+
temperature: 0.5,
|
|
328
|
+
maxTokens: 512,
|
|
329
|
+
});
|
|
330
|
+
|
|
331
|
+
await agent.addSkill(new DateTimeSkill());
|
|
332
|
+
|
|
333
|
+
agent.defineTool({
|
|
334
|
+
name: 'check_order_status',
|
|
335
|
+
description: 'Look up the status of an order by its ID',
|
|
336
|
+
parameters: {
|
|
337
|
+
order_id: { type: 'string', description: 'The order ID to look up' },
|
|
338
|
+
},
|
|
339
|
+
required: ['order_id'],
|
|
340
|
+
handler: (args) => {
|
|
341
|
+
// Replace with a lookup in your order system.
|
|
342
|
+
return new FunctionResult(`Order ${args.order_id}: shipped, arriving Thursday.`);
|
|
343
|
+
},
|
|
344
|
+
});
|
|
345
|
+
|
|
346
|
+
agent.defineTool({
|
|
347
|
+
name: 'transfer_to_support',
|
|
348
|
+
description: 'Transfer the caller to the support team',
|
|
349
|
+
parameters: {},
|
|
350
|
+
handler: () => new FunctionResult('Transferring the caller to support.').connect('+15551234567'),
|
|
351
|
+
});
|
|
352
|
+
|
|
353
|
+
await agent.serve();
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
The file exports `agent` so that `swaig-test` can find it. `swaig-test` sets `SWAIG_CLI_MODE`, and `serve()` returns without starting a server in that mode. Because `systemPrompt` is raw text, the `DateTimeSkill` prompt section isn't rendered; its tools are.
|
|
357
|
+
|
|
358
|
+
## Deployment
|
|
359
|
+
|
|
360
|
+
A `BedrockAgent` deploys the same way as any agent:
|
|
361
|
+
|
|
362
|
+
- **Basic auth.** The agent uses `SWML_BASIC_AUTH_USER` and `SWML_BASIC_AUTH_PASSWORD`, or `agentOptions.basicAuth`. Without a password, the SDK generates a random one for the process and logs a warning. The username is then `SWML_BASIC_AUTH_USER`, or the agent's name.
|
|
363
|
+
- **Port.** The agent listens on `PORT`, or 3000. Pass `{ port }` to `serve()` or `agentOptions.port` to change it.
|
|
364
|
+
- **Tool tokens.** Tools are secure by default, so each webhook URL carries a per-call `__token`. Set `swaigSecret` or `SIGNALWIRE_SWAIG_SECRET` to the same value on every replica, or tokens minted by one process fail on another.
|
|
365
|
+
- **Webhook signatures.** Set `signingKey` or `SIGNALWIRE_SIGNING_KEY` to refuse unsigned POST requests.
|
|
366
|
+
- **Skills.** Set the environment variables the skills you load need, such as API keys.
|
|
367
|
+
|
|
368
|
+
For more information, see the [security guide](security.md) and [configuration reference](configuration.md).
|
|
369
|
+
|
|
370
|
+
## Migrate from AgentBase
|
|
371
|
+
|
|
372
|
+
Most agent code runs unchanged on a `BedrockAgent`. This is the change to the constructor:
|
|
373
|
+
|
|
374
|
+
```typescript
|
|
375
|
+
import { AgentBase, BedrockAgent } from '@signalwire/sdk';
|
|
376
|
+
|
|
377
|
+
// Before
|
|
378
|
+
const before = new AgentBase({ name: 'my_agent' });
|
|
379
|
+
|
|
380
|
+
// After
|
|
381
|
+
const after = new BedrockAgent({ name: 'my_agent', voiceId: 'matthew' });
|
|
382
|
+
```
|
|
383
|
+
|
|
384
|
+
`AgentBase` takes its options directly, and `BedrockAgent` takes other `AgentBase` options under `agentOptions`. `BedrockAgent` defaults to the `/bedrock` route, not `/`. After the change, review these points:
|
|
385
|
+
|
|
386
|
+
- Replace `setLlmModel()` calls; they have no effect.
|
|
387
|
+
- Move model settings to `setInferenceParams()` or `setPromptLlmParams()`.
|
|
388
|
+
- Choose one of the five Bedrock voices.
|
|
389
|
+
- Replace hints, languages, pronunciation rules, multilingual settings and contexts, which the `amazon_bedrock` verb doesn't carry. See [What the amazon_bedrock verb leaves out](#what-the-amazon_bedrock-verb-leaves-out).
|
|
390
|
+
|
|
391
|
+
## Troubleshooting
|
|
392
|
+
|
|
393
|
+
These problems come up with a `BedrockAgent`:
|
|
394
|
+
|
|
395
|
+
- **The voice doesn't change.** Check that the value is one of the [five voices](#voices). The SDK sends any string.
|
|
396
|
+
- **A setting doesn't appear in the prompt.** Only `temperature`, `top_p` and `max_tokens` are sent, and the platform's Bedrock session doesn't read `max_tokens` (it uses 1024). Look for the `setPromptLlmParams()` warning in the log.
|
|
397
|
+
- **Prompt sections are missing.** `systemPrompt` or `setPromptText()` replaces the POM prompt. Use `promptAddSection()` alone for a structured prompt.
|
|
398
|
+
- **Steps don't run.** The Bedrock prompt doesn't define `contexts`, so the SDK leaves them out and logs a warning.
|
|
399
|
+
- **The constructor or `setInferenceParams()` throws.** `temperature`, `top_p` and `max_tokens` must be numbers, or numeric strings. See [Inference settings](#inference-settings).
|
|
400
|
+
- **The agent doesn't answer at `/`.** Its route is `/bedrock` unless you set `route`.
|
|
401
|
+
|
|
402
|
+
Set `SIGNALWIRE_LOG_LEVEL=debug` to log the voice and inference changes as they're made.
|
|
403
|
+
|
|
404
|
+
## Related documentation
|
|
405
|
+
|
|
406
|
+
For more information, see these documents:
|
|
407
|
+
|
|
408
|
+
- [Agent guide](agent-guide.md): prompts, tools, skills and the other `AgentBase` features a `BedrockAgent` inherits
|
|
409
|
+
- [Skills system](skills-system.md): loading and configuring skills
|
|
410
|
+
- [SWAIG reference](swaig-reference.md): tool definitions and `FunctionResult` actions
|
|
411
|
+
- [DataMap guide](datamap-guide.md): tools that run on the platform
|