@signalwire/sdk 2.0.4 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +785 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +550 -163
- package/dist/AgentBase.js +1640 -514
- package/dist/AgentBase.js.map +1 -1
- package/dist/AgentServer.d.ts +21 -0
- package/dist/AgentServer.js +154 -47
- package/dist/AgentServer.js.map +1 -1
- package/dist/AuthHandler.d.ts +14 -2
- package/dist/AuthHandler.js +7 -2
- package/dist/AuthHandler.js.map +1 -1
- package/dist/ConfigLoader.d.ts +5 -13
- package/dist/ConfigLoader.js +15 -29
- package/dist/ConfigLoader.js.map +1 -1
- package/dist/ContextBuilder.d.ts +202 -9
- package/dist/ContextBuilder.js +219 -36
- package/dist/ContextBuilder.js.map +1 -1
- package/dist/DataMap.d.ts +158 -45
- package/dist/DataMap.js +167 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +277 -83
- package/dist/FunctionResult.js +444 -116
- package/dist/FunctionResult.js.map +1 -1
- package/dist/Logger.d.ts +30 -5
- package/dist/Logger.js +77 -19
- package/dist/Logger.js.map +1 -1
- package/dist/POM/PromptObjectModel.d.ts +163 -0
- package/dist/POM/PromptObjectModel.js +481 -0
- package/dist/POM/PromptObjectModel.js.map +1 -0
- package/dist/ParameterSchema.d.ts +306 -0
- package/dist/ParameterSchema.js +251 -0
- package/dist/ParameterSchema.js.map +1 -0
- package/dist/PlatformContracts.d.ts +21 -0
- package/dist/PlatformContracts.generated.d.ts +109 -0
- package/dist/PlatformContracts.generated.js +8 -0
- package/dist/PlatformContracts.generated.js.map +1 -0
- package/dist/PlatformContracts.js +2 -0
- package/dist/PlatformContracts.js.map +1 -0
- package/dist/PomBuilder.d.ts +28 -0
- package/dist/PomBuilder.js +81 -3
- package/dist/PomBuilder.js.map +1 -1
- package/dist/PostPrompt.d.ts +110 -0
- package/dist/PostPrompt.js +204 -0
- package/dist/PostPrompt.js.map +1 -0
- package/dist/PromptManager.d.ts +29 -1
- package/dist/PromptManager.js +37 -1
- package/dist/PromptManager.js.map +1 -1
- package/dist/PublicFetch.d.ts +132 -0
- package/dist/PublicFetch.js +311 -0
- package/dist/PublicFetch.js.map +1 -0
- package/dist/RobotsTxt.d.ts +41 -0
- package/dist/RobotsTxt.js +152 -0
- package/dist/RobotsTxt.js.map +1 -0
- package/dist/SWMLHandler.js.map +1 -1
- package/dist/SWMLService.d.ts +265 -66
- package/dist/SWMLService.js +652 -112
- package/dist/SWMLService.js.map +1 -1
- package/dist/SchemaUtils.d.ts +115 -2
- package/dist/SchemaUtils.js +444 -12
- package/dist/SchemaUtils.js.map +1 -1
- package/dist/SecurityUtils.d.ts +55 -8
- package/dist/SecurityUtils.js +162 -49
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/ServerlessAdapter.d.ts +156 -7
- package/dist/ServerlessAdapter.js +399 -42
- package/dist/ServerlessAdapter.js.map +1 -1
- package/dist/SessionManager.d.ts +11 -2
- package/dist/SessionManager.js +50 -18
- package/dist/SessionManager.js.map +1 -1
- package/dist/SslConfig.d.ts +2 -1
- package/dist/SslConfig.js +4 -1
- package/dist/SslConfig.js.map +1 -1
- package/dist/SwaigActions.generated.d.ts +23 -0
- package/dist/SwaigActions.generated.js +8 -0
- package/dist/SwaigActions.generated.js.map +1 -0
- package/dist/SwaigContracts.d.ts +15 -0
- package/dist/SwaigContracts.generated.d.ts +264 -0
- package/dist/SwaigContracts.generated.js +12 -0
- package/dist/SwaigContracts.generated.js.map +1 -0
- package/dist/SwaigContracts.js +2 -0
- package/dist/SwaigContracts.js.map +1 -0
- package/dist/SwaigFunction.d.ts +110 -4
- package/dist/SwaigFunction.js +151 -19
- package/dist/SwaigFunction.js.map +1 -1
- package/dist/SwmlBuilder.d.ts +68 -19
- package/dist/SwmlBuilder.js +74 -38
- package/dist/SwmlBuilder.js.map +1 -1
- package/dist/SwmlVerbMethods.generated.d.ts +41 -4
- package/dist/SwmlVerbMethods.generated.js +1 -1
- package/dist/TypeInference.d.ts +39 -3
- package/dist/TypeInference.js +256 -16
- package/dist/TypeInference.js.map +1 -1
- package/dist/WebService.d.ts +79 -11
- package/dist/WebService.js +320 -109
- package/dist/WebService.js.map +1 -1
- package/dist/WebhookMiddleware.d.ts +119 -0
- package/dist/WebhookMiddleware.js +271 -0
- package/dist/WebhookMiddleware.js.map +1 -0
- package/dist/WebhookValidator.d.ts +92 -0
- package/dist/WebhookValidator.js +409 -0
- package/dist/WebhookValidator.js.map +1 -0
- package/dist/agents/BedrockAgent.d.ts +162 -0
- package/dist/agents/BedrockAgent.js +323 -0
- package/dist/agents/BedrockAgent.js.map +1 -0
- package/dist/ai-chat/AIChatClient.d.ts +316 -0
- package/dist/ai-chat/AIChatClient.js +535 -0
- package/dist/ai-chat/AIChatClient.js.map +1 -0
- package/dist/ai-chat/ChatGateway.d.ts +408 -0
- package/dist/ai-chat/ChatGateway.js +747 -0
- package/dist/ai-chat/ChatGateway.js.map +1 -0
- package/dist/ai-chat/HandoffRouter.d.ts +282 -0
- package/dist/ai-chat/HandoffRouter.js +518 -0
- package/dist/ai-chat/HandoffRouter.js.map +1 -0
- package/dist/ai-chat/index.d.ts +12 -0
- package/dist/ai-chat/index.js +10 -0
- package/dist/ai-chat/index.js.map +1 -0
- package/dist/capabilities.d.ts +64 -0
- package/dist/capabilities.js +95 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +32 -6
- package/dist/cli/agent-loader.js +95 -34
- package/dist/cli/agent-loader.js.map +1 -1
- package/dist/cli/datamap-exec.d.ts +175 -0
- package/dist/cli/datamap-exec.js +1284 -0
- package/dist/cli/datamap-exec.js.map +1 -0
- package/dist/cli/function-args.d.ts +40 -0
- package/dist/cli/function-args.js +146 -0
- package/dist/cli/function-args.js.map +1 -0
- package/dist/cli/simulation.d.ts +99 -0
- package/dist/cli/simulation.js +490 -0
- package/dist/cli/simulation.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +12 -25
- package/dist/cli/swaig-test.js +935 -367
- package/dist/cli/swaig-test.js.map +1 -1
- package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
- package/dist/cli/tsdocs/agentsNote.js +92 -0
- package/dist/cli/tsdocs/agentsNote.js.map +1 -0
- package/dist/cli/tsdocs/api-index.json +1 -0
- package/dist/cli/tsdocs/api.d.ts +91 -0
- package/dist/cli/tsdocs/api.js +372 -0
- package/dist/cli/tsdocs/api.js.map +1 -0
- package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
- package/dist/cli/tsdocs/apiTypes.js +7 -0
- package/dist/cli/tsdocs/apiTypes.js.map +1 -0
- package/dist/cli/tsdocs/bin.d.ts +6 -0
- package/dist/cli/tsdocs/bin.js +23 -0
- package/dist/cli/tsdocs/bin.js.map +1 -0
- package/dist/cli/tsdocs/files.d.ts +108 -0
- package/dist/cli/tsdocs/files.js +287 -0
- package/dist/cli/tsdocs/files.js.map +1 -0
- package/dist/cli/tsdocs/index.d.ts +28 -0
- package/dist/cli/tsdocs/index.js +307 -0
- package/dist/cli/tsdocs/index.js.map +1 -0
- package/dist/cli/tsdocs/live.d.ts +41 -0
- package/dist/cli/tsdocs/live.js +202 -0
- package/dist/cli/tsdocs/live.js.map +1 -0
- package/dist/cli/tsdocs/locate.d.ts +51 -0
- package/dist/cli/tsdocs/locate.js +75 -0
- package/dist/cli/tsdocs/locate.js.map +1 -0
- package/dist/cli/tsdocs/render.d.ts +75 -0
- package/dist/cli/tsdocs/render.js +323 -0
- package/dist/cli/tsdocs/render.js.map +1 -0
- package/dist/cli/tsdocs/topics.d.ts +43 -0
- package/dist/cli/tsdocs/topics.js +916 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +102 -39
- package/dist/index.js +107 -30
- package/dist/index.js.map +1 -1
- package/dist/livewire/index.d.ts +229 -155
- package/dist/livewire/index.js +298 -195
- package/dist/livewire/index.js.map +1 -1
- package/dist/llms.txt +65 -0
- package/dist/prefabs/CallSessionStore.d.ts +52 -0
- package/dist/prefabs/CallSessionStore.js +72 -0
- package/dist/prefabs/CallSessionStore.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +13 -1
- package/dist/prefabs/ConciergeAgent.js +36 -31
- package/dist/prefabs/ConciergeAgent.js.map +1 -1
- package/dist/prefabs/FAQBotAgent.d.ts +9 -1
- package/dist/prefabs/FAQBotAgent.js +113 -47
- package/dist/prefabs/FAQBotAgent.js.map +1 -1
- package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
- package/dist/prefabs/InfoGathererAgent.js +67 -58
- package/dist/prefabs/InfoGathererAgent.js.map +1 -1
- package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
- package/dist/prefabs/ReceptionistAgent.js +39 -31
- package/dist/prefabs/ReceptionistAgent.js.map +1 -1
- package/dist/prefabs/SurveyAgent.d.ts +22 -4
- package/dist/prefabs/SurveyAgent.js +84 -68
- package/dist/prefabs/SurveyAgent.js.map +1 -1
- package/dist/relay/Action.d.ts +44 -21
- package/dist/relay/Action.js +75 -17
- package/dist/relay/Action.js.map +1 -1
- package/dist/relay/Call.d.ts +312 -47
- package/dist/relay/Call.js +369 -18
- package/dist/relay/Call.js.map +1 -1
- package/dist/relay/Deferred.js.map +1 -1
- package/dist/relay/Message.d.ts +26 -5
- package/dist/relay/Message.js +36 -6
- package/dist/relay/Message.js.map +1 -1
- package/dist/relay/RelayClient.d.ts +79 -14
- package/dist/relay/RelayClient.js +268 -61
- package/dist/relay/RelayClient.js.map +1 -1
- package/dist/relay/RelayError.d.ts +14 -0
- package/dist/relay/RelayError.js +15 -0
- package/dist/relay/RelayError.js.map +1 -1
- package/dist/relay/RelayEvent.d.ts +96 -65
- package/dist/relay/RelayEvent.js +85 -56
- package/dist/relay/RelayEvent.js.map +1 -1
- package/dist/relay/closedSets.d.ts +111 -0
- package/dist/relay/closedSets.js +83 -0
- package/dist/relay/closedSets.js.map +1 -0
- package/dist/relay/index.d.ts +3 -1
- package/dist/relay/index.js +1 -0
- package/dist/relay/index.js.map +1 -1
- package/dist/relay/normalize.js.map +1 -1
- package/dist/relay/protocol.types.generated.d.ts +1195 -0
- package/dist/relay/protocol.types.generated.js +8 -0
- package/dist/relay/protocol.types.generated.js.map +1 -0
- package/dist/relay/types.d.ts +81 -39
- package/dist/rest/HttpClient.d.ts +36 -8
- package/dist/rest/HttpClient.js +233 -40
- package/dist/rest/HttpClient.js.map +1 -1
- package/dist/rest/RequestOptions.d.ts +110 -0
- package/dist/rest/RequestOptions.js +113 -0
- package/dist/rest/RequestOptions.js.map +1 -0
- package/dist/rest/RestError.d.ts +52 -6
- package/dist/rest/RestError.js +89 -5
- package/dist/rest/RestError.js.map +1 -1
- package/dist/rest/base/CrudResource.d.ts +16 -26
- package/dist/rest/base/CrudResource.js +19 -33
- package/dist/rest/base/CrudResource.js.map +1 -1
- package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
- package/dist/rest/base/CrudWithAddresses.js +2 -2
- package/dist/rest/base/CrudWithAddresses.js.map +1 -1
- package/dist/rest/base/FabricResource.d.ts +15 -0
- package/dist/rest/base/FabricResource.js +16 -0
- package/dist/rest/base/FabricResource.js.map +1 -0
- package/dist/rest/base/ReadResource.d.ts +62 -0
- package/dist/rest/base/ReadResource.js +69 -0
- package/dist/rest/base/ReadResource.js.map +1 -0
- package/dist/rest/callHandler.d.ts +63 -0
- package/dist/rest/callHandler.js +62 -0
- package/dist/rest/callHandler.js.map +1 -0
- package/dist/rest/index.d.ts +19 -76
- package/dist/rest/index.js +49 -120
- package/dist/rest/index.js.map +1 -1
- package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
- package/dist/rest/namespaces/_client_tree_generated.js +171 -0
- package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +3 -42
- package/dist/rest/namespaces/addresses.js +3 -50
- package/dist/rest/namespaces/addresses.js.map +1 -1
- package/dist/rest/namespaces/calling.d.ts +6 -378
- package/dist/rest/namespaces/calling.js +6 -473
- package/dist/rest/namespaces/calling.js.map +1 -1
- package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
- package/dist/rest/namespaces/calling.resources.generated.js +477 -0
- package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
- package/dist/rest/namespaces/calling.types.generated.js +8 -0
- package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +4 -18
- package/dist/rest/namespaces/chat.js +4 -21
- package/dist/rest/namespaces/chat.js.map +1 -1
- package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/chat.resources.generated.js +29 -0
- package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
- package/dist/rest/namespaces/chat.types.generated.js +8 -0
- package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +6 -62
- package/dist/rest/namespaces/datasphere.js +6 -72
- package/dist/rest/namespaces/datasphere.js.map +1 -1
- package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
- package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
- package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +11 -273
- package/dist/rest/namespaces/fabric.js +14 -363
- package/dist/rest/namespaces/fabric.js.map +1 -1
- package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
- package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
- package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
- package/dist/rest/namespaces/fabric.types.generated.js +8 -0
- package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/fax.resources.generated.js +14 -0
- package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/fax.types.generated.js +8 -0
- package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
- package/dist/rest/namespaces/imported-numbers.js +3 -21
- package/dist/rest/namespaces/imported-numbers.js.map +1 -1
- package/dist/rest/namespaces/logs.d.ts +10 -101
- package/dist/rest/namespaces/logs.js +10 -128
- package/dist/rest/namespaces/logs.js.map +1 -1
- package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/logs.resources.generated.js +17 -0
- package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/logs.types.generated.js +8 -0
- package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +3 -25
- package/dist/rest/namespaces/lookup.js +3 -27
- package/dist/rest/namespaces/lookup.js.map +1 -1
- package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/message.resources.generated.js +14 -0
- package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
- package/dist/rest/namespaces/message.types.generated.js +8 -0
- package/dist/rest/namespaces/message.types.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
- package/dist/rest/namespaces/messages.resources.generated.js +44 -0
- package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
- package/dist/rest/namespaces/messages.types.generated.js +8 -0
- package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +3 -42
- package/dist/rest/namespaces/mfa.js +3 -49
- package/dist/rest/namespaces/mfa.js.map +1 -1
- package/dist/rest/namespaces/number-groups.d.ts +3 -45
- package/dist/rest/namespaces/number-groups.js +3 -53
- package/dist/rest/namespaces/number-groups.js.map +1 -1
- package/dist/rest/namespaces/phone-numbers.d.ts +9 -57
- package/dist/rest/namespaces/phone-numbers.js +9 -63
- package/dist/rest/namespaces/phone-numbers.js.map +1 -1
- package/dist/rest/namespaces/project.d.ts +6 -42
- package/dist/rest/namespaces/project.js +6 -51
- package/dist/rest/namespaces/project.js.map +1 -1
- package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
- package/dist/rest/namespaces/project.resources.generated.js +44 -0
- package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
- package/dist/rest/namespaces/project.types.generated.js +8 -0
- package/dist/rest/namespaces/project.types.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/projects.resources.generated.js +25 -0
- package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
- package/dist/rest/namespaces/projects.types.generated.js +8 -0
- package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +4 -18
- package/dist/rest/namespaces/pubsub.js +4 -21
- package/dist/rest/namespaces/pubsub.js.map +1 -1
- package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
- package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
- package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +3 -38
- package/dist/rest/namespaces/queues.js +3 -44
- package/dist/rest/namespaces/queues.js.map +1 -1
- package/dist/rest/namespaces/recordings.d.ts +3 -34
- package/dist/rest/namespaces/recordings.js +3 -40
- package/dist/rest/namespaces/recordings.js.map +1 -1
- package/dist/rest/namespaces/registry.d.ts +6 -137
- package/dist/rest/namespaces/registry.js +6 -173
- package/dist/rest/namespaces/registry.js.map +1 -1
- package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +3 -35
- package/dist/rest/namespaces/short-codes.js +3 -41
- package/dist/rest/namespaces/short-codes.js.map +1 -1
- package/dist/rest/namespaces/sip-profile.d.ts +3 -24
- package/dist/rest/namespaces/sip-profile.js +3 -29
- package/dist/rest/namespaces/sip-profile.js.map +1 -1
- package/dist/rest/namespaces/verified-callers.d.ts +3 -29
- package/dist/rest/namespaces/verified-callers.js +3 -34
- package/dist/rest/namespaces/verified-callers.js.map +1 -1
- package/dist/rest/namespaces/video.d.ts +10 -227
- package/dist/rest/namespaces/video.js +10 -288
- package/dist/rest/namespaces/video.js.map +1 -1
- package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
- package/dist/rest/namespaces/video.resources.generated.js +171 -0
- package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
- package/dist/rest/namespaces/video.types.generated.js +8 -0
- package/dist/rest/namespaces/video.types.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/voice.resources.generated.js +17 -0
- package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
- package/dist/rest/namespaces/voice.types.generated.js +8 -0
- package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
- package/dist/rest/pagination.d.ts +5 -1
- package/dist/rest/pagination.js +40 -20
- package/dist/rest/pagination.js.map +1 -1
- package/dist/rest/types.d.ts +21 -3
- package/dist/schema.json +299 -98
- package/dist/skills/SkillBase.d.ts +97 -20
- package/dist/skills/SkillBase.js +100 -17
- package/dist/skills/SkillBase.js.map +1 -1
- package/dist/skills/SkillManager.d.ts +66 -13
- package/dist/skills/SkillManager.js +101 -20
- package/dist/skills/SkillManager.js.map +1 -1
- package/dist/skills/SkillName.d.ts +44 -0
- package/dist/skills/SkillName.js +2 -0
- package/dist/skills/SkillName.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +47 -7
- package/dist/skills/SkillRegistry.js +85 -13
- package/dist/skills/SkillRegistry.js.map +1 -1
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
- package/dist/skills/builtin/api_ninjas_trivia.js +24 -8
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
- package/dist/skills/builtin/ask_claude.d.ts +14 -4
- package/dist/skills/builtin/ask_claude.js +36 -14
- package/dist/skills/builtin/ask_claude.js.map +1 -1
- package/dist/skills/builtin/claude_skills.d.ts +3 -1
- package/dist/skills/builtin/claude_skills.js +19 -15
- package/dist/skills/builtin/claude_skills.js.map +1 -1
- package/dist/skills/builtin/custom_skills.d.ts +10 -3
- package/dist/skills/builtin/custom_skills.js +26 -9
- package/dist/skills/builtin/custom_skills.js.map +1 -1
- package/dist/skills/builtin/datasphere.d.ts +5 -3
- package/dist/skills/builtin/datasphere.js +34 -25
- package/dist/skills/builtin/datasphere.js.map +1 -1
- package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
- package/dist/skills/builtin/datasphere_serverless.js +17 -6
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
- package/dist/skills/builtin/datetime.d.ts +3 -1
- package/dist/skills/builtin/datetime.js +11 -7
- package/dist/skills/builtin/datetime.js.map +1 -1
- package/dist/skills/builtin/google_maps.d.ts +29 -14
- package/dist/skills/builtin/google_maps.js +89 -269
- package/dist/skills/builtin/google_maps.js.map +1 -1
- package/dist/skills/builtin/index.d.ts +8 -6
- package/dist/skills/builtin/index.js +8 -6
- package/dist/skills/builtin/index.js.map +1 -1
- package/dist/skills/builtin/info_gatherer.d.ts +4 -2
- package/dist/skills/builtin/info_gatherer.js +20 -12
- package/dist/skills/builtin/info_gatherer.js.map +1 -1
- package/dist/skills/builtin/joke.d.ts +16 -6
- package/dist/skills/builtin/joke.js +54 -37
- package/dist/skills/builtin/joke.js.map +1 -1
- package/dist/skills/builtin/math.d.ts +3 -1
- package/dist/skills/builtin/math.js +14 -9
- package/dist/skills/builtin/math.js.map +1 -1
- package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
- package/dist/skills/builtin/mcp_gateway.js +77 -46
- package/dist/skills/builtin/mcp_gateway.js.map +1 -1
- package/dist/skills/builtin/native_vector_search.d.ts +19 -5
- package/dist/skills/builtin/native_vector_search.js +179 -61
- package/dist/skills/builtin/native_vector_search.js.map +1 -1
- package/dist/skills/builtin/play_background_file.d.ts +21 -15
- package/dist/skills/builtin/play_background_file.js +43 -122
- package/dist/skills/builtin/play_background_file.js.map +1 -1
- package/dist/skills/builtin/spider.d.ts +46 -1
- package/dist/skills/builtin/spider.js +317 -101
- package/dist/skills/builtin/spider.js.map +1 -1
- package/dist/skills/builtin/swml_transfer.d.ts +14 -3
- package/dist/skills/builtin/swml_transfer.js +45 -24
- package/dist/skills/builtin/swml_transfer.js.map +1 -1
- package/dist/skills/builtin/weather_api.d.ts +24 -13
- package/dist/skills/builtin/weather_api.js +57 -31
- package/dist/skills/builtin/weather_api.js.map +1 -1
- package/dist/skills/builtin/web_search.d.ts +48 -10
- package/dist/skills/builtin/web_search.js +301 -84
- package/dist/skills/builtin/web_search.js.map +1 -1
- package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
- package/dist/skills/builtin/wikipedia_search.js +32 -14
- package/dist/skills/builtin/wikipedia_search.js.map +1 -1
- package/dist/skills/index.d.ts +3 -2
- package/dist/skills/index.js +1 -1
- package/dist/skills/index.js.map +1 -1
- package/dist/swml_verbs_generated.d.ts +2824 -0
- package/dist/swml_verbs_generated.js +12 -0
- package/dist/swml_verbs_generated.js.map +1 -0
- package/dist/types.d.ts +65 -6
- package/dist/web.d.ts +27 -0
- package/dist/web.js +20 -0
- package/dist/web.js.map +1 -0
- package/docs/agent-guide.md +1034 -0
- package/docs/ai_chat.md +560 -0
- package/docs/api-reference.md +3534 -0
- package/docs/architecture.md +846 -0
- package/docs/bedrock_agent.md +411 -0
- package/docs/cli-guide.md +403 -0
- package/docs/cloud_functions_guide.md +399 -0
- package/docs/configuration.md +548 -0
- package/docs/contexts-guide.md +884 -0
- package/docs/datamap-guide.md +1160 -0
- package/docs/developer_pain_points.md +548 -0
- package/docs/llm_parameters.md +298 -0
- package/docs/mcp_gateway_reference.md +354 -0
- package/docs/mcp_integration.md +162 -0
- package/docs/pgi_agent_guide.md +1820 -0
- package/docs/prefabs-guide.md +815 -0
- package/docs/programmatically_governed_inference.md +301 -0
- package/docs/sdk_features.md +501 -0
- package/docs/security.md +559 -0
- package/docs/serverless-guide.md +520 -0
- package/docs/skills-guide.md +1223 -0
- package/docs/skills-system.md +405 -0
- package/docs/skills_parameter_schema.md +417 -0
- package/docs/swaig-reference.md +1938 -0
- package/docs/swml_service_guide.md +573 -0
- package/docs/third_party_skills.md +410 -0
- package/docs/web_service.md +666 -0
- package/examples/README.md +202 -0
- package/examples/advanced-datamap.ts +108 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +95 -0
- package/examples/call-flow.ts +65 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +51 -0
- package/examples/datasphere-multi-instance.ts +66 -0
- package/examples/datasphere-serverless-env.ts +87 -0
- package/examples/datasphere-webhook-env.ts +65 -0
- package/examples/datasphere.ts +56 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +95 -0
- package/examples/gather-per-question-functions-demo.ts +139 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +75 -0
- package/examples/mcp-agent.ts +89 -0
- package/examples/mcp-gateway.ts +81 -0
- package/examples/multi-agent.ts +80 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pgi/case-domain.ts +114 -0
- package/examples/pgi/serve.ts +16 -0
- package/examples/pgi/support-agent.ts +265 -0
- package/examples/pom-prompt.ts +70 -0
- package/examples/prefab-concierge.ts +42 -0
- package/examples/prefab-faq.ts +58 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +69 -0
- package/examples/quickstart-agent.ts +29 -0
- package/examples/quickstart-relay.ts +25 -0
- package/examples/quickstart-rest.ts +25 -0
- package/examples/record-call.ts +65 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +93 -0
- package/examples/serverless-lambda.ts +43 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +41 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +193 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/swmlservice_ai_sidecar.ts +104 -0
- package/examples/swmlservice_swaig_standalone.ts +79 -0
- package/examples/tap.ts +67 -0
- package/examples/typed-tools.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +75 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +164 -0
- package/livewire/docs/migration-guide.md +251 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +196 -0
- package/livewire/examples/livewire-multi-tool.ts +121 -0
- package/package.json +88 -13
- package/relay/README.md +101 -0
- package/relay/docs/call-methods.md +622 -0
- package/relay/docs/client-reference.md +281 -0
- package/relay/docs/events.md +193 -0
- package/relay/docs/getting-started.md +221 -0
- package/relay/docs/guide.md +386 -0
- package/relay/docs/messaging.md +246 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +74 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +141 -0
- package/rest/docs/calling.md +313 -0
- package/rest/docs/client-reference.md +149 -0
- package/rest/docs/fabric.md +192 -0
- package/rest/docs/getting-started.md +138 -0
- package/rest/docs/guide.md +421 -0
- package/rest/docs/namespaces.md +367 -0
- package/rest/docs/phone-binding.md +116 -0
- package/rest/examples/rest-10dlc-registration.ts +177 -0
- package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
- package/rest/examples/rest-calling-play-and-record.ts +98 -0
- package/rest/examples/rest-client.ts +59 -0
- package/rest/examples/rest-datasphere-search.ts +81 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
- package/rest/examples/rest-manage-resources.ts +64 -0
- package/rest/examples/rest-phone-number-management.ts +200 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/tutorial/fred/fred.ts +218 -0
- package/tutorial/fred/tutorial/01-introduction.md +141 -0
- package/tutorial/fred/tutorial/02-setup.md +304 -0
- package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
- package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
- package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
- package/tutorial/fred/tutorial/06-running-testing.md +642 -0
- package/tutorial/fred/tutorial/README.md +56 -0
- package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
- package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
- package/tutorial/full-guardrails-agent/handlers.ts +436 -0
- package/tutorial/full-guardrails-agent/penny.ts +305 -0
- package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
- package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
- package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
- package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
- package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
- package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
- package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
- package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
- package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
- package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
- package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
- package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
- package/tutorial/full-guardrails-agent/workflow.ts +219 -0
- package/tutorial/multi_agents/README.md +175 -0
- package/tutorial/multi_agents/advanced_agent.ts +395 -0
- package/tutorial/multi_agents/extending_agents.ts +641 -0
- package/tutorial/multi_agents/knowledge.ts +59 -0
- package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
- package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
- package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
- package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
- package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
- package/tutorial/multi_agents/pc_builder.ts +529 -0
- package/tutorial/multi_agents/sales_agent.ts +88 -0
- package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
- package/tutorial/multi_agents/sales_knowledge.md +139 -0
- package/tutorial/multi_agents/support_knowledge.md +256 -0
- package/dist/cli/mock-data.d.ts +0 -37
- package/dist/cli/mock-data.js +0 -80
- package/dist/cli/mock-data.js.map +0 -1
- package/dist/generateVerbTypes.d.ts +0 -11
- package/dist/generateVerbTypes.js +0 -265
- package/dist/generateVerbTypes.js.map +0 -1
- package/dist/rest/namespaces/compat.d.ts +0 -585
- package/dist/rest/namespaces/compat.js +0 -735
- package/dist/rest/namespaces/compat.js.map +0 -1
package/dist/livewire/index.js
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* LiveWire
|
|
2
|
+
* LiveWire: LiveKit-compatible agents powered by SignalWire.
|
|
3
3
|
*
|
|
4
|
-
* Provides the same class
|
|
5
|
-
* developers can
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
4
|
+
* Provides the same class and function names as @livekit/agents-js, so
|
|
5
|
+
* developers can change their import path and run on SignalWire. SignalWire's
|
|
6
|
+
* control plane runs STT, TTS, VAD, LLM orchestration and call control. The
|
|
7
|
+
* pipeline options LiveWire ignores are accepted, and each logs a message
|
|
8
|
+
* once, so existing code keeps compiling.
|
|
9
9
|
*/
|
|
10
|
+
import { AsyncLocalStorage } from 'node:async_hooks';
|
|
10
11
|
import { AgentBase } from '../AgentBase.js';
|
|
11
12
|
import { FunctionResult } from '../FunctionResult.js';
|
|
12
13
|
// ---------------------------------------------------------------------------
|
|
@@ -34,24 +35,24 @@ function printBanner() {
|
|
|
34
35
|
// "Did You Know?" Tips
|
|
35
36
|
// ---------------------------------------------------------------------------
|
|
36
37
|
/**
|
|
37
|
-
*
|
|
38
|
-
* Exported for tests;
|
|
38
|
+
* "Did you know?" tips. `runApp()` prints one, chosen at random, to stderr.
|
|
39
|
+
* Exported for tests; edit the list to change what's displayed.
|
|
39
40
|
*/
|
|
40
41
|
export const tips = [
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
"SignalWire
|
|
45
|
-
|
|
46
|
-
"Your agent's
|
|
47
|
-
|
|
48
|
-
"SignalWire's RELAY client gives you real-time
|
|
49
|
-
|
|
50
|
-
|
|
42
|
+
'SignalWire agents support DataMap tools, which the platform runs server-side, so you host no webhook for them. See: docs/datamap-guide.md',
|
|
43
|
+
'SignalWire Contexts & Steps control which step a conversation is in and which tools each step allows. See: docs/contexts-guide.md',
|
|
44
|
+
'SignalWire agents can transfer a call to another agent with one FunctionResult action: swmlTransfer()',
|
|
45
|
+
"SignalWire built-in skills (datetime, math, web_search and more) add tools to an agent in one call: agent.addSkillByName('datetime')",
|
|
46
|
+
'SignalWire agents can send SMS, join conferences, record calls and use SIP, all from the same agent',
|
|
47
|
+
"Your agent's AI pipeline (STT, LLM, TTS, VAD) runs in SignalWire's cloud, so you don't run those services yourself",
|
|
48
|
+
'SignalWire prefab agents (InfoGathererAgent, SurveyAgent, ReceptionistAgent, FAQBotAgent, ConciergeAgent) give you ready-made agents for common call flows',
|
|
49
|
+
"SignalWire's RELAY client gives you real-time call control over WebSocket: play, record, detect, conference and more",
|
|
50
|
+
'SignalWire agents generate SWML documents, and the platform handles media, turn detection and barge-in',
|
|
51
|
+
'You can host multiple agents on one server with AgentServer, each with its own route, prompt and tools',
|
|
51
52
|
];
|
|
52
53
|
function printTip() {
|
|
53
54
|
const tip = tips[Math.floor(Math.random() * tips.length)];
|
|
54
|
-
process.stderr.write(`\
|
|
55
|
+
process.stderr.write(`\nDid you know? ${tip}\n\n`);
|
|
55
56
|
}
|
|
56
57
|
// ---------------------------------------------------------------------------
|
|
57
58
|
// Noop logging helpers
|
|
@@ -86,16 +87,32 @@ class NoopTracker {
|
|
|
86
87
|
const globalNoop = new NoopTracker();
|
|
87
88
|
// Re-export for testing
|
|
88
89
|
export { NoopTracker, globalNoop };
|
|
90
|
+
/**
|
|
91
|
+
* Normalize a tool list to `[name, tool]` pairs. Accepts Python's list shape
|
|
92
|
+
* (each tool carries its `name`) and the name-keyed object that LiveKit
|
|
93
|
+
* agents-js uses (`tools: { getWeather }`), where the key is the tool name.
|
|
94
|
+
*/
|
|
95
|
+
function toolEntries(tools) {
|
|
96
|
+
if (!tools)
|
|
97
|
+
return [];
|
|
98
|
+
if (Array.isArray(tools))
|
|
99
|
+
return tools.map((t) => [t.name, t]);
|
|
100
|
+
return Object.entries(tools).map(([name, t]) => [name, { ...t, name }]);
|
|
101
|
+
}
|
|
89
102
|
// ---------------------------------------------------------------------------
|
|
90
103
|
// Agent
|
|
91
104
|
// ---------------------------------------------------------------------------
|
|
92
105
|
/**
|
|
93
|
-
* Mirrors a LiveKit `voice.Agent
|
|
106
|
+
* Mirrors a LiveKit `voice.Agent`, and holds instructions and tool definitions.
|
|
94
107
|
*
|
|
95
|
-
*
|
|
96
|
-
* for API
|
|
97
|
-
*
|
|
98
|
-
*
|
|
108
|
+
* The `stt`, `tts`, `vad`, `turnDetection` and `mcpServers` options are accepted
|
|
109
|
+
* for API compatibility and ignored, because SignalWire's control plane runs the
|
|
110
|
+
* AI pipeline. Each one logs a message once. `llm` sets the model, and
|
|
111
|
+
* `allowInterruptions` and the endpointing delays map to AI params when
|
|
112
|
+
* {@link AgentSession.start} builds the agent.
|
|
113
|
+
*
|
|
114
|
+
* `tools` takes an object keyed by tool name, as LiveKit agents-js does, or
|
|
115
|
+
* an array of tools that each have a `name`, as the Python SDK does.
|
|
99
116
|
*
|
|
100
117
|
* @example Minimal LiveKit-compatible agent
|
|
101
118
|
* ```ts
|
|
@@ -108,7 +125,7 @@ export { NoopTracker, globalNoop };
|
|
|
108
125
|
*
|
|
109
126
|
* const agent = new livewire.Agent({
|
|
110
127
|
* instructions: 'You are a friendly helper.',
|
|
111
|
-
* tools:
|
|
128
|
+
* tools: { time: timeTool },
|
|
112
129
|
* });
|
|
113
130
|
*
|
|
114
131
|
* const session = new livewire.AgentSession();
|
|
@@ -133,34 +150,25 @@ export class Agent {
|
|
|
133
150
|
_session;
|
|
134
151
|
constructor(options) {
|
|
135
152
|
this.instructions = options?.instructions ?? '';
|
|
136
|
-
//
|
|
137
|
-
//
|
|
138
|
-
|
|
139
|
-
const record = {};
|
|
140
|
-
for (const t of options.tools) {
|
|
141
|
-
record[t.name] = t;
|
|
142
|
-
}
|
|
143
|
-
this.tools = record;
|
|
144
|
-
}
|
|
145
|
-
else {
|
|
146
|
-
this.tools = {};
|
|
147
|
-
}
|
|
153
|
+
// Python takes a list; LiveKit agents-js takes a name-keyed object. Both
|
|
154
|
+
// are stored as a name-keyed map.
|
|
155
|
+
this.tools = Object.fromEntries(toolEntries(options?.tools));
|
|
148
156
|
this.userData = options?.userData;
|
|
149
157
|
// Pipeline noop advisories (matching Python behavior)
|
|
150
158
|
if (options?.stt != null) {
|
|
151
|
-
globalNoop.once('agent_stt', "Agent(stt
|
|
159
|
+
globalNoop.once('agent_stt', "Agent({ stt }): ignored. SignalWire's control plane handles speech recognition.");
|
|
152
160
|
}
|
|
153
161
|
if (options?.tts != null) {
|
|
154
|
-
globalNoop.once('agent_tts', "Agent(tts
|
|
162
|
+
globalNoop.once('agent_tts', "Agent({ tts }): ignored. SignalWire's control plane handles text-to-speech.");
|
|
155
163
|
}
|
|
156
164
|
if (options?.vad != null) {
|
|
157
|
-
globalNoop.once('agent_vad', "Agent(vad
|
|
165
|
+
globalNoop.once('agent_vad', "Agent({ vad }): ignored. SignalWire's control plane handles voice activity detection.");
|
|
158
166
|
}
|
|
159
167
|
if (options?.turnDetection != null) {
|
|
160
|
-
globalNoop.once('agent_turn_detection', "Agent(turnDetection
|
|
168
|
+
globalNoop.once('agent_turn_detection', "Agent({ turnDetection }): ignored. SignalWire's control plane handles turn detection.");
|
|
161
169
|
}
|
|
162
170
|
if (options?.mcpServers != null) {
|
|
163
|
-
globalNoop.once('agent_mcp_servers',
|
|
171
|
+
globalNoop.once('agent_mcp_servers', "Agent({ mcpServers }): ignored. LiveWire doesn't support MCP servers; register tools with tool().");
|
|
164
172
|
}
|
|
165
173
|
// Store pipeline hints for later mapping (used by AgentSession.start)
|
|
166
174
|
this._llmHint = options?.llm;
|
|
@@ -182,63 +190,66 @@ export class Agent {
|
|
|
182
190
|
// Lifecycle hooks (override in subclass)
|
|
183
191
|
// ------------------------------------------------------------------
|
|
184
192
|
/**
|
|
185
|
-
*
|
|
186
|
-
*
|
|
193
|
+
* LiveKit lifecycle hook, kept for API compatibility. LiveWire doesn't call
|
|
194
|
+
* it, so an override doesn't run. The default does nothing.
|
|
187
195
|
*/
|
|
188
196
|
async onEnter() { }
|
|
189
197
|
/**
|
|
190
|
-
*
|
|
191
|
-
*
|
|
198
|
+
* LiveKit lifecycle hook, kept for API compatibility. LiveWire doesn't call
|
|
199
|
+
* it, so an override doesn't run. The default does nothing.
|
|
192
200
|
*/
|
|
193
201
|
async onExit() { }
|
|
194
202
|
/**
|
|
195
|
-
*
|
|
196
|
-
*
|
|
197
|
-
* LLM responds — the default is a no-op.
|
|
203
|
+
* LiveKit lifecycle hook, kept for API compatibility. LiveWire doesn't call
|
|
204
|
+
* it, so an override doesn't run. The default does nothing.
|
|
198
205
|
*
|
|
199
206
|
* @param _turnCtx - Turn context (LiveKit shape; passed through opaquely).
|
|
200
207
|
* @param _newMessage - Newly-captured user message.
|
|
201
208
|
*/
|
|
202
209
|
async onUserTurnCompleted(_turnCtx, _newMessage) { }
|
|
203
210
|
// ------------------------------------------------------------------
|
|
204
|
-
// Pipeline nodes
|
|
211
|
+
// Pipeline nodes: each does nothing and logs once (SignalWire handles these)
|
|
205
212
|
// ------------------------------------------------------------------
|
|
206
213
|
/**
|
|
207
|
-
* LiveKit-compatible STT node.
|
|
208
|
-
* handles speech recognition
|
|
214
|
+
* LiveKit-compatible STT node. Does nothing on SignalWire, where the control
|
|
215
|
+
* plane handles speech recognition. Logs a message once.
|
|
209
216
|
*
|
|
210
217
|
* @param _audio - Audio input (ignored).
|
|
211
218
|
* @param _modelSettings - Model settings (ignored).
|
|
212
219
|
*/
|
|
213
220
|
async sttNode(_audio, _modelSettings) {
|
|
214
|
-
globalNoop.once('stt_node', "Agent.sttNode(): SignalWire's control plane handles speech recognition
|
|
221
|
+
globalNoop.once('stt_node', "Agent.sttNode(): does nothing. SignalWire's control plane handles speech recognition.");
|
|
215
222
|
}
|
|
216
223
|
/**
|
|
217
|
-
* LiveKit-compatible LLM node.
|
|
218
|
-
* handles LLM inference
|
|
224
|
+
* LiveKit-compatible LLM node. Does nothing on SignalWire, where the control
|
|
225
|
+
* plane handles LLM inference. Logs a message once.
|
|
219
226
|
*
|
|
220
227
|
* @param _chatCtx - Chat context (ignored).
|
|
221
228
|
* @param _tools - Tool list (ignored).
|
|
222
229
|
* @param _modelSettings - Model settings (ignored).
|
|
223
230
|
*/
|
|
224
231
|
async llmNode(_chatCtx, _tools, _modelSettings) {
|
|
225
|
-
globalNoop.once('llm_node', "Agent.llmNode(): SignalWire's control plane handles LLM inference
|
|
232
|
+
globalNoop.once('llm_node', "Agent.llmNode(): does nothing. SignalWire's control plane handles LLM inference.");
|
|
226
233
|
}
|
|
227
234
|
/**
|
|
228
|
-
* LiveKit-compatible TTS node.
|
|
229
|
-
* handles text-to-speech
|
|
235
|
+
* LiveKit-compatible TTS node. Does nothing on SignalWire, where the control
|
|
236
|
+
* plane handles text-to-speech. Logs a message once.
|
|
230
237
|
*
|
|
231
238
|
* @param _text - Text to synthesise (ignored).
|
|
232
239
|
* @param _modelSettings - Model settings (ignored).
|
|
233
240
|
*/
|
|
234
241
|
async ttsNode(_text, _modelSettings) {
|
|
235
|
-
globalNoop.once('tts_node', "Agent.ttsNode(): SignalWire's control plane handles text-to-speech
|
|
242
|
+
globalNoop.once('tts_node', "Agent.ttsNode(): does nothing. SignalWire's control plane handles text-to-speech.");
|
|
236
243
|
}
|
|
237
244
|
// ------------------------------------------------------------------
|
|
238
245
|
// Dynamic updates
|
|
239
246
|
// ------------------------------------------------------------------
|
|
240
247
|
/**
|
|
241
|
-
*
|
|
248
|
+
* Replace the agent's instructions.
|
|
249
|
+
*
|
|
250
|
+
* This changes the `Agent` object only. A session that has already started
|
|
251
|
+
* keeps the prompt it built; {@link AgentSession.updateAgent} replaces that
|
|
252
|
+
* prompt.
|
|
242
253
|
*
|
|
243
254
|
* @param instructions - New system-instructions string for the agent.
|
|
244
255
|
*/
|
|
@@ -246,29 +257,27 @@ export class Agent {
|
|
|
246
257
|
this.instructions = instructions;
|
|
247
258
|
}
|
|
248
259
|
/**
|
|
249
|
-
*
|
|
260
|
+
* Replace the agent's tool list.
|
|
250
261
|
*
|
|
251
|
-
* Replaces the current tool record with one built from the given
|
|
252
|
-
*
|
|
253
|
-
*
|
|
262
|
+
* Replaces the current tool record with one built from the given tools.
|
|
263
|
+
* This changes the `Agent` object only: tools are registered when
|
|
264
|
+
* {@link AgentSession.start} runs, so a session that has already started
|
|
265
|
+
* keeps its tools.
|
|
254
266
|
*
|
|
255
|
-
* @param tools -
|
|
256
|
-
*
|
|
267
|
+
* @param tools - An array of {@link FunctionTool} definitions, each keyed
|
|
268
|
+
* by its `name`, or an object keyed by tool name (the LiveKit agents-js
|
|
269
|
+
* shape), whose keys become the tool names.
|
|
257
270
|
*/
|
|
258
271
|
async updateTools(tools) {
|
|
259
|
-
|
|
260
|
-
for (const t of tools) {
|
|
261
|
-
record[t.name] = t;
|
|
262
|
-
}
|
|
263
|
-
this.tools = record;
|
|
272
|
+
this.tools = Object.fromEntries(toolEntries(tools));
|
|
264
273
|
}
|
|
265
274
|
}
|
|
266
275
|
// ---------------------------------------------------------------------------
|
|
267
276
|
// RunContext
|
|
268
277
|
// ---------------------------------------------------------------------------
|
|
269
278
|
/**
|
|
270
|
-
* Mirrors a LiveKit `RunContext
|
|
271
|
-
* read the
|
|
279
|
+
* Mirrors a LiveKit `RunContext`. Tool handlers receive one as `context.ctx`,
|
|
280
|
+
* and read the session and its user data from it.
|
|
272
281
|
*/
|
|
273
282
|
export class RunContext {
|
|
274
283
|
/** The owning {@link AgentSession}, when one is bound. */
|
|
@@ -301,11 +310,14 @@ export class RunContext {
|
|
|
301
310
|
// AgentSession
|
|
302
311
|
// ---------------------------------------------------------------------------
|
|
303
312
|
/**
|
|
304
|
-
* Mirrors a LiveKit `AgentSession
|
|
313
|
+
* Mirrors a LiveKit `AgentSession`, and binds an {@link Agent} to SignalWire.
|
|
305
314
|
*
|
|
306
|
-
* Call {@link AgentSession.start} with an `Agent` to
|
|
307
|
-
* {@link AgentBase}
|
|
308
|
-
* accepted for API
|
|
315
|
+
* Call {@link AgentSession.start} with an `Agent` to build an internal
|
|
316
|
+
* {@link AgentBase}. The `stt`, `tts`, `vad`, `turnDetection` and `mcpServers`
|
|
317
|
+
* options are accepted for API compatibility and ignored; each logs a message
|
|
318
|
+
* once. `llm`, `allowInterruptions` and the endpointing delays map to AI
|
|
319
|
+
* params. `minInterruptionDuration` and `preemptiveGeneration` are stored and
|
|
320
|
+
* not used.
|
|
309
321
|
*/
|
|
310
322
|
export class AgentSession {
|
|
311
323
|
_llm;
|
|
@@ -324,7 +336,7 @@ export class AgentSession {
|
|
|
324
336
|
noop = new NoopTracker();
|
|
325
337
|
constructor(options) {
|
|
326
338
|
this._llm = options?.llm;
|
|
327
|
-
this._tools = options?.tools
|
|
339
|
+
this._tools = toolEntries(options?.tools);
|
|
328
340
|
this._userData = (options?.userData ?? {});
|
|
329
341
|
this._allowInterruptions = options?.allowInterruptions ?? true;
|
|
330
342
|
this._minInterruptionDuration = options?.minInterruptionDuration ?? 0.5;
|
|
@@ -333,31 +345,43 @@ export class AgentSession {
|
|
|
333
345
|
this._maxToolSteps = options?.maxToolSteps ?? 3;
|
|
334
346
|
this._preemptiveGeneration = options?.preemptiveGeneration ?? false;
|
|
335
347
|
if (options?.stt != null) {
|
|
336
|
-
this.noop.once('stt', `
|
|
348
|
+
this.noop.once('stt', `AgentSession({ stt: "${options.stt}" }): ignored. SignalWire's control plane handles speech recognition.`);
|
|
337
349
|
}
|
|
338
350
|
if (options?.tts != null) {
|
|
339
|
-
this.noop.once('tts', `
|
|
351
|
+
this.noop.once('tts', `AgentSession({ tts: "${options.tts}" }): ignored. SignalWire's control plane handles text-to-speech.`);
|
|
340
352
|
}
|
|
341
353
|
if (options?.vad != null) {
|
|
342
|
-
this.noop.once('vad', "
|
|
354
|
+
this.noop.once('vad', "AgentSession({ vad }): ignored. SignalWire's control plane handles voice activity detection.");
|
|
343
355
|
}
|
|
344
356
|
if (options?.turnDetection != null) {
|
|
345
|
-
this.noop.once('turn_detection', `
|
|
357
|
+
this.noop.once('turn_detection', `AgentSession({ turnDetection: "${options.turnDetection}" }): ignored. SignalWire's control plane handles turn detection.`);
|
|
346
358
|
}
|
|
347
359
|
if (options?.mcpServers != null) {
|
|
348
|
-
this.noop.once('mcp_servers',
|
|
360
|
+
this.noop.once('mcp_servers', "AgentSession({ mcpServers }): ignored. LiveWire doesn't support MCP servers; register tools with tool().");
|
|
349
361
|
}
|
|
350
362
|
if (options?.maxToolSteps != null && options.maxToolSteps !== 3) {
|
|
351
|
-
this.noop.once('max_tool_steps', `AgentSession(maxToolSteps
|
|
363
|
+
this.noop.once('max_tool_steps', `AgentSession({ maxToolSteps: ${options.maxToolSteps} }): ignored. SignalWire's control plane handles tool execution depth.`);
|
|
352
364
|
}
|
|
353
365
|
}
|
|
354
366
|
/**
|
|
355
|
-
* Start the session by binding the agent to a
|
|
356
|
-
*
|
|
367
|
+
* Start the session by binding the agent to a new {@link AgentBase}, and map
|
|
368
|
+
* LiveKit-style options onto SignalWire AI params.
|
|
357
369
|
*
|
|
358
|
-
*
|
|
359
|
-
*
|
|
360
|
-
*
|
|
370
|
+
* The `AgentBase` gets the agent's instructions as its prompt, and a tool for
|
|
371
|
+
* each entry in the agent's and the session's tool lists. The `llm` value,
|
|
372
|
+
* a model name or an LLM plugin object such as `plugins.OpenAILLM` whose
|
|
373
|
+
* `model` is used, sets the `model` param, with any `provider/` prefix
|
|
374
|
+
* removed.
|
|
375
|
+
* `allowInterruptions: false` sets the `enable_barge` param to `false`, which
|
|
376
|
+
* turns barge-in off. The minimum and
|
|
377
|
+
* maximum endpointing delays, in seconds, set `end_of_speech_timeout` and
|
|
378
|
+
* `attention_timeout` in milliseconds. Text queued with {@link say} becomes
|
|
379
|
+
* an "Initial Greeting" prompt section.
|
|
380
|
+
*
|
|
381
|
+
* This method doesn't start an HTTP server. Called from an entry function
|
|
382
|
+
* that {@link runApp} runs, it hands the built `AgentBase` to that job, and
|
|
383
|
+
* `runApp()` serves it once the entry function returns. {@link getSwAgent}
|
|
384
|
+
* returns the built `AgentBase`.
|
|
361
385
|
*
|
|
362
386
|
* @param params - Start parameters.
|
|
363
387
|
* @param params.agent - The {@link Agent} to bind.
|
|
@@ -376,10 +400,18 @@ export class AgentSession {
|
|
|
376
400
|
route: '/',
|
|
377
401
|
});
|
|
378
402
|
swAgent.setPromptText(agent.instructions);
|
|
379
|
-
// Map LLM model if provided (session-level takes priority, then agent-level hint)
|
|
403
|
+
// Map LLM model if provided (session-level takes priority, then agent-level hint).
|
|
404
|
+
// An LLM plugin object (plugins.OpenAILLM, inference.LLM) carries its
|
|
405
|
+
// model name in `model`.
|
|
380
406
|
const llmModel = this._llm ?? agent._llmHint;
|
|
381
|
-
|
|
382
|
-
|
|
407
|
+
let model;
|
|
408
|
+
if (typeof llmModel === 'string') {
|
|
409
|
+
model = llmModel;
|
|
410
|
+
}
|
|
411
|
+
else if (llmModel != null && typeof llmModel.model === 'string') {
|
|
412
|
+
model = llmModel.model;
|
|
413
|
+
}
|
|
414
|
+
if (model) {
|
|
383
415
|
const slashIdx = model.indexOf('/');
|
|
384
416
|
if (slashIdx >= 0)
|
|
385
417
|
model = model.slice(slashIdx + 1);
|
|
@@ -391,7 +423,8 @@ export class AgentSession {
|
|
|
391
423
|
allowInterruptions = agent._allowInterruptions;
|
|
392
424
|
}
|
|
393
425
|
if (!allowInterruptions) {
|
|
394
|
-
|
|
426
|
+
// The platform's switch for barge-in; barge_confidence does nothing
|
|
427
|
+
swAgent.setParam('enable_barge', false);
|
|
395
428
|
}
|
|
396
429
|
// Map endpointing delays
|
|
397
430
|
let minEp = this._minEndpointingDelay;
|
|
@@ -409,10 +442,7 @@ export class AgentSession {
|
|
|
409
442
|
swAgent.setParam('attention_timeout', Math.round(maxEp * 1000));
|
|
410
443
|
}
|
|
411
444
|
// Register all tools from the agent + session-level tools
|
|
412
|
-
const allTools = [
|
|
413
|
-
...Object.entries(agent.tools),
|
|
414
|
-
...this._tools.map((t) => [t.name, t]),
|
|
415
|
-
];
|
|
445
|
+
const allTools = [...Object.entries(agent.tools), ...this._tools];
|
|
416
446
|
for (const [name, toolDef] of allTools) {
|
|
417
447
|
const handler = async (args, _rawData) => {
|
|
418
448
|
const ctx = new RunContext(this);
|
|
@@ -435,19 +465,24 @@ export class AgentSession {
|
|
|
435
465
|
swAgent.promptAddSection('Initial Greeting', { body: text });
|
|
436
466
|
}
|
|
437
467
|
this._swAgent = swAgent;
|
|
468
|
+
// Inside a runApp() entry function, hand the agent to that job, which
|
|
469
|
+
// serves it once the entry function returns.
|
|
470
|
+
const job = currentJob.getStore();
|
|
471
|
+
if (job)
|
|
472
|
+
job._swAgent = swAgent;
|
|
438
473
|
}
|
|
439
474
|
/**
|
|
440
|
-
*
|
|
475
|
+
* Add text to the agent's prompt, for the model to use in what it says.
|
|
441
476
|
*
|
|
442
|
-
* Before {@link start}
|
|
443
|
-
*
|
|
444
|
-
*
|
|
477
|
+
* The text isn't spoken verbatim. Before {@link start}, it's queued and added
|
|
478
|
+
* as an "Initial Greeting" prompt section at start time. After start, it's
|
|
479
|
+
* added as a "Say" prompt section.
|
|
445
480
|
*
|
|
446
|
-
* @param text -
|
|
481
|
+
* @param text - Text to add to the prompt.
|
|
447
482
|
*/
|
|
448
483
|
say(text) {
|
|
449
|
-
// If the session
|
|
450
|
-
//
|
|
484
|
+
// If the session has started, add a prompt section now. Otherwise queue
|
|
485
|
+
// the text so start() adds it.
|
|
451
486
|
if (this._swAgent) {
|
|
452
487
|
this._swAgent.promptAddSection('Say', { body: text });
|
|
453
488
|
}
|
|
@@ -456,11 +491,14 @@ export class AgentSession {
|
|
|
456
491
|
}
|
|
457
492
|
}
|
|
458
493
|
/**
|
|
459
|
-
*
|
|
494
|
+
* Add instructions for the agent's reply to its prompt.
|
|
495
|
+
*
|
|
496
|
+
* After {@link start}, `options.instructions` is added as an "Initial
|
|
497
|
+
* Greeting" prompt section. Before start, or without instructions, the call
|
|
498
|
+
* does nothing. It doesn't make the agent speak by itself.
|
|
460
499
|
*
|
|
461
500
|
* @param options - Generation options.
|
|
462
|
-
* @param options.instructions -
|
|
463
|
-
* section before the next LLM turn.
|
|
501
|
+
* @param options.instructions - Instructions added as a prompt section.
|
|
464
502
|
*/
|
|
465
503
|
generateReply(options) {
|
|
466
504
|
if (options?.instructions && this._swAgent) {
|
|
@@ -468,17 +506,18 @@ export class AgentSession {
|
|
|
468
506
|
}
|
|
469
507
|
}
|
|
470
508
|
/**
|
|
471
|
-
* Interrupt current speech.
|
|
472
|
-
*
|
|
509
|
+
* Interrupt current speech. Does nothing on SignalWire, where the control
|
|
510
|
+
* plane handles barge-in. Logs a message once.
|
|
473
511
|
*/
|
|
474
512
|
interrupt() {
|
|
475
|
-
this.noop.once('interrupt', "
|
|
513
|
+
this.noop.once('interrupt', "AgentSession.interrupt(): does nothing. SignalWire's control plane handles barge-in.");
|
|
476
514
|
}
|
|
477
515
|
/**
|
|
478
516
|
* Swap the {@link Agent} bound to this session.
|
|
479
517
|
*
|
|
480
|
-
*
|
|
481
|
-
* agent's instructions.
|
|
518
|
+
* Keeps the underlying `AgentBase` and replaces its prompt with the new
|
|
519
|
+
* agent's instructions. The new agent's tools aren't registered; the tools
|
|
520
|
+
* from {@link start} stay.
|
|
482
521
|
*
|
|
483
522
|
* @param agent - Replacement agent.
|
|
484
523
|
*/
|
|
@@ -496,13 +535,16 @@ export class AgentSession {
|
|
|
496
535
|
set userData(val) {
|
|
497
536
|
this._userData = val;
|
|
498
537
|
}
|
|
499
|
-
/**
|
|
538
|
+
/**
|
|
539
|
+
* Conversation history, kept for API compatibility. LiveWire doesn't record
|
|
540
|
+
* turns, so the array stays empty.
|
|
541
|
+
*/
|
|
500
542
|
get history() {
|
|
501
543
|
return this._history;
|
|
502
544
|
}
|
|
503
545
|
/**
|
|
504
|
-
* Return the underlying SignalWire {@link AgentBase}
|
|
505
|
-
*
|
|
546
|
+
* Return the underlying SignalWire {@link AgentBase}, for tests and for code
|
|
547
|
+
* that needs the full SignalWire API.
|
|
506
548
|
*
|
|
507
549
|
* @returns The wrapped `AgentBase`, or `undefined` before {@link start}.
|
|
508
550
|
*/
|
|
@@ -514,15 +556,22 @@ export class AgentSession {
|
|
|
514
556
|
// tool()
|
|
515
557
|
// ---------------------------------------------------------------------------
|
|
516
558
|
/**
|
|
517
|
-
* Create a tool definition
|
|
559
|
+
* Create a tool definition. Mirrors `llm.tool()` from `@livekit/agents-js`.
|
|
560
|
+
*
|
|
561
|
+
* The returned tool has an empty `name`. It gets its name from its key when
|
|
562
|
+
* you add it to an agent's `tools` object (see the {@link Agent} example), or
|
|
563
|
+
* from the `name` you set when you pass `tools` as an array.
|
|
518
564
|
*
|
|
519
|
-
*
|
|
520
|
-
*
|
|
565
|
+
* `parameters` is stored as given and sent as the tool's SWAIG parameters, so
|
|
566
|
+
* pass a JSON Schema object. A Zod schema isn't converted to JSON Schema.
|
|
567
|
+
*
|
|
568
|
+
* The handler's return value becomes the tool result: a `FunctionResult` as is,
|
|
569
|
+
* a string as the response text, and any other value as JSON text.
|
|
521
570
|
*
|
|
522
571
|
* @typeParam P - Parameter type passed into `execute`.
|
|
523
572
|
* @param options - Tool configuration.
|
|
524
573
|
* @param options.description - Human-readable tool description exposed to the LLM.
|
|
525
|
-
* @param options.parameters - JSON Schema
|
|
574
|
+
* @param options.parameters - JSON Schema object describing the tool's inputs.
|
|
526
575
|
* @param options.execute - Handler invoked when the LLM calls the tool.
|
|
527
576
|
* @returns A {@link FunctionTool} ready to be attached to an agent.
|
|
528
577
|
*/
|
|
@@ -531,8 +580,8 @@ export function tool(options) {
|
|
|
531
580
|
let jsonSchema;
|
|
532
581
|
if (options.parameters) {
|
|
533
582
|
// If it looks like a Zod schema (has a .shape or ._def), try to extract
|
|
534
|
-
if (typeof options.parameters === 'object' && options.parameters
|
|
535
|
-
//
|
|
583
|
+
if (typeof options.parameters === 'object' && '_def' in options.parameters) {
|
|
584
|
+
// A Zod schema is stored as is; it isn't converted to JSON Schema.
|
|
536
585
|
jsonSchema = options.parameters;
|
|
537
586
|
}
|
|
538
587
|
else {
|
|
@@ -543,6 +592,9 @@ export function tool(options) {
|
|
|
543
592
|
name: '', // Filled in when assigned to agent.tools
|
|
544
593
|
description: options.description,
|
|
545
594
|
parameters: jsonSchema,
|
|
595
|
+
// The generic `P` is caller-facing sugar; FunctionTool stores the handler
|
|
596
|
+
// with an `unknown` param. At runtime the platform forwards parsed args
|
|
597
|
+
// verbatim, so widening the param type here is provably safe.
|
|
546
598
|
execute: options.execute,
|
|
547
599
|
};
|
|
548
600
|
}
|
|
@@ -550,7 +602,10 @@ export function tool(options) {
|
|
|
550
602
|
// handoff()
|
|
551
603
|
// ---------------------------------------------------------------------------
|
|
552
604
|
/**
|
|
553
|
-
* Create an {@link AgentHandoff} descriptor for
|
|
605
|
+
* Create an {@link AgentHandoff} descriptor, for LiveKit API compatibility.
|
|
606
|
+
*
|
|
607
|
+
* LiveWire doesn't act on a returned descriptor: the session keeps its agent.
|
|
608
|
+
* To switch agents, call {@link AgentSession.updateAgent}.
|
|
554
609
|
*
|
|
555
610
|
* @param options - Handoff parameters.
|
|
556
611
|
* @param options.agent - Agent to transfer control to.
|
|
@@ -567,14 +622,18 @@ export function handoff(options) {
|
|
|
567
622
|
// ---------------------------------------------------------------------------
|
|
568
623
|
// AgentHandoff / StopResponse / ToolError
|
|
569
624
|
// ---------------------------------------------------------------------------
|
|
570
|
-
/**
|
|
625
|
+
/** A handoff to another agent. LiveWire doesn't act on it; see {@link handoff}. */
|
|
571
626
|
export class AgentHandoff {
|
|
572
627
|
/** Target agent that should take over the conversation. */
|
|
573
628
|
agent;
|
|
574
629
|
/** Optional return value surfaced when the handoff completes. */
|
|
575
630
|
returns;
|
|
576
631
|
}
|
|
577
|
-
/**
|
|
632
|
+
/**
|
|
633
|
+
* LiveKit's signal that a tool shouldn't trigger another LLM reply. LiveWire
|
|
634
|
+
* doesn't handle it specially: a tool that throws it gets the SDK's generic
|
|
635
|
+
* tool error response, like any other exception.
|
|
636
|
+
*/
|
|
578
637
|
export class StopResponse extends Error {
|
|
579
638
|
/**
|
|
580
639
|
* @param message - Optional error message. Defaults to `"StopResponse"`.
|
|
@@ -584,10 +643,14 @@ export class StopResponse extends Error {
|
|
|
584
643
|
this.name = 'StopResponse';
|
|
585
644
|
}
|
|
586
645
|
}
|
|
587
|
-
/**
|
|
646
|
+
/**
|
|
647
|
+
* LiveKit's error for a failed tool. LiveWire doesn't handle it specially: a
|
|
648
|
+
* tool that throws it gets the SDK's generic tool error response, and the
|
|
649
|
+
* message isn't sent to the model.
|
|
650
|
+
*/
|
|
588
651
|
export class ToolError extends Error {
|
|
589
652
|
/**
|
|
590
|
-
* @param message - Error message
|
|
653
|
+
* @param message - Error message (logged; not sent to the model).
|
|
591
654
|
*/
|
|
592
655
|
constructor(message) {
|
|
593
656
|
super(message);
|
|
@@ -598,58 +661,61 @@ export class ToolError extends Error {
|
|
|
598
661
|
// JobProcess
|
|
599
662
|
// ---------------------------------------------------------------------------
|
|
600
663
|
/**
|
|
601
|
-
* Mirrors a LiveKit `JobProcess
|
|
664
|
+
* Mirrors a LiveKit `JobProcess`, passed to the prewarm hook.
|
|
602
665
|
*
|
|
603
|
-
*
|
|
604
|
-
*
|
|
666
|
+
* SignalWire has no worker processes to prewarm, so this class holds only
|
|
667
|
+
* the LiveKit-compatible `userData` object.
|
|
605
668
|
*/
|
|
606
669
|
export class JobProcess {
|
|
607
|
-
/** Mutable
|
|
670
|
+
/** Mutable object for data passed between callbacks. */
|
|
608
671
|
userData = {};
|
|
609
672
|
}
|
|
610
673
|
// ---------------------------------------------------------------------------
|
|
611
674
|
// Room
|
|
612
675
|
// ---------------------------------------------------------------------------
|
|
613
676
|
/**
|
|
614
|
-
* Stub `Room
|
|
677
|
+
* Stub `Room`. SignalWire doesn't use the LiveKit room abstraction.
|
|
615
678
|
*
|
|
616
|
-
*
|
|
617
|
-
*
|
|
679
|
+
* It exists for API compatibility, so LiveKit-shaped code compiles. Its only
|
|
680
|
+
* attribute is a constant name.
|
|
618
681
|
*/
|
|
619
682
|
export class Room {
|
|
620
|
-
/** Always `"livewire-room"
|
|
683
|
+
/** Always `"livewire-room"`; SignalWire has no per-call room identity. */
|
|
621
684
|
name = 'livewire-room';
|
|
622
685
|
}
|
|
623
686
|
// ---------------------------------------------------------------------------
|
|
624
687
|
// JobContext
|
|
625
688
|
// ---------------------------------------------------------------------------
|
|
626
689
|
/**
|
|
627
|
-
* Mirrors a LiveKit `JobContext
|
|
628
|
-
*
|
|
690
|
+
* Mirrors a LiveKit `JobContext`, passed to the entry function that
|
|
691
|
+
* {@link runApp} calls.
|
|
629
692
|
*/
|
|
630
693
|
export class JobContext {
|
|
631
694
|
/** Placeholder {@link Room} (see class docs). */
|
|
632
695
|
room;
|
|
633
|
-
/**
|
|
696
|
+
/** A {@link JobProcess}. `runApp()` creates it separately from the one passed to prewarm. */
|
|
634
697
|
proc;
|
|
635
|
-
/**
|
|
698
|
+
/**
|
|
699
|
+
* @internal The `AgentBase` of the last session started while this job's
|
|
700
|
+
* entry function ran; `runApp()` serves it.
|
|
701
|
+
*/
|
|
636
702
|
_swAgent;
|
|
637
703
|
constructor() {
|
|
638
704
|
this.room = new Room();
|
|
639
705
|
this.proc = new JobProcess();
|
|
640
706
|
}
|
|
641
707
|
/**
|
|
642
|
-
* Connect to the platform.
|
|
643
|
-
*
|
|
708
|
+
* Connect to the platform. Does nothing on SignalWire, where the platform
|
|
709
|
+
* connects when it requests the agent's SWML. Logs a message once.
|
|
644
710
|
*
|
|
645
711
|
* @returns Resolves immediately.
|
|
646
712
|
*/
|
|
647
713
|
async connect() {
|
|
648
|
-
globalNoop.once('connect', "JobContext.connect(): SignalWire
|
|
714
|
+
globalNoop.once('connect', "JobContext.connect(): does nothing. SignalWire connects when it requests the agent's SWML.");
|
|
649
715
|
}
|
|
650
716
|
/**
|
|
651
|
-
* Wait for a participant to join.
|
|
652
|
-
*
|
|
717
|
+
* Wait for a participant to join. On SignalWire it returns a stub
|
|
718
|
+
* participant at once.
|
|
653
719
|
*
|
|
654
720
|
* @param options - Participant match options.
|
|
655
721
|
* @param options.identity - Requested identity; echoed back in the stub.
|
|
@@ -660,21 +726,24 @@ export class JobContext {
|
|
|
660
726
|
return { identity: options?.identity ?? 'caller' };
|
|
661
727
|
}
|
|
662
728
|
}
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
729
|
+
/**
|
|
730
|
+
* The {@link JobContext} whose entry function is running, so that
|
|
731
|
+
* {@link AgentSession.start} can hand its agent to the job for
|
|
732
|
+
* {@link runApp} to serve.
|
|
733
|
+
*/
|
|
734
|
+
const currentJob = new AsyncLocalStorage();
|
|
666
735
|
/**
|
|
667
736
|
* Mirrors `@livekit/agents.defineAgent()`.
|
|
668
737
|
*
|
|
669
|
-
* Packages an entry function
|
|
670
|
-
*
|
|
738
|
+
* Packages an entry function, and an optional prewarm hook, for
|
|
739
|
+
* {@link runApp}. It returns its argument unchanged.
|
|
671
740
|
*
|
|
672
741
|
* @param agent - Entry and (optional) prewarm functions.
|
|
673
742
|
* @param agent.entry - Main callback invoked with a {@link JobContext} when
|
|
674
743
|
* the agent runs.
|
|
675
744
|
* @param agent.prewarm - Optional prewarm callback invoked with a
|
|
676
745
|
* {@link JobProcess} before `entry`.
|
|
677
|
-
* @returns The same
|
|
746
|
+
* @returns The same object.
|
|
678
747
|
*/
|
|
679
748
|
export function defineAgent(agent) {
|
|
680
749
|
return agent;
|
|
@@ -685,47 +754,74 @@ export function defineAgent(agent) {
|
|
|
685
754
|
/**
|
|
686
755
|
* Mirrors `cli.runApp()` from `@livekit/agents-js`.
|
|
687
756
|
*
|
|
757
|
+
* It takes these steps:
|
|
758
|
+
*
|
|
688
759
|
* 1. Prints the LiveWire banner
|
|
689
|
-
* 2. Runs the
|
|
690
|
-
* 3. Creates a
|
|
760
|
+
* 2. Runs the prewarm callback, if any, with a new {@link JobProcess}
|
|
761
|
+
* 3. Creates a new {@link JobContext}
|
|
691
762
|
* 4. Prints a random tip
|
|
692
|
-
* 5.
|
|
693
|
-
* 6.
|
|
694
|
-
*
|
|
763
|
+
* 5. Calls the entry function with the context
|
|
764
|
+
* 6. When the entry function resolves, serves the `AgentBase` of the last
|
|
765
|
+
* {@link AgentSession} the entry function started, by calling its
|
|
766
|
+
* `serve()`. The server listens on `PORT` (default 3000), with the route
|
|
767
|
+
* `/`, and runs until the process exits.
|
|
695
768
|
*
|
|
696
|
-
*
|
|
697
|
-
*
|
|
769
|
+
* It accepts an object `{ entry, prewarm? }`, a bare entry function, or an
|
|
770
|
+
* {@link AgentServer} instance. Errors from the entry function are written to
|
|
771
|
+
* stderr, as is a message when the entry function starts no session.
|
|
772
|
+
*
|
|
773
|
+
* When `SWAIG_CLI_MODE=true` is set as `runApp()` is called (the `swaig-test`
|
|
774
|
+
* CLI sets it while it imports an agent file), the entry function runs and
|
|
775
|
+
* nothing is served.
|
|
698
776
|
*
|
|
699
777
|
* @param options - Agent descriptor, entry function, or `AgentServer`.
|
|
700
778
|
*/
|
|
701
779
|
export function runApp(options) {
|
|
702
780
|
printBanner();
|
|
703
|
-
// If passed an AgentServer instance, convert it to an agentDef-compatible object
|
|
781
|
+
// If passed an AgentServer instance, convert it to an agentDef-compatible object.
|
|
782
|
+
// Otherwise the value is an AgentDefinition, a bare entry function, or a
|
|
783
|
+
// wrapper carrying `.agent`, each detected by its shape.
|
|
704
784
|
const agentDef = options instanceof AgentServer
|
|
705
785
|
? options._toAgentDef()
|
|
706
786
|
: (options?.agent ?? options);
|
|
707
787
|
// Run prewarm if registered
|
|
708
|
-
|
|
788
|
+
const def = agentDef;
|
|
789
|
+
if (def?.prewarm) {
|
|
709
790
|
const proc = new JobProcess();
|
|
710
|
-
globalNoop.once('prewarm', "prewarm:
|
|
711
|
-
|
|
791
|
+
globalNoop.once('prewarm', "prewarm: the callback runs, but SignalWire's control plane manages media infrastructure, so there are no worker processes to prewarm.");
|
|
792
|
+
def.prewarm(proc);
|
|
712
793
|
}
|
|
713
794
|
// Create a JobContext
|
|
714
795
|
const ctx = new JobContext();
|
|
715
796
|
// Print a random tip
|
|
716
797
|
printTip();
|
|
717
|
-
//
|
|
718
|
-
|
|
798
|
+
// Read now: swaig-test sets SWAIG_CLI_MODE only while it imports the agent
|
|
799
|
+
// file, and the entry function's session is built after that.
|
|
800
|
+
const cliMode = process.env['SWAIG_CLI_MODE'] === 'true';
|
|
801
|
+
// Call the entry function. A session started inside it hands its agent to
|
|
802
|
+
// ctx (see AgentSession.start).
|
|
803
|
+
const entryFn = def?.entry ?? agentDef;
|
|
719
804
|
if (typeof entryFn === 'function') {
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
805
|
+
let result;
|
|
806
|
+
try {
|
|
807
|
+
result = currentJob.run(ctx, () => entryFn(ctx));
|
|
808
|
+
}
|
|
809
|
+
catch (err) {
|
|
810
|
+
result = Promise.reject(err);
|
|
811
|
+
}
|
|
812
|
+
Promise.resolve(result)
|
|
813
|
+
.then(() => {
|
|
814
|
+
// After entry completes, serve the AgentBase stored on ctx, if any.
|
|
815
|
+
if (!ctx._swAgent) {
|
|
816
|
+
process.stderr.write('[LiveWire] no agent was started: call session.start({ agent }) in the entry function.\n');
|
|
817
|
+
}
|
|
818
|
+
else if (!cliMode) {
|
|
819
|
+
ctx._swAgent.serve().catch((err) => {
|
|
725
820
|
process.stderr.write(`[LiveWire] agent error: ${err.message}\n`);
|
|
726
821
|
});
|
|
727
822
|
}
|
|
728
|
-
})
|
|
823
|
+
})
|
|
824
|
+
.catch((err) => {
|
|
729
825
|
process.stderr.write(`[LiveWire] entry function error: ${err.message}\n`);
|
|
730
826
|
});
|
|
731
827
|
}
|
|
@@ -736,7 +832,7 @@ export function runApp(options) {
|
|
|
736
832
|
/**
|
|
737
833
|
* Stub class mirroring LiveKit's `WorkerOptions`.
|
|
738
834
|
*
|
|
739
|
-
* Accepts any configuration for source
|
|
835
|
+
* Accepts any configuration, for source compatibility with LiveKit code.
|
|
740
836
|
* SignalWire ignores these settings.
|
|
741
837
|
*/
|
|
742
838
|
export class WorkerOptions {
|
|
@@ -746,7 +842,7 @@ export class WorkerOptions {
|
|
|
746
842
|
/**
|
|
747
843
|
* Stub class mirroring LiveKit's `ServerOptions`.
|
|
748
844
|
*
|
|
749
|
-
* Accepts any configuration for source
|
|
845
|
+
* Accepts any configuration, for source compatibility with LiveKit code.
|
|
750
846
|
* SignalWire ignores these settings.
|
|
751
847
|
*/
|
|
752
848
|
export class ServerOptions {
|
|
@@ -757,7 +853,8 @@ export class ServerOptions {
|
|
|
757
853
|
// AgentServer
|
|
758
854
|
// ---------------------------------------------------------------------------
|
|
759
855
|
/**
|
|
760
|
-
* Mirrors a LiveKit AgentServer
|
|
856
|
+
* Mirrors a LiveKit AgentServer: registers an entry function for
|
|
857
|
+
* {@link runApp}.
|
|
761
858
|
*
|
|
762
859
|
* Usage:
|
|
763
860
|
* const server = new AgentServer();
|
|
@@ -772,7 +869,7 @@ export class ServerOptions {
|
|
|
772
869
|
* cli.runApp(server);
|
|
773
870
|
*/
|
|
774
871
|
export class AgentServer {
|
|
775
|
-
/** Optional prewarm hook called before the
|
|
872
|
+
/** Optional prewarm hook, called before the entry function. Mirrors Python's `setup_fnc`. */
|
|
776
873
|
setupFnc;
|
|
777
874
|
/** @internal Registered entrypoint function. */
|
|
778
875
|
_entryFn;
|
|
@@ -798,11 +895,11 @@ export class AgentServer {
|
|
|
798
895
|
resolvedOpts = opts;
|
|
799
896
|
}
|
|
800
897
|
else {
|
|
801
|
-
// fnOrOpts is an options object (or undefined)
|
|
898
|
+
// fnOrOpts is an options object (or undefined): parameterized decorator usage
|
|
802
899
|
resolvedOpts = fnOrOpts;
|
|
803
900
|
}
|
|
804
901
|
if (resolvedOpts?.type && resolvedOpts.type !== 'room') {
|
|
805
|
-
globalNoop.once('server_type', `AgentServer.rtcSession(type
|
|
902
|
+
globalNoop.once('server_type', `AgentServer.rtcSession({ type: ${JSON.stringify(resolvedOpts.type)} }): ignored. SignalWire's control plane handles server topology.`);
|
|
806
903
|
}
|
|
807
904
|
const register = (entryFn) => {
|
|
808
905
|
this._entryFn = entryFn;
|
|
@@ -830,25 +927,27 @@ export class AgentServer {
|
|
|
830
927
|
/**
|
|
831
928
|
* Stub providers matching common LiveKit plugin packages.
|
|
832
929
|
*
|
|
833
|
-
* None of these do anything
|
|
930
|
+
* None of these do anything. They exist so LiveKit code that imports and
|
|
834
931
|
* constructs these classes still compiles and runs under SignalWire. The
|
|
835
|
-
* first construction of
|
|
932
|
+
* first construction of most of them logs a message to stderr.
|
|
836
933
|
*/
|
|
934
|
+
// eslint-disable-next-line @typescript-eslint/no-namespace -- LiveKit-compat namespace; preserves the exact public API shape (value + type access for `plugins.X`)
|
|
837
935
|
export var plugins;
|
|
838
936
|
(function (plugins) {
|
|
839
|
-
/** LiveKit Deepgram-STT plugin stub.
|
|
937
|
+
/** LiveKit Deepgram-STT plugin stub. Does nothing on SignalWire. */
|
|
840
938
|
class DeepgramSTT {
|
|
841
939
|
/** @param _opts - Deepgram options (ignored). */
|
|
842
940
|
constructor(_opts) {
|
|
843
|
-
globalNoop.once('stt_plugin',
|
|
941
|
+
globalNoop.once('stt_plugin', "DeepgramSTT: ignored. SignalWire's control plane handles speech recognition.");
|
|
844
942
|
}
|
|
845
943
|
}
|
|
846
944
|
plugins.DeepgramSTT = DeepgramSTT;
|
|
847
945
|
/**
|
|
848
946
|
* LiveKit OpenAI-LLM plugin stub.
|
|
849
947
|
*
|
|
850
|
-
*
|
|
851
|
-
*
|
|
948
|
+
* Captures the `model` string. Passed as the `llm` option of
|
|
949
|
+
* `AgentSession` or `Agent`, it sets the `model` AI param. Other options
|
|
950
|
+
* are ignored.
|
|
852
951
|
*/
|
|
853
952
|
class OpenAILLM {
|
|
854
953
|
/** Model identifier captured from the constructor options. */
|
|
@@ -856,40 +955,40 @@ export var plugins;
|
|
|
856
955
|
/** @param _opts - OpenAI options. `_opts.model` is captured; everything else ignored. */
|
|
857
956
|
constructor(_opts) {
|
|
858
957
|
this.model = _opts?.model ?? '';
|
|
859
|
-
globalNoop.once('openai_llm',
|
|
958
|
+
globalNoop.once('openai_llm', "OpenAILLM(): only its model option is used, to set the model AI param. SignalWire's control plane runs the LLM.");
|
|
860
959
|
}
|
|
861
960
|
}
|
|
862
961
|
plugins.OpenAILLM = OpenAILLM;
|
|
863
|
-
/** LiveKit Cartesia-TTS plugin stub.
|
|
962
|
+
/** LiveKit Cartesia-TTS plugin stub. Does nothing on SignalWire. */
|
|
864
963
|
class CartesiaTTS {
|
|
865
964
|
/** @param _opts - Cartesia options (ignored). */
|
|
866
965
|
constructor(_opts) {
|
|
867
|
-
globalNoop.once('cartesia_tts', "CartesiaTTS: SignalWire's control plane handles
|
|
966
|
+
globalNoop.once('cartesia_tts', "CartesiaTTS: ignored. SignalWire's control plane handles text-to-speech.");
|
|
868
967
|
}
|
|
869
968
|
}
|
|
870
969
|
plugins.CartesiaTTS = CartesiaTTS;
|
|
871
|
-
/** LiveKit ElevenLabs-TTS plugin stub.
|
|
970
|
+
/** LiveKit ElevenLabs-TTS plugin stub. Does nothing on SignalWire. */
|
|
872
971
|
class ElevenLabsTTS {
|
|
873
972
|
/** @param _opts - ElevenLabs options (ignored). */
|
|
874
973
|
constructor(_opts) {
|
|
875
|
-
globalNoop.once('elevenlabs_tts', "ElevenLabsTTS: SignalWire's control plane handles
|
|
974
|
+
globalNoop.once('elevenlabs_tts', "ElevenLabsTTS: ignored. SignalWire's control plane handles text-to-speech.");
|
|
876
975
|
}
|
|
877
976
|
}
|
|
878
977
|
plugins.ElevenLabsTTS = ElevenLabsTTS;
|
|
879
|
-
/** LiveKit Silero-VAD plugin stub.
|
|
978
|
+
/** LiveKit Silero-VAD plugin stub. Does nothing on SignalWire. */
|
|
880
979
|
class SileroVAD {
|
|
881
980
|
/** @param _opts - Silero VAD options (ignored). */
|
|
882
981
|
constructor(_opts) { }
|
|
883
982
|
/**
|
|
884
983
|
* Load a Silero VAD model.
|
|
885
984
|
*
|
|
886
|
-
*
|
|
887
|
-
*
|
|
985
|
+
* Does nothing on SignalWire: returns a new stub instance, and logs a
|
|
986
|
+
* message to stderr once.
|
|
888
987
|
*
|
|
889
988
|
* @returns A new `SileroVAD` stub.
|
|
890
989
|
*/
|
|
891
990
|
static load() {
|
|
892
|
-
globalNoop.once('vad_plugin', "SileroVAD.load(): SignalWire's control plane handles voice activity detection
|
|
991
|
+
globalNoop.once('vad_plugin', "SileroVAD.load(): ignored. SignalWire's control plane handles voice activity detection.");
|
|
893
992
|
return new SileroVAD();
|
|
894
993
|
}
|
|
895
994
|
}
|
|
@@ -901,10 +1000,11 @@ export var plugins;
|
|
|
901
1000
|
/**
|
|
902
1001
|
* Stub inference types matching LiveKit's `inference` namespace.
|
|
903
1002
|
*
|
|
904
|
-
* None of these run inference on the client
|
|
905
|
-
*
|
|
906
|
-
*
|
|
1003
|
+
* None of these run inference on the client. SignalWire runs STT, LLM and TTS
|
|
1004
|
+
* in its control plane. These classes exist so LiveKit code that imports and
|
|
1005
|
+
* constructs them still compiles.
|
|
907
1006
|
*/
|
|
1007
|
+
// eslint-disable-next-line @typescript-eslint/no-namespace -- LiveKit-compat namespace; preserves the exact public API shape (value + type access for `inference.X`)
|
|
908
1008
|
export var inference;
|
|
909
1009
|
(function (inference) {
|
|
910
1010
|
/** LiveKit inference-STT stub. Captures the model name; runs no inference locally. */
|
|
@@ -917,11 +1017,14 @@ export var inference;
|
|
|
917
1017
|
*/
|
|
918
1018
|
constructor(model = '', _opts) {
|
|
919
1019
|
this.model = model;
|
|
920
|
-
globalNoop.once('inference_stt',
|
|
1020
|
+
globalNoop.once('inference_stt', "inference.STT: ignored. SignalWire's control plane handles speech recognition.");
|
|
921
1021
|
}
|
|
922
1022
|
}
|
|
923
1023
|
inference.STT = STT;
|
|
924
|
-
/**
|
|
1024
|
+
/**
|
|
1025
|
+
* LiveKit inference-LLM stub. Captures the model name; runs no inference
|
|
1026
|
+
* locally. Passed as the `llm` option, it sets the `model` AI param.
|
|
1027
|
+
*/
|
|
925
1028
|
class LLM {
|
|
926
1029
|
/** Model identifier captured from the constructor. */
|
|
927
1030
|
model;
|
|
@@ -944,7 +1047,7 @@ export var inference;
|
|
|
944
1047
|
*/
|
|
945
1048
|
constructor(model = '', _opts) {
|
|
946
1049
|
this.model = model;
|
|
947
|
-
globalNoop.once('inference_tts',
|
|
1050
|
+
globalNoop.once('inference_tts', "inference.TTS: ignored. SignalWire's control plane handles text-to-speech.");
|
|
948
1051
|
}
|
|
949
1052
|
}
|
|
950
1053
|
inference.TTS = TTS;
|