@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.d.ts
CHANGED
|
@@ -1,19 +1,19 @@
|
|
|
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
10
|
import { AgentBase } from '../AgentBase.js';
|
|
11
11
|
declare const banner = "\n __ _ _ ___\n / / (_) _____ | | / (_)_______\n / / / / | / / _ \\ | | /| / / / ___/ _ \\\n / /___/ /| |/ / __/ | |/ |/ / / / / __/\n/_____/_/ |___/\\___/ |__/|__/_/_/ \\___/\n\n LiveKit-compatible agents powered by SignalWire\n";
|
|
12
12
|
/** Print the ASCII banner to stderr, using ANSI cyan when stderr is a TTY. */
|
|
13
13
|
declare function printBanner(): void;
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
16
|
-
* Exported for tests;
|
|
15
|
+
* "Did you know?" tips. `runApp()` prints one, chosen at random, to stderr.
|
|
16
|
+
* Exported for tests; edit the list to change what's displayed.
|
|
17
17
|
*/
|
|
18
18
|
export declare const tips: string[];
|
|
19
19
|
declare function printTip(): void;
|
|
@@ -48,24 +48,28 @@ export interface VoiceOptions {
|
|
|
48
48
|
}
|
|
49
49
|
/** A tool definition that can be registered on an {@link Agent}. */
|
|
50
50
|
export interface FunctionTool {
|
|
51
|
-
/** Tool name.
|
|
51
|
+
/** Tool name. Set from the key when the tool is passed in a name-keyed `tools` object. */
|
|
52
52
|
name: string;
|
|
53
53
|
/** Human-readable description shown to the LLM. */
|
|
54
54
|
description: string;
|
|
55
55
|
/** JSON schema (or Zod schema passthrough) for the tool's parameters. */
|
|
56
56
|
parameters?: Record<string, unknown>;
|
|
57
57
|
/** Handler invoked by the platform when the LLM calls this tool. */
|
|
58
|
-
execute: (params:
|
|
58
|
+
execute: (params: unknown, context: {
|
|
59
59
|
ctx: RunContext;
|
|
60
|
-
}) =>
|
|
60
|
+
}) => unknown;
|
|
61
61
|
}
|
|
62
62
|
/**
|
|
63
|
-
* Mirrors a LiveKit `voice.Agent
|
|
63
|
+
* Mirrors a LiveKit `voice.Agent`, and holds instructions and tool definitions.
|
|
64
64
|
*
|
|
65
|
-
*
|
|
66
|
-
* for API
|
|
67
|
-
*
|
|
68
|
-
*
|
|
65
|
+
* The `stt`, `tts`, `vad`, `turnDetection` and `mcpServers` options are accepted
|
|
66
|
+
* for API compatibility and ignored, because SignalWire's control plane runs the
|
|
67
|
+
* AI pipeline. Each one logs a message once. `llm` sets the model, and
|
|
68
|
+
* `allowInterruptions` and the endpointing delays map to AI params when
|
|
69
|
+
* {@link AgentSession.start} builds the agent.
|
|
70
|
+
*
|
|
71
|
+
* `tools` takes an object keyed by tool name, as LiveKit agents-js does, or
|
|
72
|
+
* an array of tools that each have a `name`, as the Python SDK does.
|
|
69
73
|
*
|
|
70
74
|
* @example Minimal LiveKit-compatible agent
|
|
71
75
|
* ```ts
|
|
@@ -78,14 +82,14 @@ export interface FunctionTool {
|
|
|
78
82
|
*
|
|
79
83
|
* const agent = new livewire.Agent({
|
|
80
84
|
* instructions: 'You are a friendly helper.',
|
|
81
|
-
* tools:
|
|
85
|
+
* tools: { time: timeTool },
|
|
82
86
|
* });
|
|
83
87
|
*
|
|
84
88
|
* const session = new livewire.AgentSession();
|
|
85
89
|
* await session.start({ agent });
|
|
86
90
|
* ```
|
|
87
91
|
*/
|
|
88
|
-
export declare class Agent<UserData =
|
|
92
|
+
export declare class Agent<UserData = unknown> {
|
|
89
93
|
/** System instructions passed through to the SignalWire AI prompt. */
|
|
90
94
|
instructions: string;
|
|
91
95
|
/** Registered tools keyed by name. Mutated by {@link updateTools}. */
|
|
@@ -103,7 +107,7 @@ export declare class Agent<UserData = any> {
|
|
|
103
107
|
private _session?;
|
|
104
108
|
constructor(options?: {
|
|
105
109
|
instructions?: string;
|
|
106
|
-
tools?: FunctionTool[]
|
|
110
|
+
tools?: FunctionTool[] | Record<string, FunctionTool>;
|
|
107
111
|
userData?: UserData;
|
|
108
112
|
chatCtx?: unknown;
|
|
109
113
|
stt?: unknown;
|
|
@@ -120,35 +124,34 @@ export declare class Agent<UserData = any> {
|
|
|
120
124
|
get session(): AgentSession<UserData> | undefined;
|
|
121
125
|
set session(value: AgentSession<UserData> | undefined);
|
|
122
126
|
/**
|
|
123
|
-
*
|
|
124
|
-
*
|
|
127
|
+
* LiveKit lifecycle hook, kept for API compatibility. LiveWire doesn't call
|
|
128
|
+
* it, so an override doesn't run. The default does nothing.
|
|
125
129
|
*/
|
|
126
130
|
onEnter(): Promise<void>;
|
|
127
131
|
/**
|
|
128
|
-
*
|
|
129
|
-
*
|
|
132
|
+
* LiveKit lifecycle hook, kept for API compatibility. LiveWire doesn't call
|
|
133
|
+
* it, so an override doesn't run. The default does nothing.
|
|
130
134
|
*/
|
|
131
135
|
onExit(): Promise<void>;
|
|
132
136
|
/**
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
* LLM responds — the default is a no-op.
|
|
137
|
+
* LiveKit lifecycle hook, kept for API compatibility. LiveWire doesn't call
|
|
138
|
+
* it, so an override doesn't run. The default does nothing.
|
|
136
139
|
*
|
|
137
140
|
* @param _turnCtx - Turn context (LiveKit shape; passed through opaquely).
|
|
138
141
|
* @param _newMessage - Newly-captured user message.
|
|
139
142
|
*/
|
|
140
143
|
onUserTurnCompleted(_turnCtx?: unknown, _newMessage?: unknown): Promise<void>;
|
|
141
144
|
/**
|
|
142
|
-
* LiveKit-compatible STT node.
|
|
143
|
-
* handles speech recognition
|
|
145
|
+
* LiveKit-compatible STT node. Does nothing on SignalWire, where the control
|
|
146
|
+
* plane handles speech recognition. Logs a message once.
|
|
144
147
|
*
|
|
145
148
|
* @param _audio - Audio input (ignored).
|
|
146
149
|
* @param _modelSettings - Model settings (ignored).
|
|
147
150
|
*/
|
|
148
151
|
sttNode(_audio?: unknown, _modelSettings?: unknown): Promise<void>;
|
|
149
152
|
/**
|
|
150
|
-
* LiveKit-compatible LLM node.
|
|
151
|
-
* handles LLM inference
|
|
153
|
+
* LiveKit-compatible LLM node. Does nothing on SignalWire, where the control
|
|
154
|
+
* plane handles LLM inference. Logs a message once.
|
|
152
155
|
*
|
|
153
156
|
* @param _chatCtx - Chat context (ignored).
|
|
154
157
|
* @param _tools - Tool list (ignored).
|
|
@@ -156,36 +159,42 @@ export declare class Agent<UserData = any> {
|
|
|
156
159
|
*/
|
|
157
160
|
llmNode(_chatCtx?: unknown, _tools?: unknown, _modelSettings?: unknown): Promise<void>;
|
|
158
161
|
/**
|
|
159
|
-
* LiveKit-compatible TTS node.
|
|
160
|
-
* handles text-to-speech
|
|
162
|
+
* LiveKit-compatible TTS node. Does nothing on SignalWire, where the control
|
|
163
|
+
* plane handles text-to-speech. Logs a message once.
|
|
161
164
|
*
|
|
162
165
|
* @param _text - Text to synthesise (ignored).
|
|
163
166
|
* @param _modelSettings - Model settings (ignored).
|
|
164
167
|
*/
|
|
165
168
|
ttsNode(_text?: unknown, _modelSettings?: unknown): Promise<void>;
|
|
166
169
|
/**
|
|
167
|
-
*
|
|
170
|
+
* Replace the agent's instructions.
|
|
171
|
+
*
|
|
172
|
+
* This changes the `Agent` object only. A session that has already started
|
|
173
|
+
* keeps the prompt it built; {@link AgentSession.updateAgent} replaces that
|
|
174
|
+
* prompt.
|
|
168
175
|
*
|
|
169
176
|
* @param instructions - New system-instructions string for the agent.
|
|
170
177
|
*/
|
|
171
178
|
updateInstructions(instructions: string): Promise<void>;
|
|
172
179
|
/**
|
|
173
|
-
*
|
|
180
|
+
* Replace the agent's tool list.
|
|
174
181
|
*
|
|
175
|
-
* Replaces the current tool record with one built from the given
|
|
176
|
-
*
|
|
177
|
-
*
|
|
182
|
+
* Replaces the current tool record with one built from the given tools.
|
|
183
|
+
* This changes the `Agent` object only: tools are registered when
|
|
184
|
+
* {@link AgentSession.start} runs, so a session that has already started
|
|
185
|
+
* keeps its tools.
|
|
178
186
|
*
|
|
179
|
-
* @param tools -
|
|
180
|
-
*
|
|
187
|
+
* @param tools - An array of {@link FunctionTool} definitions, each keyed
|
|
188
|
+
* by its `name`, or an object keyed by tool name (the LiveKit agents-js
|
|
189
|
+
* shape), whose keys become the tool names.
|
|
181
190
|
*/
|
|
182
|
-
updateTools(tools: FunctionTool[]): Promise<void>;
|
|
191
|
+
updateTools(tools: FunctionTool[] | Record<string, FunctionTool>): Promise<void>;
|
|
183
192
|
}
|
|
184
193
|
/**
|
|
185
|
-
* Mirrors a LiveKit `RunContext
|
|
186
|
-
* read the
|
|
194
|
+
* Mirrors a LiveKit `RunContext`. Tool handlers receive one as `context.ctx`,
|
|
195
|
+
* and read the session and its user data from it.
|
|
187
196
|
*/
|
|
188
|
-
export declare class RunContext<UserData =
|
|
197
|
+
export declare class RunContext<UserData = unknown> {
|
|
189
198
|
/** The owning {@link AgentSession}, when one is bound. */
|
|
190
199
|
session?: AgentSession<UserData>;
|
|
191
200
|
/** Opaque speech-turn handle (LiveKit shape; passed through untouched). */
|
|
@@ -210,13 +219,16 @@ export declare class RunContext<UserData = any> {
|
|
|
210
219
|
get userData(): UserData;
|
|
211
220
|
}
|
|
212
221
|
/**
|
|
213
|
-
* Mirrors a LiveKit `AgentSession
|
|
222
|
+
* Mirrors a LiveKit `AgentSession`, and binds an {@link Agent} to SignalWire.
|
|
214
223
|
*
|
|
215
|
-
* Call {@link AgentSession.start} with an `Agent` to
|
|
216
|
-
* {@link AgentBase}
|
|
217
|
-
* accepted for API
|
|
224
|
+
* Call {@link AgentSession.start} with an `Agent` to build an internal
|
|
225
|
+
* {@link AgentBase}. The `stt`, `tts`, `vad`, `turnDetection` and `mcpServers`
|
|
226
|
+
* options are accepted for API compatibility and ignored; each logs a message
|
|
227
|
+
* once. `llm`, `allowInterruptions` and the endpointing delays map to AI
|
|
228
|
+
* params. `minInterruptionDuration` and `preemptiveGeneration` are stored and
|
|
229
|
+
* not used.
|
|
218
230
|
*/
|
|
219
|
-
export declare class AgentSession<UserData =
|
|
231
|
+
export declare class AgentSession<UserData = unknown> {
|
|
220
232
|
private _llm;
|
|
221
233
|
private _tools;
|
|
222
234
|
private _userData;
|
|
@@ -232,12 +244,12 @@ export declare class AgentSession<UserData = any> {
|
|
|
232
244
|
private _sayQueue;
|
|
233
245
|
private noop;
|
|
234
246
|
constructor(options?: {
|
|
235
|
-
stt?:
|
|
236
|
-
tts?:
|
|
237
|
-
llm?:
|
|
238
|
-
vad?:
|
|
239
|
-
turnDetection?:
|
|
240
|
-
tools?: FunctionTool[]
|
|
247
|
+
stt?: unknown;
|
|
248
|
+
tts?: unknown;
|
|
249
|
+
llm?: unknown;
|
|
250
|
+
vad?: unknown;
|
|
251
|
+
turnDetection?: unknown;
|
|
252
|
+
tools?: FunctionTool[] | Record<string, FunctionTool>;
|
|
241
253
|
mcpServers?: unknown;
|
|
242
254
|
userData?: UserData;
|
|
243
255
|
allowInterruptions?: boolean;
|
|
@@ -248,12 +260,24 @@ export declare class AgentSession<UserData = any> {
|
|
|
248
260
|
preemptiveGeneration?: boolean;
|
|
249
261
|
});
|
|
250
262
|
/**
|
|
251
|
-
* Start the session by binding the agent to a
|
|
252
|
-
*
|
|
263
|
+
* Start the session by binding the agent to a new {@link AgentBase}, and map
|
|
264
|
+
* LiveKit-style options onto SignalWire AI params.
|
|
265
|
+
*
|
|
266
|
+
* The `AgentBase` gets the agent's instructions as its prompt, and a tool for
|
|
267
|
+
* each entry in the agent's and the session's tool lists. The `llm` value,
|
|
268
|
+
* a model name or an LLM plugin object such as `plugins.OpenAILLM` whose
|
|
269
|
+
* `model` is used, sets the `model` param, with any `provider/` prefix
|
|
270
|
+
* removed.
|
|
271
|
+
* `allowInterruptions: false` sets the `enable_barge` param to `false`, which
|
|
272
|
+
* turns barge-in off. The minimum and
|
|
273
|
+
* maximum endpointing delays, in seconds, set `end_of_speech_timeout` and
|
|
274
|
+
* `attention_timeout` in milliseconds. Text queued with {@link say} becomes
|
|
275
|
+
* an "Initial Greeting" prompt section.
|
|
253
276
|
*
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
*
|
|
277
|
+
* This method doesn't start an HTTP server. Called from an entry function
|
|
278
|
+
* that {@link runApp} runs, it hands the built `AgentBase` to that job, and
|
|
279
|
+
* `runApp()` serves it once the entry function returns. {@link getSwAgent}
|
|
280
|
+
* returns the built `AgentBase`.
|
|
257
281
|
*
|
|
258
282
|
* @param params - Start parameters.
|
|
259
283
|
* @param params.agent - The {@link Agent} to bind.
|
|
@@ -263,39 +287,43 @@ export declare class AgentSession<UserData = any> {
|
|
|
263
287
|
*/
|
|
264
288
|
start(params: {
|
|
265
289
|
agent: Agent<UserData>;
|
|
266
|
-
room?:
|
|
290
|
+
room?: unknown;
|
|
267
291
|
record?: boolean;
|
|
268
292
|
}): Promise<void>;
|
|
269
293
|
/**
|
|
270
|
-
*
|
|
294
|
+
* Add text to the agent's prompt, for the model to use in what it says.
|
|
271
295
|
*
|
|
272
|
-
* Before {@link start}
|
|
273
|
-
*
|
|
274
|
-
*
|
|
296
|
+
* The text isn't spoken verbatim. Before {@link start}, it's queued and added
|
|
297
|
+
* as an "Initial Greeting" prompt section at start time. After start, it's
|
|
298
|
+
* added as a "Say" prompt section.
|
|
275
299
|
*
|
|
276
|
-
* @param text -
|
|
300
|
+
* @param text - Text to add to the prompt.
|
|
277
301
|
*/
|
|
278
302
|
say(text: string): void;
|
|
279
303
|
/**
|
|
280
|
-
*
|
|
304
|
+
* Add instructions for the agent's reply to its prompt.
|
|
305
|
+
*
|
|
306
|
+
* After {@link start}, `options.instructions` is added as an "Initial
|
|
307
|
+
* Greeting" prompt section. Before start, or without instructions, the call
|
|
308
|
+
* does nothing. It doesn't make the agent speak by itself.
|
|
281
309
|
*
|
|
282
310
|
* @param options - Generation options.
|
|
283
|
-
* @param options.instructions -
|
|
284
|
-
* section before the next LLM turn.
|
|
311
|
+
* @param options.instructions - Instructions added as a prompt section.
|
|
285
312
|
*/
|
|
286
313
|
generateReply(options?: {
|
|
287
314
|
instructions?: string;
|
|
288
315
|
}): void;
|
|
289
316
|
/**
|
|
290
|
-
* Interrupt current speech.
|
|
291
|
-
*
|
|
317
|
+
* Interrupt current speech. Does nothing on SignalWire, where the control
|
|
318
|
+
* plane handles barge-in. Logs a message once.
|
|
292
319
|
*/
|
|
293
320
|
interrupt(): void;
|
|
294
321
|
/**
|
|
295
322
|
* Swap the {@link Agent} bound to this session.
|
|
296
323
|
*
|
|
297
|
-
*
|
|
298
|
-
* agent's instructions.
|
|
324
|
+
* Keeps the underlying `AgentBase` and replaces its prompt with the new
|
|
325
|
+
* agent's instructions. The new agent's tools aren't registered; the tools
|
|
326
|
+
* from {@link start} stay.
|
|
299
327
|
*
|
|
300
328
|
* @param agent - Replacement agent.
|
|
301
329
|
*/
|
|
@@ -303,38 +331,51 @@ export declare class AgentSession<UserData = any> {
|
|
|
303
331
|
/** Current per-session user data. Set by the constructor or via the setter. */
|
|
304
332
|
get userData(): UserData;
|
|
305
333
|
set userData(val: UserData);
|
|
306
|
-
/**
|
|
334
|
+
/**
|
|
335
|
+
* Conversation history, kept for API compatibility. LiveWire doesn't record
|
|
336
|
+
* turns, so the array stays empty.
|
|
337
|
+
*/
|
|
307
338
|
get history(): Array<Record<string, string>>;
|
|
308
339
|
/**
|
|
309
|
-
* Return the underlying SignalWire {@link AgentBase}
|
|
310
|
-
*
|
|
340
|
+
* Return the underlying SignalWire {@link AgentBase}, for tests and for code
|
|
341
|
+
* that needs the full SignalWire API.
|
|
311
342
|
*
|
|
312
343
|
* @returns The wrapped `AgentBase`, or `undefined` before {@link start}.
|
|
313
344
|
*/
|
|
314
345
|
getSwAgent(): AgentBase | undefined;
|
|
315
346
|
}
|
|
316
347
|
/**
|
|
317
|
-
* Create a tool definition
|
|
348
|
+
* Create a tool definition. Mirrors `llm.tool()` from `@livekit/agents-js`.
|
|
349
|
+
*
|
|
350
|
+
* The returned tool has an empty `name`. It gets its name from its key when
|
|
351
|
+
* you add it to an agent's `tools` object (see the {@link Agent} example), or
|
|
352
|
+
* from the `name` you set when you pass `tools` as an array.
|
|
318
353
|
*
|
|
319
|
-
*
|
|
320
|
-
*
|
|
354
|
+
* `parameters` is stored as given and sent as the tool's SWAIG parameters, so
|
|
355
|
+
* pass a JSON Schema object. A Zod schema isn't converted to JSON Schema.
|
|
356
|
+
*
|
|
357
|
+
* The handler's return value becomes the tool result: a `FunctionResult` as is,
|
|
358
|
+
* a string as the response text, and any other value as JSON text.
|
|
321
359
|
*
|
|
322
360
|
* @typeParam P - Parameter type passed into `execute`.
|
|
323
361
|
* @param options - Tool configuration.
|
|
324
362
|
* @param options.description - Human-readable tool description exposed to the LLM.
|
|
325
|
-
* @param options.parameters - JSON Schema
|
|
363
|
+
* @param options.parameters - JSON Schema object describing the tool's inputs.
|
|
326
364
|
* @param options.execute - Handler invoked when the LLM calls the tool.
|
|
327
365
|
* @returns A {@link FunctionTool} ready to be attached to an agent.
|
|
328
366
|
*/
|
|
329
|
-
export declare function tool<P =
|
|
367
|
+
export declare function tool<P = unknown>(options: {
|
|
330
368
|
description: string;
|
|
331
|
-
parameters?:
|
|
369
|
+
parameters?: unknown;
|
|
332
370
|
execute: (params: P, context: {
|
|
333
371
|
ctx: RunContext;
|
|
334
|
-
}) =>
|
|
372
|
+
}) => unknown;
|
|
335
373
|
}): FunctionTool;
|
|
336
374
|
/**
|
|
337
|
-
* Create an {@link AgentHandoff} descriptor for
|
|
375
|
+
* Create an {@link AgentHandoff} descriptor, for LiveKit API compatibility.
|
|
376
|
+
*
|
|
377
|
+
* LiveWire doesn't act on a returned descriptor: the session keeps its agent.
|
|
378
|
+
* To switch agents, call {@link AgentSession.updateAgent}.
|
|
338
379
|
*
|
|
339
380
|
* @param options - Handoff parameters.
|
|
340
381
|
* @param options.agent - Agent to transfer control to.
|
|
@@ -346,69 +387,80 @@ export declare function handoff(options: {
|
|
|
346
387
|
agent: Agent;
|
|
347
388
|
returns?: string;
|
|
348
389
|
}): AgentHandoff;
|
|
349
|
-
/**
|
|
390
|
+
/** A handoff to another agent. LiveWire doesn't act on it; see {@link handoff}. */
|
|
350
391
|
export declare class AgentHandoff {
|
|
351
392
|
/** Target agent that should take over the conversation. */
|
|
352
393
|
agent: Agent;
|
|
353
394
|
/** Optional return value surfaced when the handoff completes. */
|
|
354
395
|
returns?: string;
|
|
355
396
|
}
|
|
356
|
-
/**
|
|
397
|
+
/**
|
|
398
|
+
* LiveKit's signal that a tool shouldn't trigger another LLM reply. LiveWire
|
|
399
|
+
* doesn't handle it specially: a tool that throws it gets the SDK's generic
|
|
400
|
+
* tool error response, like any other exception.
|
|
401
|
+
*/
|
|
357
402
|
export declare class StopResponse extends Error {
|
|
358
403
|
/**
|
|
359
404
|
* @param message - Optional error message. Defaults to `"StopResponse"`.
|
|
360
405
|
*/
|
|
361
406
|
constructor(message?: string);
|
|
362
407
|
}
|
|
363
|
-
/**
|
|
408
|
+
/**
|
|
409
|
+
* LiveKit's error for a failed tool. LiveWire doesn't handle it specially: a
|
|
410
|
+
* tool that throws it gets the SDK's generic tool error response, and the
|
|
411
|
+
* message isn't sent to the model.
|
|
412
|
+
*/
|
|
364
413
|
export declare class ToolError extends Error {
|
|
365
414
|
/**
|
|
366
|
-
* @param message - Error message
|
|
415
|
+
* @param message - Error message (logged; not sent to the model).
|
|
367
416
|
*/
|
|
368
417
|
constructor(message: string);
|
|
369
418
|
}
|
|
370
419
|
/**
|
|
371
|
-
* Mirrors a LiveKit `JobProcess
|
|
420
|
+
* Mirrors a LiveKit `JobProcess`, passed to the prewarm hook.
|
|
372
421
|
*
|
|
373
|
-
*
|
|
374
|
-
*
|
|
422
|
+
* SignalWire has no worker processes to prewarm, so this class holds only
|
|
423
|
+
* the LiveKit-compatible `userData` object.
|
|
375
424
|
*/
|
|
376
425
|
export declare class JobProcess {
|
|
377
|
-
/** Mutable
|
|
378
|
-
userData: Record<string,
|
|
426
|
+
/** Mutable object for data passed between callbacks. */
|
|
427
|
+
userData: Record<string, unknown>;
|
|
379
428
|
}
|
|
380
429
|
/**
|
|
381
|
-
* Stub `Room
|
|
430
|
+
* Stub `Room`. SignalWire doesn't use the LiveKit room abstraction.
|
|
382
431
|
*
|
|
383
|
-
*
|
|
384
|
-
*
|
|
432
|
+
* It exists for API compatibility, so LiveKit-shaped code compiles. Its only
|
|
433
|
+
* attribute is a constant name.
|
|
385
434
|
*/
|
|
386
435
|
export declare class Room {
|
|
387
|
-
/** Always `"livewire-room"
|
|
436
|
+
/** Always `"livewire-room"`; SignalWire has no per-call room identity. */
|
|
388
437
|
readonly name: string;
|
|
389
438
|
}
|
|
390
439
|
/**
|
|
391
|
-
* Mirrors a LiveKit `JobContext
|
|
392
|
-
*
|
|
440
|
+
* Mirrors a LiveKit `JobContext`, passed to the entry function that
|
|
441
|
+
* {@link runApp} calls.
|
|
393
442
|
*/
|
|
394
443
|
export declare class JobContext {
|
|
395
444
|
/** Placeholder {@link Room} (see class docs). */
|
|
396
445
|
room: Room;
|
|
397
|
-
/**
|
|
446
|
+
/** A {@link JobProcess}. `runApp()` creates it separately from the one passed to prewarm. */
|
|
398
447
|
proc: JobProcess;
|
|
399
|
-
/**
|
|
448
|
+
/**
|
|
449
|
+
* @internal The `AgentBase` of the last session started while this job's
|
|
450
|
+
* entry function ran; `runApp()` serves it.
|
|
451
|
+
*/
|
|
400
452
|
_swAgent?: AgentBase;
|
|
401
453
|
constructor();
|
|
402
454
|
/**
|
|
403
|
-
* Connect to the platform.
|
|
404
|
-
*
|
|
455
|
+
* Connect to the platform. Does nothing on SignalWire, where the platform
|
|
456
|
+
* connects when it requests the agent's SWML. Logs a message once.
|
|
405
457
|
*
|
|
406
458
|
* @returns Resolves immediately.
|
|
407
459
|
*/
|
|
408
460
|
connect(): Promise<void>;
|
|
409
461
|
/**
|
|
410
|
-
* Wait for a participant to join.
|
|
411
|
-
*
|
|
462
|
+
* Wait for a participant to join. On SignalWire it returns a stub
|
|
463
|
+
* participant at once.
|
|
412
464
|
*
|
|
413
465
|
* @param options - Participant match options.
|
|
414
466
|
* @param options.identity - Requested identity; echoed back in the stub.
|
|
@@ -417,67 +469,85 @@ export declare class JobContext {
|
|
|
417
469
|
*/
|
|
418
470
|
waitForParticipant(options?: {
|
|
419
471
|
identity?: string;
|
|
420
|
-
}): Promise<
|
|
472
|
+
}): Promise<{
|
|
473
|
+
identity: string;
|
|
474
|
+
}>;
|
|
475
|
+
}
|
|
476
|
+
/**
|
|
477
|
+
* A LiveKit-compatible agent definition: a required `entry` callback and an
|
|
478
|
+
* optional `prewarm` hook. The `prewarm` return value is ignored.
|
|
479
|
+
*/
|
|
480
|
+
export interface AgentDefinition {
|
|
481
|
+
/** Main callback invoked with a {@link JobContext} when the agent runs. */
|
|
482
|
+
entry: (ctx: JobContext) => Promise<void>;
|
|
483
|
+
/** Optional prewarm callback invoked with a {@link JobProcess} before `entry`. */
|
|
484
|
+
prewarm?: (proc: JobProcess) => unknown;
|
|
421
485
|
}
|
|
422
486
|
/**
|
|
423
487
|
* Mirrors `@livekit/agents.defineAgent()`.
|
|
424
488
|
*
|
|
425
|
-
* Packages an entry function
|
|
426
|
-
*
|
|
489
|
+
* Packages an entry function, and an optional prewarm hook, for
|
|
490
|
+
* {@link runApp}. It returns its argument unchanged.
|
|
427
491
|
*
|
|
428
492
|
* @param agent - Entry and (optional) prewarm functions.
|
|
429
493
|
* @param agent.entry - Main callback invoked with a {@link JobContext} when
|
|
430
494
|
* the agent runs.
|
|
431
495
|
* @param agent.prewarm - Optional prewarm callback invoked with a
|
|
432
496
|
* {@link JobProcess} before `entry`.
|
|
433
|
-
* @returns The same
|
|
497
|
+
* @returns The same object.
|
|
434
498
|
*/
|
|
435
|
-
export declare function defineAgent(agent:
|
|
436
|
-
entry: (ctx: JobContext) => Promise<void>;
|
|
437
|
-
prewarm?: (proc: JobProcess) => any;
|
|
438
|
-
}): {
|
|
439
|
-
entry: (ctx: JobContext) => Promise<void>;
|
|
440
|
-
prewarm?: (proc: JobProcess) => any;
|
|
441
|
-
};
|
|
499
|
+
export declare function defineAgent(agent: AgentDefinition): AgentDefinition;
|
|
442
500
|
/**
|
|
443
501
|
* Mirrors `cli.runApp()` from `@livekit/agents-js`.
|
|
444
502
|
*
|
|
503
|
+
* It takes these steps:
|
|
504
|
+
*
|
|
445
505
|
* 1. Prints the LiveWire banner
|
|
446
|
-
* 2. Runs the
|
|
447
|
-
* 3. Creates a
|
|
506
|
+
* 2. Runs the prewarm callback, if any, with a new {@link JobProcess}
|
|
507
|
+
* 3. Creates a new {@link JobContext}
|
|
448
508
|
* 4. Prints a random tip
|
|
449
|
-
* 5.
|
|
450
|
-
* 6.
|
|
451
|
-
*
|
|
509
|
+
* 5. Calls the entry function with the context
|
|
510
|
+
* 6. When the entry function resolves, serves the `AgentBase` of the last
|
|
511
|
+
* {@link AgentSession} the entry function started, by calling its
|
|
512
|
+
* `serve()`. The server listens on `PORT` (default 3000), with the route
|
|
513
|
+
* `/`, and runs until the process exits.
|
|
514
|
+
*
|
|
515
|
+
* It accepts an object `{ entry, prewarm? }`, a bare entry function, or an
|
|
516
|
+
* {@link AgentServer} instance. Errors from the entry function are written to
|
|
517
|
+
* stderr, as is a message when the entry function starts no session.
|
|
452
518
|
*
|
|
453
|
-
*
|
|
454
|
-
* an
|
|
519
|
+
* When `SWAIG_CLI_MODE=true` is set as `runApp()` is called (the `swaig-test`
|
|
520
|
+
* CLI sets it while it imports an agent file), the entry function runs and
|
|
521
|
+
* nothing is served.
|
|
455
522
|
*
|
|
456
523
|
* @param options - Agent descriptor, entry function, or `AgentServer`.
|
|
457
524
|
*/
|
|
458
|
-
export declare function runApp(options:
|
|
525
|
+
export declare function runApp(options: AgentServer | AgentDefinition | ((ctx: JobContext) => unknown) | {
|
|
526
|
+
agent?: AgentDefinition;
|
|
527
|
+
} | undefined): void;
|
|
459
528
|
/**
|
|
460
529
|
* Stub class mirroring LiveKit's `WorkerOptions`.
|
|
461
530
|
*
|
|
462
|
-
* Accepts any configuration for source
|
|
531
|
+
* Accepts any configuration, for source compatibility with LiveKit code.
|
|
463
532
|
* SignalWire ignores these settings.
|
|
464
533
|
*/
|
|
465
534
|
export declare class WorkerOptions {
|
|
466
535
|
/** @param _opts - LiveKit-shaped worker options (ignored). */
|
|
467
|
-
constructor(_opts?:
|
|
536
|
+
constructor(_opts?: unknown);
|
|
468
537
|
}
|
|
469
538
|
/**
|
|
470
539
|
* Stub class mirroring LiveKit's `ServerOptions`.
|
|
471
540
|
*
|
|
472
|
-
* Accepts any configuration for source
|
|
541
|
+
* Accepts any configuration, for source compatibility with LiveKit code.
|
|
473
542
|
* SignalWire ignores these settings.
|
|
474
543
|
*/
|
|
475
544
|
export declare class ServerOptions {
|
|
476
545
|
/** @param _opts - LiveKit-shaped server options (ignored). */
|
|
477
|
-
constructor(_opts?:
|
|
546
|
+
constructor(_opts?: unknown);
|
|
478
547
|
}
|
|
479
548
|
/**
|
|
480
|
-
* Mirrors a LiveKit AgentServer
|
|
549
|
+
* Mirrors a LiveKit AgentServer: registers an entry function for
|
|
550
|
+
* {@link runApp}.
|
|
481
551
|
*
|
|
482
552
|
* Usage:
|
|
483
553
|
* const server = new AgentServer();
|
|
@@ -492,13 +562,13 @@ export declare class ServerOptions {
|
|
|
492
562
|
* cli.runApp(server);
|
|
493
563
|
*/
|
|
494
564
|
export declare class AgentServer {
|
|
495
|
-
/** Optional prewarm hook called before the
|
|
565
|
+
/** Optional prewarm hook, called before the entry function. Mirrors Python's `setup_fnc`. */
|
|
496
566
|
setupFnc?: (proc: JobProcess) => void;
|
|
497
567
|
/** @internal Registered entrypoint function. */
|
|
498
568
|
private _entryFn?;
|
|
499
569
|
/** @internal Agent name hint registered via rtcSession(). */
|
|
500
570
|
private _agentName;
|
|
501
|
-
constructor(_opts?:
|
|
571
|
+
constructor(_opts?: unknown);
|
|
502
572
|
/**
|
|
503
573
|
* Decorator that registers the session entrypoint.
|
|
504
574
|
*
|
|
@@ -512,13 +582,13 @@ export declare class AgentServer {
|
|
|
512
582
|
rtcSession(fnOrOpts?: ((ctx: JobContext) => Promise<void>) | {
|
|
513
583
|
agentName?: string;
|
|
514
584
|
type?: string;
|
|
515
|
-
onRequest?: ((...args:
|
|
516
|
-
onSessionEnd?: ((...args:
|
|
585
|
+
onRequest?: ((...args: unknown[]) => unknown) | null;
|
|
586
|
+
onSessionEnd?: ((...args: unknown[]) => unknown) | null;
|
|
517
587
|
}, opts?: {
|
|
518
588
|
agentName?: string;
|
|
519
589
|
type?: string;
|
|
520
|
-
onRequest?: ((...args:
|
|
521
|
-
onSessionEnd?: ((...args:
|
|
590
|
+
onRequest?: ((...args: unknown[]) => unknown) | null;
|
|
591
|
+
onSessionEnd?: ((...args: unknown[]) => unknown) | null;
|
|
522
592
|
}): ((fn: (ctx: JobContext) => Promise<void>) => (ctx: JobContext) => Promise<void>) | void;
|
|
523
593
|
/** @internal Extract agentDef-compatible shape for use by runApp. */
|
|
524
594
|
_toAgentDef(): {
|
|
@@ -529,47 +599,48 @@ export declare class AgentServer {
|
|
|
529
599
|
/**
|
|
530
600
|
* Stub providers matching common LiveKit plugin packages.
|
|
531
601
|
*
|
|
532
|
-
* None of these do anything
|
|
602
|
+
* None of these do anything. They exist so LiveKit code that imports and
|
|
533
603
|
* constructs these classes still compiles and runs under SignalWire. The
|
|
534
|
-
* first construction of
|
|
604
|
+
* first construction of most of them logs a message to stderr.
|
|
535
605
|
*/
|
|
536
606
|
export declare namespace plugins {
|
|
537
|
-
/** LiveKit Deepgram-STT plugin stub.
|
|
607
|
+
/** LiveKit Deepgram-STT plugin stub. Does nothing on SignalWire. */
|
|
538
608
|
class DeepgramSTT {
|
|
539
609
|
/** @param _opts - Deepgram options (ignored). */
|
|
540
|
-
constructor(_opts?:
|
|
610
|
+
constructor(_opts?: unknown);
|
|
541
611
|
}
|
|
542
612
|
/**
|
|
543
613
|
* LiveKit OpenAI-LLM plugin stub.
|
|
544
614
|
*
|
|
545
|
-
*
|
|
546
|
-
*
|
|
615
|
+
* Captures the `model` string. Passed as the `llm` option of
|
|
616
|
+
* `AgentSession` or `Agent`, it sets the `model` AI param. Other options
|
|
617
|
+
* are ignored.
|
|
547
618
|
*/
|
|
548
619
|
class OpenAILLM {
|
|
549
620
|
/** Model identifier captured from the constructor options. */
|
|
550
621
|
model: string;
|
|
551
622
|
/** @param _opts - OpenAI options. `_opts.model` is captured; everything else ignored. */
|
|
552
|
-
constructor(_opts?:
|
|
623
|
+
constructor(_opts?: unknown);
|
|
553
624
|
}
|
|
554
|
-
/** LiveKit Cartesia-TTS plugin stub.
|
|
625
|
+
/** LiveKit Cartesia-TTS plugin stub. Does nothing on SignalWire. */
|
|
555
626
|
class CartesiaTTS {
|
|
556
627
|
/** @param _opts - Cartesia options (ignored). */
|
|
557
|
-
constructor(_opts?:
|
|
628
|
+
constructor(_opts?: unknown);
|
|
558
629
|
}
|
|
559
|
-
/** LiveKit ElevenLabs-TTS plugin stub.
|
|
630
|
+
/** LiveKit ElevenLabs-TTS plugin stub. Does nothing on SignalWire. */
|
|
560
631
|
class ElevenLabsTTS {
|
|
561
632
|
/** @param _opts - ElevenLabs options (ignored). */
|
|
562
|
-
constructor(_opts?:
|
|
633
|
+
constructor(_opts?: unknown);
|
|
563
634
|
}
|
|
564
|
-
/** LiveKit Silero-VAD plugin stub.
|
|
635
|
+
/** LiveKit Silero-VAD plugin stub. Does nothing on SignalWire. */
|
|
565
636
|
class SileroVAD {
|
|
566
637
|
/** @param _opts - Silero VAD options (ignored). */
|
|
567
638
|
constructor(_opts?: Record<string, unknown>);
|
|
568
639
|
/**
|
|
569
640
|
* Load a Silero VAD model.
|
|
570
641
|
*
|
|
571
|
-
*
|
|
572
|
-
*
|
|
642
|
+
* Does nothing on SignalWire: returns a new stub instance, and logs a
|
|
643
|
+
* message to stderr once.
|
|
573
644
|
*
|
|
574
645
|
* @returns A new `SileroVAD` stub.
|
|
575
646
|
*/
|
|
@@ -579,9 +650,9 @@ export declare namespace plugins {
|
|
|
579
650
|
/**
|
|
580
651
|
* Stub inference types matching LiveKit's `inference` namespace.
|
|
581
652
|
*
|
|
582
|
-
* None of these run inference on the client
|
|
583
|
-
*
|
|
584
|
-
*
|
|
653
|
+
* None of these run inference on the client. SignalWire runs STT, LLM and TTS
|
|
654
|
+
* in its control plane. These classes exist so LiveKit code that imports and
|
|
655
|
+
* constructs them still compiles.
|
|
585
656
|
*/
|
|
586
657
|
export declare namespace inference {
|
|
587
658
|
/** LiveKit inference-STT stub. Captures the model name; runs no inference locally. */
|
|
@@ -592,9 +663,12 @@ export declare namespace inference {
|
|
|
592
663
|
* @param model - Model identifier (captured).
|
|
593
664
|
* @param _opts - Additional options (ignored).
|
|
594
665
|
*/
|
|
595
|
-
constructor(model?: string, _opts?:
|
|
666
|
+
constructor(model?: string, _opts?: unknown);
|
|
596
667
|
}
|
|
597
|
-
/**
|
|
668
|
+
/**
|
|
669
|
+
* LiveKit inference-LLM stub. Captures the model name; runs no inference
|
|
670
|
+
* locally. Passed as the `llm` option, it sets the `model` AI param.
|
|
671
|
+
*/
|
|
598
672
|
class LLM {
|
|
599
673
|
/** Model identifier captured from the constructor. */
|
|
600
674
|
model: string;
|
|
@@ -602,7 +676,7 @@ export declare namespace inference {
|
|
|
602
676
|
* @param model - Model identifier (captured).
|
|
603
677
|
* @param _opts - Additional options (ignored).
|
|
604
678
|
*/
|
|
605
|
-
constructor(model?: string, _opts?:
|
|
679
|
+
constructor(model?: string, _opts?: unknown);
|
|
606
680
|
}
|
|
607
681
|
/** LiveKit inference-TTS stub. Captures the model name; runs no inference locally. */
|
|
608
682
|
class TTS {
|
|
@@ -612,7 +686,7 @@ export declare namespace inference {
|
|
|
612
686
|
* @param model - Model identifier (captured).
|
|
613
687
|
* @param _opts - Additional options (ignored).
|
|
614
688
|
*/
|
|
615
|
-
constructor(model?: string, _opts?:
|
|
689
|
+
constructor(model?: string, _opts?: unknown);
|
|
616
690
|
}
|
|
617
691
|
}
|
|
618
692
|
/** LiveKit voice namespace equivalent. */
|