@signalwire/sdk 2.0.5 → 3.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +821 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +510 -126
- package/dist/AgentBase.js +1581 -455
- package/dist/AgentBase.js.map +1 -1
- package/dist/AgentServer.d.ts +21 -0
- package/dist/AgentServer.js +154 -47
- package/dist/AgentServer.js.map +1 -1
- package/dist/AuthHandler.d.ts +14 -2
- package/dist/AuthHandler.js +7 -2
- package/dist/AuthHandler.js.map +1 -1
- package/dist/ConfigLoader.d.ts +5 -13
- package/dist/ConfigLoader.js +15 -29
- package/dist/ConfigLoader.js.map +1 -1
- package/dist/ContextBuilder.d.ts +202 -9
- package/dist/ContextBuilder.js +219 -36
- package/dist/ContextBuilder.js.map +1 -1
- package/dist/DataMap.d.ts +186 -45
- package/dist/DataMap.js +210 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +309 -83
- package/dist/FunctionResult.js +483 -116
- package/dist/FunctionResult.js.map +1 -1
- package/dist/Logger.d.ts +30 -5
- package/dist/Logger.js +77 -19
- package/dist/Logger.js.map +1 -1
- package/dist/POM/PromptObjectModel.d.ts +12 -1
- package/dist/POM/PromptObjectModel.js +25 -9
- package/dist/POM/PromptObjectModel.js.map +1 -1
- package/dist/ParameterSchema.d.ts +306 -0
- package/dist/ParameterSchema.js +251 -0
- package/dist/ParameterSchema.js.map +1 -0
- package/dist/PlatformContracts.d.ts +21 -0
- package/dist/PlatformContracts.generated.d.ts +109 -0
- package/dist/PlatformContracts.generated.js +8 -0
- package/dist/PlatformContracts.generated.js.map +1 -0
- package/dist/PlatformContracts.js +2 -0
- package/dist/PlatformContracts.js.map +1 -0
- package/dist/PomBuilder.d.ts +18 -0
- package/dist/PomBuilder.js +53 -3
- package/dist/PomBuilder.js.map +1 -1
- package/dist/PostPrompt.d.ts +110 -0
- package/dist/PostPrompt.js +204 -0
- package/dist/PostPrompt.js.map +1 -0
- package/dist/PromptManager.d.ts +22 -1
- package/dist/PromptManager.js +28 -1
- package/dist/PromptManager.js.map +1 -1
- package/dist/PublicFetch.d.ts +132 -0
- package/dist/PublicFetch.js +311 -0
- package/dist/PublicFetch.js.map +1 -0
- package/dist/RobotsTxt.d.ts +41 -0
- package/dist/RobotsTxt.js +152 -0
- package/dist/RobotsTxt.js.map +1 -0
- package/dist/SWMLHandler.js.map +1 -1
- package/dist/SWMLService.d.ts +169 -59
- package/dist/SWMLService.js +456 -129
- package/dist/SWMLService.js.map +1 -1
- package/dist/SchemaUtils.d.ts +115 -2
- package/dist/SchemaUtils.js +444 -12
- package/dist/SchemaUtils.js.map +1 -1
- package/dist/SecurityUtils.d.ts +49 -9
- package/dist/SecurityUtils.js +153 -51
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/SemanticGate.d.ts +183 -0
- package/dist/SemanticGate.js +533 -0
- package/dist/SemanticGate.js.map +1 -0
- package/dist/ServerlessAdapter.d.ts +156 -7
- package/dist/ServerlessAdapter.js +399 -42
- package/dist/ServerlessAdapter.js.map +1 -1
- package/dist/SessionManager.d.ts +11 -2
- package/dist/SessionManager.js +50 -18
- package/dist/SessionManager.js.map +1 -1
- package/dist/SslConfig.d.ts +2 -1
- package/dist/SslConfig.js +4 -1
- package/dist/SslConfig.js.map +1 -1
- package/dist/SwaigActions.generated.d.ts +23 -0
- package/dist/SwaigActions.generated.js +8 -0
- package/dist/SwaigActions.generated.js.map +1 -0
- package/dist/SwaigContracts.d.ts +15 -0
- package/dist/SwaigContracts.generated.d.ts +264 -0
- package/dist/SwaigContracts.generated.js +12 -0
- package/dist/SwaigContracts.generated.js.map +1 -0
- package/dist/SwaigContracts.js +2 -0
- package/dist/SwaigContracts.js.map +1 -0
- package/dist/SwaigFunction.d.ts +139 -7
- package/dist/SwaigFunction.js +170 -22
- package/dist/SwaigFunction.js.map +1 -1
- package/dist/SwmlBuilder.d.ts +68 -19
- package/dist/SwmlBuilder.js +74 -38
- package/dist/SwmlBuilder.js.map +1 -1
- package/dist/SwmlVerbMethods.generated.d.ts +41 -4
- package/dist/SwmlVerbMethods.generated.js +1 -1
- package/dist/TypeInference.d.ts +39 -3
- package/dist/TypeInference.js +256 -16
- package/dist/TypeInference.js.map +1 -1
- package/dist/WebService.d.ts +79 -11
- package/dist/WebService.js +320 -109
- package/dist/WebService.js.map +1 -1
- package/dist/WebhookMiddleware.d.ts +119 -0
- package/dist/WebhookMiddleware.js +271 -0
- package/dist/WebhookMiddleware.js.map +1 -0
- package/dist/WebhookValidator.d.ts +92 -0
- package/dist/WebhookValidator.js +409 -0
- package/dist/WebhookValidator.js.map +1 -0
- package/dist/agents/BedrockAgent.d.ts +162 -0
- package/dist/agents/BedrockAgent.js +323 -0
- package/dist/agents/BedrockAgent.js.map +1 -0
- package/dist/ai-chat/AIChatClient.d.ts +316 -0
- package/dist/ai-chat/AIChatClient.js +535 -0
- package/dist/ai-chat/AIChatClient.js.map +1 -0
- package/dist/ai-chat/ChatGateway.d.ts +408 -0
- package/dist/ai-chat/ChatGateway.js +747 -0
- package/dist/ai-chat/ChatGateway.js.map +1 -0
- package/dist/ai-chat/HandoffRouter.d.ts +282 -0
- package/dist/ai-chat/HandoffRouter.js +518 -0
- package/dist/ai-chat/HandoffRouter.js.map +1 -0
- package/dist/ai-chat/index.d.ts +12 -0
- package/dist/ai-chat/index.js +10 -0
- package/dist/ai-chat/index.js.map +1 -0
- package/dist/capabilities.d.ts +64 -0
- package/dist/capabilities.js +95 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +32 -6
- package/dist/cli/agent-loader.js +92 -33
- package/dist/cli/agent-loader.js.map +1 -1
- package/dist/cli/datamap-exec.d.ts +175 -0
- package/dist/cli/datamap-exec.js +1284 -0
- package/dist/cli/datamap-exec.js.map +1 -0
- package/dist/cli/function-args.d.ts +40 -0
- package/dist/cli/function-args.js +146 -0
- package/dist/cli/function-args.js.map +1 -0
- package/dist/cli/simulation.d.ts +99 -0
- package/dist/cli/simulation.js +490 -0
- package/dist/cli/simulation.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +12 -25
- package/dist/cli/swaig-test.js +935 -371
- package/dist/cli/swaig-test.js.map +1 -1
- package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
- package/dist/cli/tsdocs/agentsNote.js +92 -0
- package/dist/cli/tsdocs/agentsNote.js.map +1 -0
- package/dist/cli/tsdocs/api-index.json +1 -0
- package/dist/cli/tsdocs/api.d.ts +91 -0
- package/dist/cli/tsdocs/api.js +372 -0
- package/dist/cli/tsdocs/api.js.map +1 -0
- package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
- package/dist/cli/tsdocs/apiTypes.js +7 -0
- package/dist/cli/tsdocs/apiTypes.js.map +1 -0
- package/dist/cli/tsdocs/bin.d.ts +6 -0
- package/dist/cli/tsdocs/bin.js +23 -0
- package/dist/cli/tsdocs/bin.js.map +1 -0
- package/dist/cli/tsdocs/files.d.ts +108 -0
- package/dist/cli/tsdocs/files.js +287 -0
- package/dist/cli/tsdocs/files.js.map +1 -0
- package/dist/cli/tsdocs/index.d.ts +28 -0
- package/dist/cli/tsdocs/index.js +307 -0
- package/dist/cli/tsdocs/index.js.map +1 -0
- package/dist/cli/tsdocs/live.d.ts +41 -0
- package/dist/cli/tsdocs/live.js +202 -0
- package/dist/cli/tsdocs/live.js.map +1 -0
- package/dist/cli/tsdocs/locate.d.ts +51 -0
- package/dist/cli/tsdocs/locate.js +75 -0
- package/dist/cli/tsdocs/locate.js.map +1 -0
- package/dist/cli/tsdocs/render.d.ts +75 -0
- package/dist/cli/tsdocs/render.js +323 -0
- package/dist/cli/tsdocs/render.js.map +1 -0
- package/dist/cli/tsdocs/topics.d.ts +43 -0
- package/dist/cli/tsdocs/topics.js +920 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +49 -68
- package/dist/index.js +45 -73
- package/dist/index.js.map +1 -1
- package/dist/livewire/index.d.ts +229 -155
- package/dist/livewire/index.js +298 -195
- package/dist/livewire/index.js.map +1 -1
- package/dist/llms.txt +65 -0
- package/dist/prefabs/CallSessionStore.d.ts +52 -0
- package/dist/prefabs/CallSessionStore.js +72 -0
- package/dist/prefabs/CallSessionStore.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +13 -1
- package/dist/prefabs/ConciergeAgent.js +36 -31
- package/dist/prefabs/ConciergeAgent.js.map +1 -1
- package/dist/prefabs/FAQBotAgent.d.ts +9 -1
- package/dist/prefabs/FAQBotAgent.js +113 -47
- package/dist/prefabs/FAQBotAgent.js.map +1 -1
- package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
- package/dist/prefabs/InfoGathererAgent.js +67 -58
- package/dist/prefabs/InfoGathererAgent.js.map +1 -1
- package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
- package/dist/prefabs/ReceptionistAgent.js +39 -31
- package/dist/prefabs/ReceptionistAgent.js.map +1 -1
- package/dist/prefabs/SurveyAgent.d.ts +22 -4
- package/dist/prefabs/SurveyAgent.js +84 -68
- package/dist/prefabs/SurveyAgent.js.map +1 -1
- package/dist/relay/Action.d.ts +44 -21
- package/dist/relay/Action.js +75 -17
- package/dist/relay/Action.js.map +1 -1
- package/dist/relay/Call.d.ts +312 -47
- package/dist/relay/Call.js +369 -18
- package/dist/relay/Call.js.map +1 -1
- package/dist/relay/Deferred.js.map +1 -1
- package/dist/relay/Message.d.ts +26 -5
- package/dist/relay/Message.js +36 -6
- package/dist/relay/Message.js.map +1 -1
- package/dist/relay/RelayClient.d.ts +44 -17
- package/dist/relay/RelayClient.js +175 -65
- package/dist/relay/RelayClient.js.map +1 -1
- package/dist/relay/RelayError.d.ts +14 -0
- package/dist/relay/RelayError.js +15 -0
- package/dist/relay/RelayError.js.map +1 -1
- package/dist/relay/RelayEvent.d.ts +96 -65
- package/dist/relay/RelayEvent.js +85 -56
- package/dist/relay/RelayEvent.js.map +1 -1
- package/dist/relay/closedSets.d.ts +111 -0
- package/dist/relay/closedSets.js +83 -0
- package/dist/relay/closedSets.js.map +1 -0
- package/dist/relay/index.d.ts +3 -1
- package/dist/relay/index.js +1 -0
- package/dist/relay/index.js.map +1 -1
- package/dist/relay/normalize.js.map +1 -1
- package/dist/relay/protocol.types.generated.d.ts +1195 -0
- package/dist/relay/protocol.types.generated.js +8 -0
- package/dist/relay/protocol.types.generated.js.map +1 -0
- package/dist/relay/types.d.ts +73 -42
- package/dist/rest/HttpClient.d.ts +36 -8
- package/dist/rest/HttpClient.js +233 -40
- package/dist/rest/HttpClient.js.map +1 -1
- package/dist/rest/RequestOptions.d.ts +110 -0
- package/dist/rest/RequestOptions.js +113 -0
- package/dist/rest/RequestOptions.js.map +1 -0
- package/dist/rest/RestError.d.ts +52 -6
- package/dist/rest/RestError.js +89 -5
- package/dist/rest/RestError.js.map +1 -1
- package/dist/rest/base/CrudResource.d.ts +16 -26
- package/dist/rest/base/CrudResource.js +19 -33
- package/dist/rest/base/CrudResource.js.map +1 -1
- package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
- package/dist/rest/base/CrudWithAddresses.js +2 -2
- package/dist/rest/base/CrudWithAddresses.js.map +1 -1
- package/dist/rest/base/FabricResource.d.ts +15 -0
- package/dist/rest/base/FabricResource.js +16 -0
- package/dist/rest/base/FabricResource.js.map +1 -0
- package/dist/rest/base/ReadResource.d.ts +62 -0
- package/dist/rest/base/ReadResource.js +69 -0
- package/dist/rest/base/ReadResource.js.map +1 -0
- package/dist/rest/callHandler.d.ts +5 -2
- package/dist/rest/callHandler.js +4 -1
- package/dist/rest/callHandler.js.map +1 -1
- package/dist/rest/index.d.ts +18 -77
- package/dist/rest/index.js +47 -120
- package/dist/rest/index.js.map +1 -1
- package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
- package/dist/rest/namespaces/_client_tree_generated.js +171 -0
- package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +3 -42
- package/dist/rest/namespaces/addresses.js +3 -50
- package/dist/rest/namespaces/addresses.js.map +1 -1
- package/dist/rest/namespaces/calling.d.ts +6 -378
- package/dist/rest/namespaces/calling.js +6 -473
- package/dist/rest/namespaces/calling.js.map +1 -1
- package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
- package/dist/rest/namespaces/calling.resources.generated.js +477 -0
- package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
- package/dist/rest/namespaces/calling.types.generated.js +8 -0
- package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +4 -18
- package/dist/rest/namespaces/chat.js +4 -21
- package/dist/rest/namespaces/chat.js.map +1 -1
- package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/chat.resources.generated.js +29 -0
- package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
- package/dist/rest/namespaces/chat.types.generated.js +8 -0
- package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +6 -62
- package/dist/rest/namespaces/datasphere.js +6 -72
- package/dist/rest/namespaces/datasphere.js.map +1 -1
- package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
- package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
- package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +11 -327
- package/dist/rest/namespaces/fabric.js +14 -439
- package/dist/rest/namespaces/fabric.js.map +1 -1
- package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
- package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
- package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
- package/dist/rest/namespaces/fabric.types.generated.js +8 -0
- package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/fax.resources.generated.js +14 -0
- package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/fax.types.generated.js +8 -0
- package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
- package/dist/rest/namespaces/imported-numbers.js +3 -21
- package/dist/rest/namespaces/imported-numbers.js.map +1 -1
- package/dist/rest/namespaces/logs.d.ts +10 -101
- package/dist/rest/namespaces/logs.js +10 -128
- package/dist/rest/namespaces/logs.js.map +1 -1
- package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/logs.resources.generated.js +17 -0
- package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/logs.types.generated.js +8 -0
- package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +3 -25
- package/dist/rest/namespaces/lookup.js +3 -27
- package/dist/rest/namespaces/lookup.js.map +1 -1
- package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/message.resources.generated.js +14 -0
- package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
- package/dist/rest/namespaces/message.types.generated.js +8 -0
- package/dist/rest/namespaces/message.types.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
- package/dist/rest/namespaces/messages.resources.generated.js +44 -0
- package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
- package/dist/rest/namespaces/messages.types.generated.js +8 -0
- package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +3 -42
- package/dist/rest/namespaces/mfa.js +3 -49
- package/dist/rest/namespaces/mfa.js.map +1 -1
- package/dist/rest/namespaces/number-groups.d.ts +3 -45
- package/dist/rest/namespaces/number-groups.js +3 -53
- package/dist/rest/namespaces/number-groups.js.map +1 -1
- package/dist/rest/namespaces/phone-numbers.d.ts +8 -196
- package/dist/rest/namespaces/phone-numbers.js +8 -230
- package/dist/rest/namespaces/phone-numbers.js.map +1 -1
- package/dist/rest/namespaces/project.d.ts +6 -42
- package/dist/rest/namespaces/project.js +6 -51
- package/dist/rest/namespaces/project.js.map +1 -1
- package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
- package/dist/rest/namespaces/project.resources.generated.js +44 -0
- package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
- package/dist/rest/namespaces/project.types.generated.js +8 -0
- package/dist/rest/namespaces/project.types.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/projects.resources.generated.js +25 -0
- package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
- package/dist/rest/namespaces/projects.types.generated.js +8 -0
- package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +4 -18
- package/dist/rest/namespaces/pubsub.js +4 -21
- package/dist/rest/namespaces/pubsub.js.map +1 -1
- package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
- package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
- package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +3 -38
- package/dist/rest/namespaces/queues.js +3 -44
- package/dist/rest/namespaces/queues.js.map +1 -1
- package/dist/rest/namespaces/recordings.d.ts +3 -34
- package/dist/rest/namespaces/recordings.js +3 -40
- package/dist/rest/namespaces/recordings.js.map +1 -1
- package/dist/rest/namespaces/registry.d.ts +6 -137
- package/dist/rest/namespaces/registry.js +6 -173
- package/dist/rest/namespaces/registry.js.map +1 -1
- package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +3 -35
- package/dist/rest/namespaces/short-codes.js +3 -41
- package/dist/rest/namespaces/short-codes.js.map +1 -1
- package/dist/rest/namespaces/sip-profile.d.ts +3 -24
- package/dist/rest/namespaces/sip-profile.js +3 -29
- package/dist/rest/namespaces/sip-profile.js.map +1 -1
- package/dist/rest/namespaces/verified-callers.d.ts +3 -29
- package/dist/rest/namespaces/verified-callers.js +3 -34
- package/dist/rest/namespaces/verified-callers.js.map +1 -1
- package/dist/rest/namespaces/video.d.ts +10 -227
- package/dist/rest/namespaces/video.js +10 -288
- package/dist/rest/namespaces/video.js.map +1 -1
- package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
- package/dist/rest/namespaces/video.resources.generated.js +171 -0
- package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
- package/dist/rest/namespaces/video.types.generated.js +8 -0
- package/dist/rest/namespaces/video.types.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/voice.resources.generated.js +17 -0
- package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
- package/dist/rest/namespaces/voice.types.generated.js +8 -0
- package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
- package/dist/rest/pagination.d.ts +5 -1
- package/dist/rest/pagination.js +40 -20
- package/dist/rest/pagination.js.map +1 -1
- package/dist/rest/types.d.ts +21 -3
- package/dist/schema.json +299 -98
- package/dist/skills/SkillBase.d.ts +111 -21
- package/dist/skills/SkillBase.js +100 -17
- package/dist/skills/SkillBase.js.map +1 -1
- package/dist/skills/SkillManager.d.ts +66 -13
- package/dist/skills/SkillManager.js +101 -20
- package/dist/skills/SkillManager.js.map +1 -1
- package/dist/skills/SkillName.d.ts +44 -0
- package/dist/skills/SkillName.js +2 -0
- package/dist/skills/SkillName.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +22 -11
- package/dist/skills/SkillRegistry.js +47 -17
- package/dist/skills/SkillRegistry.js.map +1 -1
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
- package/dist/skills/builtin/api_ninjas_trivia.js +18 -6
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
- package/dist/skills/builtin/ask_claude.d.ts +14 -4
- package/dist/skills/builtin/ask_claude.js +36 -14
- package/dist/skills/builtin/ask_claude.js.map +1 -1
- package/dist/skills/builtin/claude_skills.d.ts +3 -1
- package/dist/skills/builtin/claude_skills.js +19 -15
- package/dist/skills/builtin/claude_skills.js.map +1 -1
- package/dist/skills/builtin/custom_skills.d.ts +10 -3
- package/dist/skills/builtin/custom_skills.js +26 -9
- package/dist/skills/builtin/custom_skills.js.map +1 -1
- package/dist/skills/builtin/datasphere.d.ts +5 -3
- package/dist/skills/builtin/datasphere.js +21 -22
- package/dist/skills/builtin/datasphere.js.map +1 -1
- package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
- package/dist/skills/builtin/datasphere_serverless.js +17 -6
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
- package/dist/skills/builtin/datetime.d.ts +3 -1
- package/dist/skills/builtin/datetime.js +11 -7
- package/dist/skills/builtin/datetime.js.map +1 -1
- package/dist/skills/builtin/google_maps.d.ts +29 -14
- package/dist/skills/builtin/google_maps.js +89 -269
- package/dist/skills/builtin/google_maps.js.map +1 -1
- package/dist/skills/builtin/index.d.ts +8 -6
- package/dist/skills/builtin/index.js +8 -6
- package/dist/skills/builtin/index.js.map +1 -1
- package/dist/skills/builtin/info_gatherer.d.ts +4 -2
- package/dist/skills/builtin/info_gatherer.js +20 -12
- package/dist/skills/builtin/info_gatherer.js.map +1 -1
- package/dist/skills/builtin/joke.d.ts +16 -6
- package/dist/skills/builtin/joke.js +54 -37
- package/dist/skills/builtin/joke.js.map +1 -1
- package/dist/skills/builtin/math.d.ts +3 -1
- package/dist/skills/builtin/math.js +14 -9
- package/dist/skills/builtin/math.js.map +1 -1
- package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
- package/dist/skills/builtin/mcp_gateway.js +77 -46
- package/dist/skills/builtin/mcp_gateway.js.map +1 -1
- package/dist/skills/builtin/native_vector_search.d.ts +19 -5
- package/dist/skills/builtin/native_vector_search.js +179 -61
- package/dist/skills/builtin/native_vector_search.js.map +1 -1
- package/dist/skills/builtin/play_background_file.d.ts +21 -15
- package/dist/skills/builtin/play_background_file.js +43 -122
- package/dist/skills/builtin/play_background_file.js.map +1 -1
- package/dist/skills/builtin/spider.d.ts +42 -4
- package/dist/skills/builtin/spider.js +277 -104
- package/dist/skills/builtin/spider.js.map +1 -1
- package/dist/skills/builtin/swml_transfer.d.ts +14 -3
- package/dist/skills/builtin/swml_transfer.js +45 -24
- package/dist/skills/builtin/swml_transfer.js.map +1 -1
- package/dist/skills/builtin/weather_api.d.ts +24 -13
- package/dist/skills/builtin/weather_api.js +38 -30
- package/dist/skills/builtin/weather_api.js.map +1 -1
- package/dist/skills/builtin/web_search.d.ts +48 -10
- package/dist/skills/builtin/web_search.js +294 -100
- package/dist/skills/builtin/web_search.js.map +1 -1
- package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
- package/dist/skills/builtin/wikipedia_search.js +14 -13
- package/dist/skills/builtin/wikipedia_search.js.map +1 -1
- package/dist/skills/index.d.ts +3 -2
- package/dist/skills/index.js +1 -1
- package/dist/skills/index.js.map +1 -1
- package/dist/swml_verbs_generated.d.ts +2824 -0
- package/dist/swml_verbs_generated.js +12 -0
- package/dist/swml_verbs_generated.js.map +1 -0
- package/dist/types.d.ts +59 -6
- package/dist/web.d.ts +27 -0
- package/dist/web.js +20 -0
- package/dist/web.js.map +1 -0
- package/docs/agent-guide.md +1034 -0
- package/docs/ai_chat.md +560 -0
- package/docs/api-reference.md +3641 -0
- package/docs/architecture.md +846 -0
- package/docs/bedrock_agent.md +411 -0
- package/docs/cli-guide.md +403 -0
- package/docs/cloud_functions_guide.md +399 -0
- package/docs/configuration.md +548 -0
- package/docs/contexts-guide.md +884 -0
- package/docs/datamap-guide.md +1207 -0
- package/docs/developer_pain_points.md +548 -0
- package/docs/llm_parameters.md +298 -0
- package/docs/mcp_gateway_reference.md +354 -0
- package/docs/mcp_integration.md +162 -0
- package/docs/pgi_agent_guide.md +1820 -0
- package/docs/prefabs-guide.md +815 -0
- package/docs/programmatically_governed_inference.md +301 -0
- package/docs/sdk_features.md +501 -0
- package/docs/security.md +559 -0
- package/docs/serverless-guide.md +520 -0
- package/docs/skills-guide.md +1223 -0
- package/docs/skills-system.md +405 -0
- package/docs/skills_parameter_schema.md +417 -0
- package/docs/swaig-reference.md +1986 -0
- package/docs/swml_service_guide.md +573 -0
- package/docs/third_party_skills.md +410 -0
- package/docs/web_service.md +666 -0
- package/examples/README.md +202 -0
- package/examples/advanced-datamap.ts +108 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +95 -0
- package/examples/call-flow.ts +65 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +51 -0
- package/examples/datasphere-multi-instance.ts +66 -0
- package/examples/datasphere-serverless-env.ts +87 -0
- package/examples/datasphere-webhook-env.ts +65 -0
- package/examples/datasphere.ts +56 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +95 -0
- package/examples/gather-per-question-functions-demo.ts +139 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +75 -0
- package/examples/mcp-agent.ts +89 -0
- package/examples/mcp-gateway.ts +81 -0
- package/examples/multi-agent.ts +80 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pgi/case-domain.ts +114 -0
- package/examples/pgi/serve.ts +16 -0
- package/examples/pgi/support-agent.ts +265 -0
- package/examples/pom-prompt.ts +70 -0
- package/examples/prefab-concierge.ts +42 -0
- package/examples/prefab-faq.ts +58 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +69 -0
- package/examples/quickstart-agent.ts +29 -0
- package/examples/quickstart-relay.ts +25 -0
- package/examples/quickstart-rest.ts +25 -0
- package/examples/record-call.ts +65 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +93 -0
- package/examples/serverless-lambda.ts +43 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +41 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +193 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/swmlservice_ai_sidecar.ts +104 -0
- package/examples/swmlservice_swaig_standalone.ts +79 -0
- package/examples/tap.ts +67 -0
- package/examples/typed-tools.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +75 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +164 -0
- package/livewire/docs/migration-guide.md +251 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +196 -0
- package/livewire/examples/livewire-multi-tool.ts +121 -0
- package/package.json +85 -13
- package/relay/README.md +101 -0
- package/relay/docs/call-methods.md +622 -0
- package/relay/docs/client-reference.md +281 -0
- package/relay/docs/events.md +193 -0
- package/relay/docs/getting-started.md +221 -0
- package/relay/docs/guide.md +386 -0
- package/relay/docs/messaging.md +246 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +74 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +141 -0
- package/rest/docs/calling.md +313 -0
- package/rest/docs/client-reference.md +149 -0
- package/rest/docs/fabric.md +192 -0
- package/rest/docs/getting-started.md +138 -0
- package/rest/docs/guide.md +421 -0
- package/rest/docs/namespaces.md +367 -0
- package/rest/docs/phone-binding.md +116 -0
- package/rest/examples/rest-10dlc-registration.ts +177 -0
- package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
- package/rest/examples/rest-calling-play-and-record.ts +98 -0
- package/rest/examples/rest-client.ts +59 -0
- package/rest/examples/rest-datasphere-search.ts +81 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
- package/rest/examples/rest-manage-resources.ts +64 -0
- package/rest/examples/rest-phone-number-management.ts +200 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/tutorial/fred/fred.ts +218 -0
- package/tutorial/fred/tutorial/01-introduction.md +141 -0
- package/tutorial/fred/tutorial/02-setup.md +304 -0
- package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
- package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
- package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
- package/tutorial/fred/tutorial/06-running-testing.md +642 -0
- package/tutorial/fred/tutorial/README.md +56 -0
- package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
- package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
- package/tutorial/full-guardrails-agent/handlers.ts +436 -0
- package/tutorial/full-guardrails-agent/penny.ts +305 -0
- package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
- package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
- package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
- package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
- package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
- package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
- package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
- package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
- package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
- package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
- package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
- package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
- package/tutorial/full-guardrails-agent/workflow.ts +219 -0
- package/tutorial/multi_agents/README.md +175 -0
- package/tutorial/multi_agents/advanced_agent.ts +395 -0
- package/tutorial/multi_agents/extending_agents.ts +641 -0
- package/tutorial/multi_agents/knowledge.ts +59 -0
- package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
- package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
- package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
- package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
- package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
- package/tutorial/multi_agents/pc_builder.ts +529 -0
- package/tutorial/multi_agents/sales_agent.ts +88 -0
- package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
- package/tutorial/multi_agents/sales_knowledge.md +139 -0
- package/tutorial/multi_agents/support_knowledge.md +256 -0
- package/dist/cli/mock-data.d.ts +0 -37
- package/dist/cli/mock-data.js +0 -80
- package/dist/cli/mock-data.js.map +0 -1
- package/dist/generateVerbTypes.d.ts +0 -11
- package/dist/generateVerbTypes.js +0 -265
- package/dist/generateVerbTypes.js.map +0 -1
- package/dist/rest/namespaces/compat.d.ts +0 -585
- package/dist/rest/namespaces/compat.js +0 -735
- package/dist/rest/namespaces/compat.js.map +0 -1
|
@@ -0,0 +1,417 @@
|
|
|
1
|
+
# Skills Parameter Schema System
|
|
2
|
+
|
|
3
|
+
Every skill in the SignalWire AI Agents TypeScript SDK describes its configuration parameters in a schema. This guide explains how to read the schemas of registered skills and how to declare one for your own skill.
|
|
4
|
+
|
|
5
|
+
<!-- snippet-setup -->
|
|
6
|
+
```ts
|
|
7
|
+
export {}; // treat each example as a module so top-level `await` is allowed
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
## Overview
|
|
11
|
+
|
|
12
|
+
A skill's static `getParameterSchema()` returns one entry per parameter, with its type, description, default and a few hints. Tools can use the schema for these tasks:
|
|
13
|
+
|
|
14
|
+
- **Configuration forms**: build a form field for each parameter
|
|
15
|
+
- **Documentation**: list every parameter with its default
|
|
16
|
+
- **Pre-flight checks**: check a configuration before you construct the skill
|
|
17
|
+
- **Secret handling**: mark a parameter as secret, so a form can mask it
|
|
18
|
+
- **Environment variables**: name the variable a configuration tool can fill a value in from
|
|
19
|
+
|
|
20
|
+
The schema is a description. The SDK checks only that it's a non-empty object, when the skill is registered or added. It doesn't check a configuration against it. A missing `required` parameter, a wrong type or an out-of-range value is caught only if the skill's own `setup()` checks it. `hidden` and `env_var` are hints for tools. They don't hide a value or read a variable themselves.
|
|
21
|
+
|
|
22
|
+
## Using the Schema System
|
|
23
|
+
|
|
24
|
+
### Getting All Skills Schema
|
|
25
|
+
|
|
26
|
+
`listSkillsWithParams()` returns the schema of every skill in the global `SkillRegistry`, keyed by skill name. The registry starts empty, so call `registerBuiltinSkills()` first to include the built-in skills:
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { listSkillsWithParams, registerBuiltinSkills } from '@signalwire/sdk';
|
|
30
|
+
|
|
31
|
+
registerBuiltinSkills();
|
|
32
|
+
const schema = listSkillsWithParams();
|
|
33
|
+
console.log(JSON.stringify(schema['datetime'], null, 2));
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
The script printed this entry for `datetime`, which has only the two base parameters:
|
|
37
|
+
|
|
38
|
+
```json
|
|
39
|
+
{
|
|
40
|
+
"name": "datetime",
|
|
41
|
+
"description": "Get current date, time, and timezone information",
|
|
42
|
+
"version": "1.0.0",
|
|
43
|
+
"supportsMultipleInstances": false,
|
|
44
|
+
"requiredEnvVars": [],
|
|
45
|
+
"requiredPackages": [],
|
|
46
|
+
"parameters": {
|
|
47
|
+
"swaig_fields": {
|
|
48
|
+
"type": "object",
|
|
49
|
+
"description": "Additional SWAIG fields to merge into each tool definition provided by this skill.",
|
|
50
|
+
"default": {},
|
|
51
|
+
"required": false
|
|
52
|
+
},
|
|
53
|
+
"skip_prompt": {
|
|
54
|
+
"type": "boolean",
|
|
55
|
+
"description": "When true, suppress all prompt sections from this skill.",
|
|
56
|
+
"default": false,
|
|
57
|
+
"required": false
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
The `web_search` entry has more parameters. These are two of them, from the same run:
|
|
64
|
+
|
|
65
|
+
```json
|
|
66
|
+
{
|
|
67
|
+
"api_key": {
|
|
68
|
+
"type": "string",
|
|
69
|
+
"description": "Google Custom Search API key",
|
|
70
|
+
"required": true,
|
|
71
|
+
"hidden": true,
|
|
72
|
+
"env_var": "GOOGLE_SEARCH_API_KEY"
|
|
73
|
+
},
|
|
74
|
+
"num_results": {
|
|
75
|
+
"type": "integer",
|
|
76
|
+
"description": "Number of high-quality results to return",
|
|
77
|
+
"default": 3,
|
|
78
|
+
"required": false,
|
|
79
|
+
"min": 1,
|
|
80
|
+
"max": 10
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
`SkillRegistry.getInstance().getSkillSchema(name)` returns one skill's entry, and `listSkills()` returns the same entries as an array.
|
|
86
|
+
|
|
87
|
+
### Using Schema for GUI Configuration
|
|
88
|
+
|
|
89
|
+
This example builds an HTML form from the `web_search` schema. It masks `hidden` fields and shows the `env_var` hint:
|
|
90
|
+
|
|
91
|
+
```typescript
|
|
92
|
+
import { listSkillsWithParams, registerBuiltinSkills, type ParameterSchemaEntry } from '@signalwire/sdk';
|
|
93
|
+
|
|
94
|
+
registerBuiltinSkills();
|
|
95
|
+
|
|
96
|
+
const schema = listSkillsWithParams();
|
|
97
|
+
const webSearchSchema = schema['web_search'];
|
|
98
|
+
|
|
99
|
+
function generateFormField(paramName: string, paramInfo: ParameterSchemaEntry): string {
|
|
100
|
+
let html = `<div class="form-group">\n`;
|
|
101
|
+
html += ` <label for="${paramName}">${paramInfo.description}</label>\n`;
|
|
102
|
+
|
|
103
|
+
const required = paramInfo.required ? 'required' : '';
|
|
104
|
+
const inputType = paramInfo.hidden ? 'password' : 'text';
|
|
105
|
+
|
|
106
|
+
switch (paramInfo.type) {
|
|
107
|
+
case 'string': {
|
|
108
|
+
const value = paramInfo.default ?? '';
|
|
109
|
+
html += ` <input type="${inputType}" id="${paramName}" name="${paramName}" value="${String(value)}" ${required}>\n`;
|
|
110
|
+
break;
|
|
111
|
+
}
|
|
112
|
+
case 'integer':
|
|
113
|
+
case 'number': {
|
|
114
|
+
const value = paramInfo.default ?? 0;
|
|
115
|
+
const min = paramInfo.min !== undefined ? `min="${paramInfo.min}"` : '';
|
|
116
|
+
const max = paramInfo.max !== undefined ? `max="${paramInfo.max}"` : '';
|
|
117
|
+
html += ` <input type="number" id="${paramName}" name="${paramName}" value="${String(value)}" ${min} ${max} ${required}>\n`;
|
|
118
|
+
break;
|
|
119
|
+
}
|
|
120
|
+
case 'boolean': {
|
|
121
|
+
const checked = paramInfo.default ? 'checked' : '';
|
|
122
|
+
html += ` <input type="checkbox" id="${paramName}" name="${paramName}" ${checked}>\n`;
|
|
123
|
+
break;
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
if (paramInfo.env_var) {
|
|
128
|
+
html += ` <small>Can also be set with the ${paramInfo.env_var} environment variable</small>\n`;
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
html += '</div>\n';
|
|
132
|
+
return html;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
let form = '<form>\n';
|
|
136
|
+
if (webSearchSchema) {
|
|
137
|
+
for (const [name, info] of Object.entries(webSearchSchema.parameters)) {
|
|
138
|
+
form += generateFormField(name, info);
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
form += '</form>';
|
|
142
|
+
console.log(form);
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
The form skips `object` and `array` parameters, such as `swaig_fields`, which need their own editors.
|
|
146
|
+
|
|
147
|
+
### Programmatic Skill Configuration
|
|
148
|
+
|
|
149
|
+
The SDK doesn't enforce `required`, so a tool that assembles configurations can check it before it adds the skill. This example rejects a `web_search` configuration that's missing a required parameter:
|
|
150
|
+
|
|
151
|
+
```typescript
|
|
152
|
+
import { AgentBase, listSkillsWithParams, registerBuiltinSkills } from '@signalwire/sdk';
|
|
153
|
+
|
|
154
|
+
registerBuiltinSkills();
|
|
155
|
+
|
|
156
|
+
const webSearchParams: Record<string, unknown> = {
|
|
157
|
+
api_key: process.env['GOOGLE_SEARCH_API_KEY'],
|
|
158
|
+
search_engine_id: process.env['GOOGLE_SEARCH_ENGINE_ID'],
|
|
159
|
+
num_results: 3,
|
|
160
|
+
max_content_length: 3000,
|
|
161
|
+
};
|
|
162
|
+
|
|
163
|
+
const parameters = listSkillsWithParams()['web_search']?.parameters ?? {};
|
|
164
|
+
const missing = Object.entries(parameters)
|
|
165
|
+
.filter(([name, info]) => info.required && webSearchParams[name] === undefined)
|
|
166
|
+
.map(([name]) => name);
|
|
167
|
+
|
|
168
|
+
if (missing.length > 0) {
|
|
169
|
+
console.error(`Missing required parameters: ${missing.join(', ')}`);
|
|
170
|
+
} else {
|
|
171
|
+
const agent = new AgentBase({ name: 'my-agent' });
|
|
172
|
+
await agent.addSkillByName('web_search', webSearchParams);
|
|
173
|
+
}
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
The check reads only the configuration. Some skills fall back to an environment variable, and some have a `required` parameter they never read, as the [Skills System Guide](skills-guide.md#built-in-skills) notes for each skill.
|
|
177
|
+
|
|
178
|
+
## Parameter Schema Reference
|
|
179
|
+
|
|
180
|
+
Each parameter's entry (`ParameterSchemaEntry`) can have these properties:
|
|
181
|
+
|
|
182
|
+
| Property | Type | Description |
|
|
183
|
+
|----------|------|-------------|
|
|
184
|
+
| `type` | string | `"string"`, `"integer"`, `"number"`, `"boolean"`, `"object"` or `"array"` (required) |
|
|
185
|
+
| `description` | string | Description of the parameter (required) |
|
|
186
|
+
| `default` | any | Value the skill uses when the parameter is absent |
|
|
187
|
+
| `required` | boolean | Whether the parameter must be set. Absent means `false`. |
|
|
188
|
+
| `hidden` | boolean | Whether a form should mask the value, as for a key or password |
|
|
189
|
+
| `env_var` | string | Environment variable a configuration tool can read this value from. The SDK doesn't read it: the skill gets the value from its params |
|
|
190
|
+
| `enum` | array | Allowed values |
|
|
191
|
+
| `min` | number | Lowest allowed value, for numbers |
|
|
192
|
+
| `max` | number | Highest allowed value, for numbers |
|
|
193
|
+
| `items` | object | JSON Schema of each element, for arrays |
|
|
194
|
+
|
|
195
|
+
`required`, `enum`, `min` and `max` describe the valid values. The SDK doesn't enforce them.
|
|
196
|
+
|
|
197
|
+
## Implementing Parameter Schema in Skills
|
|
198
|
+
|
|
199
|
+
Override the static `getParameterSchema()` and spread the base schema from `super`, so the base parameters stay in it. This skill declares six parameters and reads them in `setup()`:
|
|
200
|
+
|
|
201
|
+
```typescript
|
|
202
|
+
import { SkillBase, type ParameterSchemaEntry, type SkillToolDefinition } from '@signalwire/sdk';
|
|
203
|
+
|
|
204
|
+
class MyCustomSkill extends SkillBase {
|
|
205
|
+
static override SKILL_NAME = 'my_custom_skill';
|
|
206
|
+
static override SKILL_DESCRIPTION = 'Looks up records in an inventory API';
|
|
207
|
+
static override SKILL_VERSION = '1.0.0';
|
|
208
|
+
|
|
209
|
+
private apiEndpoint = 'https://api.example.com';
|
|
210
|
+
private apiKey?: string;
|
|
211
|
+
private timeout = 30;
|
|
212
|
+
|
|
213
|
+
static override getParameterSchema(): Record<string, ParameterSchemaEntry> {
|
|
214
|
+
return {
|
|
215
|
+
// swaig_fields and skip_prompt, plus tool_name for multi-instance skills
|
|
216
|
+
...super.getParameterSchema(),
|
|
217
|
+
api_endpoint: {
|
|
218
|
+
type: 'string',
|
|
219
|
+
description: 'API endpoint URL',
|
|
220
|
+
required: false,
|
|
221
|
+
default: 'https://api.example.com',
|
|
222
|
+
},
|
|
223
|
+
api_key: {
|
|
224
|
+
type: 'string',
|
|
225
|
+
description: 'API authentication key',
|
|
226
|
+
required: true,
|
|
227
|
+
hidden: true,
|
|
228
|
+
env_var: 'MY_API_KEY', // Where a configuration tool can find it
|
|
229
|
+
},
|
|
230
|
+
timeout: {
|
|
231
|
+
type: 'integer',
|
|
232
|
+
description: 'Request timeout in seconds',
|
|
233
|
+
default: 30,
|
|
234
|
+
required: false,
|
|
235
|
+
min: 1,
|
|
236
|
+
max: 300,
|
|
237
|
+
},
|
|
238
|
+
retry_count: {
|
|
239
|
+
type: 'integer',
|
|
240
|
+
description: 'Number of retries on failure',
|
|
241
|
+
default: 3,
|
|
242
|
+
required: false,
|
|
243
|
+
min: 0,
|
|
244
|
+
max: 10,
|
|
245
|
+
},
|
|
246
|
+
output_format: {
|
|
247
|
+
type: 'string',
|
|
248
|
+
description: 'Output format for results',
|
|
249
|
+
default: 'json',
|
|
250
|
+
required: false,
|
|
251
|
+
enum: ['json', 'xml', 'text'],
|
|
252
|
+
},
|
|
253
|
+
enable_cache: {
|
|
254
|
+
type: 'boolean',
|
|
255
|
+
description: 'Enable response caching',
|
|
256
|
+
default: true,
|
|
257
|
+
required: false,
|
|
258
|
+
},
|
|
259
|
+
};
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
override async setup(): Promise<boolean> {
|
|
263
|
+
this.apiEndpoint = this.getConfig<string>('api_endpoint', 'https://api.example.com');
|
|
264
|
+
this.apiKey = this.getConfig<string | undefined>('api_key');
|
|
265
|
+
this.timeout = this.getConfig<number>('timeout', 30);
|
|
266
|
+
if (!this.apiKey) {
|
|
267
|
+
this.logger.error('api_key is required');
|
|
268
|
+
return false;
|
|
269
|
+
}
|
|
270
|
+
if (this.timeout < 1 || this.timeout > 300) {
|
|
271
|
+
this.logger.error('timeout must be from 1 to 300 seconds');
|
|
272
|
+
return false;
|
|
273
|
+
}
|
|
274
|
+
return true;
|
|
275
|
+
}
|
|
276
|
+
|
|
277
|
+
override getTools(): SkillToolDefinition[] {
|
|
278
|
+
return [];
|
|
279
|
+
}
|
|
280
|
+
}
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
The `setup()` checks are what enforce `required` and the range. When `setup()` returns `false`, the skill isn't added.
|
|
284
|
+
|
|
285
|
+
## Common Parameter Patterns
|
|
286
|
+
|
|
287
|
+
### API Keys and Secrets
|
|
288
|
+
|
|
289
|
+
Mark a key as `hidden`, and name the usual environment variable in `env_var`, so a configuration tool can fill the value in:
|
|
290
|
+
|
|
291
|
+
<!-- snippet: no-compile bare schema-entry object-literal fragment -->
|
|
292
|
+
```typescript
|
|
293
|
+
api_key: {
|
|
294
|
+
type: 'string',
|
|
295
|
+
description: 'API key for authentication',
|
|
296
|
+
required: true,
|
|
297
|
+
hidden: true,
|
|
298
|
+
env_var: 'SERVICE_API_KEY',
|
|
299
|
+
}
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
The SDK doesn't read the variable, so the skill gets the value from its params. A skill that should also fall back to the variable reads it in `setup()` itself.
|
|
303
|
+
|
|
304
|
+
### Numeric Parameters with Constraints
|
|
305
|
+
|
|
306
|
+
Use `min` and `max` to document the valid range, and check it in `setup()`:
|
|
307
|
+
|
|
308
|
+
<!-- snippet: no-compile bare schema-entry object-literal fragment -->
|
|
309
|
+
```typescript
|
|
310
|
+
port: {
|
|
311
|
+
type: 'integer',
|
|
312
|
+
description: 'Server port number',
|
|
313
|
+
default: 8080,
|
|
314
|
+
required: false,
|
|
315
|
+
min: 1,
|
|
316
|
+
max: 65535,
|
|
317
|
+
}
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
### Enumerated Values
|
|
321
|
+
|
|
322
|
+
Use `enum` to list the allowed values:
|
|
323
|
+
|
|
324
|
+
<!-- snippet: no-compile bare schema-entry object-literal fragment -->
|
|
325
|
+
```typescript
|
|
326
|
+
log_level: {
|
|
327
|
+
type: 'string',
|
|
328
|
+
description: 'Logging level',
|
|
329
|
+
default: 'info',
|
|
330
|
+
required: false,
|
|
331
|
+
enum: ['debug', 'info', 'warn', 'error'],
|
|
332
|
+
}
|
|
333
|
+
```
|
|
334
|
+
|
|
335
|
+
### Optional Features
|
|
336
|
+
|
|
337
|
+
Use a boolean parameter to turn a feature on or off:
|
|
338
|
+
|
|
339
|
+
<!-- snippet: no-compile bare schema-entry object-literal fragment -->
|
|
340
|
+
```typescript
|
|
341
|
+
enable_analytics: {
|
|
342
|
+
type: 'boolean',
|
|
343
|
+
description: 'Enable analytics tracking',
|
|
344
|
+
default: false,
|
|
345
|
+
required: false,
|
|
346
|
+
}
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
## Base Parameters
|
|
350
|
+
|
|
351
|
+
`SkillBase.getParameterSchema()` returns these parameters, so every skill that spreads it has them:
|
|
352
|
+
|
|
353
|
+
- **`swaig_fields`** (object, default `{}`): fields copied into every tool definition the skill registers
|
|
354
|
+
- **`skip_prompt`** (boolean, default `false`): when `true`, the skill adds no prompt sections
|
|
355
|
+
- **`tool_name`** (string, default the skill's `SKILL_NAME`): only for a class with `SUPPORTS_MULTIPLE_INSTANCES = true`, to tell instances apart
|
|
356
|
+
|
|
357
|
+
A skill can redeclare a base parameter with its own description or default, or remove one it doesn't use. `joke`, `swml_transfer` and `native_vector_search`, for example, redeclare `tool_name` with the tool's default name, and `spider`, whose `tool_name` is a prefix, redeclares it with no default. `info_gatherer` and `claude_skills` name their tools with `prefix` and `tool_prefix`, and never read `tool_name`, so their schemas leave it out.
|
|
358
|
+
|
|
359
|
+
## Examples
|
|
360
|
+
|
|
361
|
+
### Skill With No Extra Parameters
|
|
362
|
+
|
|
363
|
+
Skills such as `datetime` and `math` return the base schema:
|
|
364
|
+
|
|
365
|
+
<!-- snippet: no-compile bare static-method fragment (class body context) -->
|
|
366
|
+
```typescript
|
|
367
|
+
static override getParameterSchema(): Record<string, ParameterSchemaEntry> {
|
|
368
|
+
return { ...super.getParameterSchema() };
|
|
369
|
+
}
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
### Complex Skill (Many Parameters)
|
|
373
|
+
|
|
374
|
+
A skill such as `web_search` spreads the base schema and adds its own parameters. This is part of its schema:
|
|
375
|
+
|
|
376
|
+
<!-- snippet: no-compile bare static-method fragment (class body context) -->
|
|
377
|
+
```typescript
|
|
378
|
+
static override getParameterSchema(): Record<string, ParameterSchemaEntry> {
|
|
379
|
+
return {
|
|
380
|
+
...super.getParameterSchema(),
|
|
381
|
+
api_key: {
|
|
382
|
+
type: 'string',
|
|
383
|
+
description: 'Google Custom Search API key',
|
|
384
|
+
required: true,
|
|
385
|
+
hidden: true,
|
|
386
|
+
env_var: 'GOOGLE_SEARCH_API_KEY',
|
|
387
|
+
},
|
|
388
|
+
num_results: {
|
|
389
|
+
type: 'integer',
|
|
390
|
+
description: 'Number of high-quality results to return',
|
|
391
|
+
default: 3,
|
|
392
|
+
required: false,
|
|
393
|
+
min: 1,
|
|
394
|
+
max: 10,
|
|
395
|
+
},
|
|
396
|
+
safe_search: {
|
|
397
|
+
type: 'string',
|
|
398
|
+
description: 'Safe search level.',
|
|
399
|
+
default: 'medium',
|
|
400
|
+
enum: ['off', 'medium', 'high'],
|
|
401
|
+
},
|
|
402
|
+
};
|
|
403
|
+
}
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
## Best Practices
|
|
407
|
+
|
|
408
|
+
These practices keep a schema accurate and useful:
|
|
409
|
+
|
|
410
|
+
1. **Describe every parameter.** `description` is required, and forms show it as the label.
|
|
411
|
+
2. **Set defaults that work.** A skill with sensible defaults loads with a short configuration.
|
|
412
|
+
3. **Mark secrets as `hidden`.** A form can then mask them.
|
|
413
|
+
4. **Use the narrowest type.** Use `integer` for whole numbers, and `enum` for a fixed set of strings.
|
|
414
|
+
5. **Treat `env_var` as a hint for tools.** A configuration tool reads the variable; the SDK doesn't, so the skill reads only its params unless its `setup()` reads the variable.
|
|
415
|
+
6. **Check values in `setup()`.** The SDK doesn't enforce `required`, `enum`, `min` or `max`.
|
|
416
|
+
7. **Spread the base schema.** Start the object with `...super.getParameterSchema()`.
|
|
417
|
+
8. **Keep the schema and the code in step.** Use the same default in both places, so the schema reports what the skill does.
|