@signalwire/sdk 2.0.4 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +785 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +550 -163
- package/dist/AgentBase.js +1640 -514
- package/dist/AgentBase.js.map +1 -1
- package/dist/AgentServer.d.ts +21 -0
- package/dist/AgentServer.js +154 -47
- package/dist/AgentServer.js.map +1 -1
- package/dist/AuthHandler.d.ts +14 -2
- package/dist/AuthHandler.js +7 -2
- package/dist/AuthHandler.js.map +1 -1
- package/dist/ConfigLoader.d.ts +5 -13
- package/dist/ConfigLoader.js +15 -29
- package/dist/ConfigLoader.js.map +1 -1
- package/dist/ContextBuilder.d.ts +202 -9
- package/dist/ContextBuilder.js +219 -36
- package/dist/ContextBuilder.js.map +1 -1
- package/dist/DataMap.d.ts +158 -45
- package/dist/DataMap.js +167 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +277 -83
- package/dist/FunctionResult.js +444 -116
- package/dist/FunctionResult.js.map +1 -1
- package/dist/Logger.d.ts +30 -5
- package/dist/Logger.js +77 -19
- package/dist/Logger.js.map +1 -1
- package/dist/POM/PromptObjectModel.d.ts +163 -0
- package/dist/POM/PromptObjectModel.js +481 -0
- package/dist/POM/PromptObjectModel.js.map +1 -0
- package/dist/ParameterSchema.d.ts +306 -0
- package/dist/ParameterSchema.js +251 -0
- package/dist/ParameterSchema.js.map +1 -0
- package/dist/PlatformContracts.d.ts +21 -0
- package/dist/PlatformContracts.generated.d.ts +109 -0
- package/dist/PlatformContracts.generated.js +8 -0
- package/dist/PlatformContracts.generated.js.map +1 -0
- package/dist/PlatformContracts.js +2 -0
- package/dist/PlatformContracts.js.map +1 -0
- package/dist/PomBuilder.d.ts +28 -0
- package/dist/PomBuilder.js +81 -3
- package/dist/PomBuilder.js.map +1 -1
- package/dist/PostPrompt.d.ts +110 -0
- package/dist/PostPrompt.js +204 -0
- package/dist/PostPrompt.js.map +1 -0
- package/dist/PromptManager.d.ts +29 -1
- package/dist/PromptManager.js +37 -1
- package/dist/PromptManager.js.map +1 -1
- package/dist/PublicFetch.d.ts +132 -0
- package/dist/PublicFetch.js +311 -0
- package/dist/PublicFetch.js.map +1 -0
- package/dist/RobotsTxt.d.ts +41 -0
- package/dist/RobotsTxt.js +152 -0
- package/dist/RobotsTxt.js.map +1 -0
- package/dist/SWMLHandler.js.map +1 -1
- package/dist/SWMLService.d.ts +265 -66
- package/dist/SWMLService.js +652 -112
- package/dist/SWMLService.js.map +1 -1
- package/dist/SchemaUtils.d.ts +115 -2
- package/dist/SchemaUtils.js +444 -12
- package/dist/SchemaUtils.js.map +1 -1
- package/dist/SecurityUtils.d.ts +55 -8
- package/dist/SecurityUtils.js +162 -49
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/ServerlessAdapter.d.ts +156 -7
- package/dist/ServerlessAdapter.js +399 -42
- package/dist/ServerlessAdapter.js.map +1 -1
- package/dist/SessionManager.d.ts +11 -2
- package/dist/SessionManager.js +50 -18
- package/dist/SessionManager.js.map +1 -1
- package/dist/SslConfig.d.ts +2 -1
- package/dist/SslConfig.js +4 -1
- package/dist/SslConfig.js.map +1 -1
- package/dist/SwaigActions.generated.d.ts +23 -0
- package/dist/SwaigActions.generated.js +8 -0
- package/dist/SwaigActions.generated.js.map +1 -0
- package/dist/SwaigContracts.d.ts +15 -0
- package/dist/SwaigContracts.generated.d.ts +264 -0
- package/dist/SwaigContracts.generated.js +12 -0
- package/dist/SwaigContracts.generated.js.map +1 -0
- package/dist/SwaigContracts.js +2 -0
- package/dist/SwaigContracts.js.map +1 -0
- package/dist/SwaigFunction.d.ts +110 -4
- package/dist/SwaigFunction.js +151 -19
- package/dist/SwaigFunction.js.map +1 -1
- package/dist/SwmlBuilder.d.ts +68 -19
- package/dist/SwmlBuilder.js +74 -38
- package/dist/SwmlBuilder.js.map +1 -1
- package/dist/SwmlVerbMethods.generated.d.ts +41 -4
- package/dist/SwmlVerbMethods.generated.js +1 -1
- package/dist/TypeInference.d.ts +39 -3
- package/dist/TypeInference.js +256 -16
- package/dist/TypeInference.js.map +1 -1
- package/dist/WebService.d.ts +79 -11
- package/dist/WebService.js +320 -109
- package/dist/WebService.js.map +1 -1
- package/dist/WebhookMiddleware.d.ts +119 -0
- package/dist/WebhookMiddleware.js +271 -0
- package/dist/WebhookMiddleware.js.map +1 -0
- package/dist/WebhookValidator.d.ts +92 -0
- package/dist/WebhookValidator.js +409 -0
- package/dist/WebhookValidator.js.map +1 -0
- package/dist/agents/BedrockAgent.d.ts +162 -0
- package/dist/agents/BedrockAgent.js +323 -0
- package/dist/agents/BedrockAgent.js.map +1 -0
- package/dist/ai-chat/AIChatClient.d.ts +316 -0
- package/dist/ai-chat/AIChatClient.js +535 -0
- package/dist/ai-chat/AIChatClient.js.map +1 -0
- package/dist/ai-chat/ChatGateway.d.ts +408 -0
- package/dist/ai-chat/ChatGateway.js +747 -0
- package/dist/ai-chat/ChatGateway.js.map +1 -0
- package/dist/ai-chat/HandoffRouter.d.ts +282 -0
- package/dist/ai-chat/HandoffRouter.js +518 -0
- package/dist/ai-chat/HandoffRouter.js.map +1 -0
- package/dist/ai-chat/index.d.ts +12 -0
- package/dist/ai-chat/index.js +10 -0
- package/dist/ai-chat/index.js.map +1 -0
- package/dist/capabilities.d.ts +64 -0
- package/dist/capabilities.js +95 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +32 -6
- package/dist/cli/agent-loader.js +95 -34
- package/dist/cli/agent-loader.js.map +1 -1
- package/dist/cli/datamap-exec.d.ts +175 -0
- package/dist/cli/datamap-exec.js +1284 -0
- package/dist/cli/datamap-exec.js.map +1 -0
- package/dist/cli/function-args.d.ts +40 -0
- package/dist/cli/function-args.js +146 -0
- package/dist/cli/function-args.js.map +1 -0
- package/dist/cli/simulation.d.ts +99 -0
- package/dist/cli/simulation.js +490 -0
- package/dist/cli/simulation.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +12 -25
- package/dist/cli/swaig-test.js +935 -367
- package/dist/cli/swaig-test.js.map +1 -1
- package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
- package/dist/cli/tsdocs/agentsNote.js +92 -0
- package/dist/cli/tsdocs/agentsNote.js.map +1 -0
- package/dist/cli/tsdocs/api-index.json +1 -0
- package/dist/cli/tsdocs/api.d.ts +91 -0
- package/dist/cli/tsdocs/api.js +372 -0
- package/dist/cli/tsdocs/api.js.map +1 -0
- package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
- package/dist/cli/tsdocs/apiTypes.js +7 -0
- package/dist/cli/tsdocs/apiTypes.js.map +1 -0
- package/dist/cli/tsdocs/bin.d.ts +6 -0
- package/dist/cli/tsdocs/bin.js +23 -0
- package/dist/cli/tsdocs/bin.js.map +1 -0
- package/dist/cli/tsdocs/files.d.ts +108 -0
- package/dist/cli/tsdocs/files.js +287 -0
- package/dist/cli/tsdocs/files.js.map +1 -0
- package/dist/cli/tsdocs/index.d.ts +28 -0
- package/dist/cli/tsdocs/index.js +307 -0
- package/dist/cli/tsdocs/index.js.map +1 -0
- package/dist/cli/tsdocs/live.d.ts +41 -0
- package/dist/cli/tsdocs/live.js +202 -0
- package/dist/cli/tsdocs/live.js.map +1 -0
- package/dist/cli/tsdocs/locate.d.ts +51 -0
- package/dist/cli/tsdocs/locate.js +75 -0
- package/dist/cli/tsdocs/locate.js.map +1 -0
- package/dist/cli/tsdocs/render.d.ts +75 -0
- package/dist/cli/tsdocs/render.js +323 -0
- package/dist/cli/tsdocs/render.js.map +1 -0
- package/dist/cli/tsdocs/topics.d.ts +43 -0
- package/dist/cli/tsdocs/topics.js +916 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +102 -39
- package/dist/index.js +107 -30
- package/dist/index.js.map +1 -1
- package/dist/livewire/index.d.ts +229 -155
- package/dist/livewire/index.js +298 -195
- package/dist/livewire/index.js.map +1 -1
- package/dist/llms.txt +65 -0
- package/dist/prefabs/CallSessionStore.d.ts +52 -0
- package/dist/prefabs/CallSessionStore.js +72 -0
- package/dist/prefabs/CallSessionStore.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +13 -1
- package/dist/prefabs/ConciergeAgent.js +36 -31
- package/dist/prefabs/ConciergeAgent.js.map +1 -1
- package/dist/prefabs/FAQBotAgent.d.ts +9 -1
- package/dist/prefabs/FAQBotAgent.js +113 -47
- package/dist/prefabs/FAQBotAgent.js.map +1 -1
- package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
- package/dist/prefabs/InfoGathererAgent.js +67 -58
- package/dist/prefabs/InfoGathererAgent.js.map +1 -1
- package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
- package/dist/prefabs/ReceptionistAgent.js +39 -31
- package/dist/prefabs/ReceptionistAgent.js.map +1 -1
- package/dist/prefabs/SurveyAgent.d.ts +22 -4
- package/dist/prefabs/SurveyAgent.js +84 -68
- package/dist/prefabs/SurveyAgent.js.map +1 -1
- package/dist/relay/Action.d.ts +44 -21
- package/dist/relay/Action.js +75 -17
- package/dist/relay/Action.js.map +1 -1
- package/dist/relay/Call.d.ts +312 -47
- package/dist/relay/Call.js +369 -18
- package/dist/relay/Call.js.map +1 -1
- package/dist/relay/Deferred.js.map +1 -1
- package/dist/relay/Message.d.ts +26 -5
- package/dist/relay/Message.js +36 -6
- package/dist/relay/Message.js.map +1 -1
- package/dist/relay/RelayClient.d.ts +79 -14
- package/dist/relay/RelayClient.js +268 -61
- package/dist/relay/RelayClient.js.map +1 -1
- package/dist/relay/RelayError.d.ts +14 -0
- package/dist/relay/RelayError.js +15 -0
- package/dist/relay/RelayError.js.map +1 -1
- package/dist/relay/RelayEvent.d.ts +96 -65
- package/dist/relay/RelayEvent.js +85 -56
- package/dist/relay/RelayEvent.js.map +1 -1
- package/dist/relay/closedSets.d.ts +111 -0
- package/dist/relay/closedSets.js +83 -0
- package/dist/relay/closedSets.js.map +1 -0
- package/dist/relay/index.d.ts +3 -1
- package/dist/relay/index.js +1 -0
- package/dist/relay/index.js.map +1 -1
- package/dist/relay/normalize.js.map +1 -1
- package/dist/relay/protocol.types.generated.d.ts +1195 -0
- package/dist/relay/protocol.types.generated.js +8 -0
- package/dist/relay/protocol.types.generated.js.map +1 -0
- package/dist/relay/types.d.ts +81 -39
- package/dist/rest/HttpClient.d.ts +36 -8
- package/dist/rest/HttpClient.js +233 -40
- package/dist/rest/HttpClient.js.map +1 -1
- package/dist/rest/RequestOptions.d.ts +110 -0
- package/dist/rest/RequestOptions.js +113 -0
- package/dist/rest/RequestOptions.js.map +1 -0
- package/dist/rest/RestError.d.ts +52 -6
- package/dist/rest/RestError.js +89 -5
- package/dist/rest/RestError.js.map +1 -1
- package/dist/rest/base/CrudResource.d.ts +16 -26
- package/dist/rest/base/CrudResource.js +19 -33
- package/dist/rest/base/CrudResource.js.map +1 -1
- package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
- package/dist/rest/base/CrudWithAddresses.js +2 -2
- package/dist/rest/base/CrudWithAddresses.js.map +1 -1
- package/dist/rest/base/FabricResource.d.ts +15 -0
- package/dist/rest/base/FabricResource.js +16 -0
- package/dist/rest/base/FabricResource.js.map +1 -0
- package/dist/rest/base/ReadResource.d.ts +62 -0
- package/dist/rest/base/ReadResource.js +69 -0
- package/dist/rest/base/ReadResource.js.map +1 -0
- package/dist/rest/callHandler.d.ts +63 -0
- package/dist/rest/callHandler.js +62 -0
- package/dist/rest/callHandler.js.map +1 -0
- package/dist/rest/index.d.ts +19 -76
- package/dist/rest/index.js +49 -120
- package/dist/rest/index.js.map +1 -1
- package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
- package/dist/rest/namespaces/_client_tree_generated.js +171 -0
- package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +3 -42
- package/dist/rest/namespaces/addresses.js +3 -50
- package/dist/rest/namespaces/addresses.js.map +1 -1
- package/dist/rest/namespaces/calling.d.ts +6 -378
- package/dist/rest/namespaces/calling.js +6 -473
- package/dist/rest/namespaces/calling.js.map +1 -1
- package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
- package/dist/rest/namespaces/calling.resources.generated.js +477 -0
- package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
- package/dist/rest/namespaces/calling.types.generated.js +8 -0
- package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +4 -18
- package/dist/rest/namespaces/chat.js +4 -21
- package/dist/rest/namespaces/chat.js.map +1 -1
- package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/chat.resources.generated.js +29 -0
- package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
- package/dist/rest/namespaces/chat.types.generated.js +8 -0
- package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +6 -62
- package/dist/rest/namespaces/datasphere.js +6 -72
- package/dist/rest/namespaces/datasphere.js.map +1 -1
- package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
- package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
- package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +11 -273
- package/dist/rest/namespaces/fabric.js +14 -363
- package/dist/rest/namespaces/fabric.js.map +1 -1
- package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
- package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
- package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
- package/dist/rest/namespaces/fabric.types.generated.js +8 -0
- package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/fax.resources.generated.js +14 -0
- package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/fax.types.generated.js +8 -0
- package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
- package/dist/rest/namespaces/imported-numbers.js +3 -21
- package/dist/rest/namespaces/imported-numbers.js.map +1 -1
- package/dist/rest/namespaces/logs.d.ts +10 -101
- package/dist/rest/namespaces/logs.js +10 -128
- package/dist/rest/namespaces/logs.js.map +1 -1
- package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/logs.resources.generated.js +17 -0
- package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/logs.types.generated.js +8 -0
- package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +3 -25
- package/dist/rest/namespaces/lookup.js +3 -27
- package/dist/rest/namespaces/lookup.js.map +1 -1
- package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/message.resources.generated.js +14 -0
- package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
- package/dist/rest/namespaces/message.types.generated.js +8 -0
- package/dist/rest/namespaces/message.types.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
- package/dist/rest/namespaces/messages.resources.generated.js +44 -0
- package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
- package/dist/rest/namespaces/messages.types.generated.js +8 -0
- package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +3 -42
- package/dist/rest/namespaces/mfa.js +3 -49
- package/dist/rest/namespaces/mfa.js.map +1 -1
- package/dist/rest/namespaces/number-groups.d.ts +3 -45
- package/dist/rest/namespaces/number-groups.js +3 -53
- package/dist/rest/namespaces/number-groups.js.map +1 -1
- package/dist/rest/namespaces/phone-numbers.d.ts +9 -57
- package/dist/rest/namespaces/phone-numbers.js +9 -63
- package/dist/rest/namespaces/phone-numbers.js.map +1 -1
- package/dist/rest/namespaces/project.d.ts +6 -42
- package/dist/rest/namespaces/project.js +6 -51
- package/dist/rest/namespaces/project.js.map +1 -1
- package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
- package/dist/rest/namespaces/project.resources.generated.js +44 -0
- package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
- package/dist/rest/namespaces/project.types.generated.js +8 -0
- package/dist/rest/namespaces/project.types.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/projects.resources.generated.js +25 -0
- package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
- package/dist/rest/namespaces/projects.types.generated.js +8 -0
- package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +4 -18
- package/dist/rest/namespaces/pubsub.js +4 -21
- package/dist/rest/namespaces/pubsub.js.map +1 -1
- package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
- package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
- package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +3 -38
- package/dist/rest/namespaces/queues.js +3 -44
- package/dist/rest/namespaces/queues.js.map +1 -1
- package/dist/rest/namespaces/recordings.d.ts +3 -34
- package/dist/rest/namespaces/recordings.js +3 -40
- package/dist/rest/namespaces/recordings.js.map +1 -1
- package/dist/rest/namespaces/registry.d.ts +6 -137
- package/dist/rest/namespaces/registry.js +6 -173
- package/dist/rest/namespaces/registry.js.map +1 -1
- package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +3 -35
- package/dist/rest/namespaces/short-codes.js +3 -41
- package/dist/rest/namespaces/short-codes.js.map +1 -1
- package/dist/rest/namespaces/sip-profile.d.ts +3 -24
- package/dist/rest/namespaces/sip-profile.js +3 -29
- package/dist/rest/namespaces/sip-profile.js.map +1 -1
- package/dist/rest/namespaces/verified-callers.d.ts +3 -29
- package/dist/rest/namespaces/verified-callers.js +3 -34
- package/dist/rest/namespaces/verified-callers.js.map +1 -1
- package/dist/rest/namespaces/video.d.ts +10 -227
- package/dist/rest/namespaces/video.js +10 -288
- package/dist/rest/namespaces/video.js.map +1 -1
- package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
- package/dist/rest/namespaces/video.resources.generated.js +171 -0
- package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
- package/dist/rest/namespaces/video.types.generated.js +8 -0
- package/dist/rest/namespaces/video.types.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/voice.resources.generated.js +17 -0
- package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
- package/dist/rest/namespaces/voice.types.generated.js +8 -0
- package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
- package/dist/rest/pagination.d.ts +5 -1
- package/dist/rest/pagination.js +40 -20
- package/dist/rest/pagination.js.map +1 -1
- package/dist/rest/types.d.ts +21 -3
- package/dist/schema.json +299 -98
- package/dist/skills/SkillBase.d.ts +97 -20
- package/dist/skills/SkillBase.js +100 -17
- package/dist/skills/SkillBase.js.map +1 -1
- package/dist/skills/SkillManager.d.ts +66 -13
- package/dist/skills/SkillManager.js +101 -20
- package/dist/skills/SkillManager.js.map +1 -1
- package/dist/skills/SkillName.d.ts +44 -0
- package/dist/skills/SkillName.js +2 -0
- package/dist/skills/SkillName.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +47 -7
- package/dist/skills/SkillRegistry.js +85 -13
- package/dist/skills/SkillRegistry.js.map +1 -1
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
- package/dist/skills/builtin/api_ninjas_trivia.js +24 -8
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
- package/dist/skills/builtin/ask_claude.d.ts +14 -4
- package/dist/skills/builtin/ask_claude.js +36 -14
- package/dist/skills/builtin/ask_claude.js.map +1 -1
- package/dist/skills/builtin/claude_skills.d.ts +3 -1
- package/dist/skills/builtin/claude_skills.js +19 -15
- package/dist/skills/builtin/claude_skills.js.map +1 -1
- package/dist/skills/builtin/custom_skills.d.ts +10 -3
- package/dist/skills/builtin/custom_skills.js +26 -9
- package/dist/skills/builtin/custom_skills.js.map +1 -1
- package/dist/skills/builtin/datasphere.d.ts +5 -3
- package/dist/skills/builtin/datasphere.js +34 -25
- package/dist/skills/builtin/datasphere.js.map +1 -1
- package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
- package/dist/skills/builtin/datasphere_serverless.js +17 -6
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
- package/dist/skills/builtin/datetime.d.ts +3 -1
- package/dist/skills/builtin/datetime.js +11 -7
- package/dist/skills/builtin/datetime.js.map +1 -1
- package/dist/skills/builtin/google_maps.d.ts +29 -14
- package/dist/skills/builtin/google_maps.js +89 -269
- package/dist/skills/builtin/google_maps.js.map +1 -1
- package/dist/skills/builtin/index.d.ts +8 -6
- package/dist/skills/builtin/index.js +8 -6
- package/dist/skills/builtin/index.js.map +1 -1
- package/dist/skills/builtin/info_gatherer.d.ts +4 -2
- package/dist/skills/builtin/info_gatherer.js +20 -12
- package/dist/skills/builtin/info_gatherer.js.map +1 -1
- package/dist/skills/builtin/joke.d.ts +16 -6
- package/dist/skills/builtin/joke.js +54 -37
- package/dist/skills/builtin/joke.js.map +1 -1
- package/dist/skills/builtin/math.d.ts +3 -1
- package/dist/skills/builtin/math.js +14 -9
- package/dist/skills/builtin/math.js.map +1 -1
- package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
- package/dist/skills/builtin/mcp_gateway.js +77 -46
- package/dist/skills/builtin/mcp_gateway.js.map +1 -1
- package/dist/skills/builtin/native_vector_search.d.ts +19 -5
- package/dist/skills/builtin/native_vector_search.js +179 -61
- package/dist/skills/builtin/native_vector_search.js.map +1 -1
- package/dist/skills/builtin/play_background_file.d.ts +21 -15
- package/dist/skills/builtin/play_background_file.js +43 -122
- package/dist/skills/builtin/play_background_file.js.map +1 -1
- package/dist/skills/builtin/spider.d.ts +46 -1
- package/dist/skills/builtin/spider.js +317 -101
- package/dist/skills/builtin/spider.js.map +1 -1
- package/dist/skills/builtin/swml_transfer.d.ts +14 -3
- package/dist/skills/builtin/swml_transfer.js +45 -24
- package/dist/skills/builtin/swml_transfer.js.map +1 -1
- package/dist/skills/builtin/weather_api.d.ts +24 -13
- package/dist/skills/builtin/weather_api.js +57 -31
- package/dist/skills/builtin/weather_api.js.map +1 -1
- package/dist/skills/builtin/web_search.d.ts +48 -10
- package/dist/skills/builtin/web_search.js +301 -84
- package/dist/skills/builtin/web_search.js.map +1 -1
- package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
- package/dist/skills/builtin/wikipedia_search.js +32 -14
- package/dist/skills/builtin/wikipedia_search.js.map +1 -1
- package/dist/skills/index.d.ts +3 -2
- package/dist/skills/index.js +1 -1
- package/dist/skills/index.js.map +1 -1
- package/dist/swml_verbs_generated.d.ts +2824 -0
- package/dist/swml_verbs_generated.js +12 -0
- package/dist/swml_verbs_generated.js.map +1 -0
- package/dist/types.d.ts +65 -6
- package/dist/web.d.ts +27 -0
- package/dist/web.js +20 -0
- package/dist/web.js.map +1 -0
- package/docs/agent-guide.md +1034 -0
- package/docs/ai_chat.md +560 -0
- package/docs/api-reference.md +3534 -0
- package/docs/architecture.md +846 -0
- package/docs/bedrock_agent.md +411 -0
- package/docs/cli-guide.md +403 -0
- package/docs/cloud_functions_guide.md +399 -0
- package/docs/configuration.md +548 -0
- package/docs/contexts-guide.md +884 -0
- package/docs/datamap-guide.md +1160 -0
- package/docs/developer_pain_points.md +548 -0
- package/docs/llm_parameters.md +298 -0
- package/docs/mcp_gateway_reference.md +354 -0
- package/docs/mcp_integration.md +162 -0
- package/docs/pgi_agent_guide.md +1820 -0
- package/docs/prefabs-guide.md +815 -0
- package/docs/programmatically_governed_inference.md +301 -0
- package/docs/sdk_features.md +501 -0
- package/docs/security.md +559 -0
- package/docs/serverless-guide.md +520 -0
- package/docs/skills-guide.md +1223 -0
- package/docs/skills-system.md +405 -0
- package/docs/skills_parameter_schema.md +417 -0
- package/docs/swaig-reference.md +1938 -0
- package/docs/swml_service_guide.md +573 -0
- package/docs/third_party_skills.md +410 -0
- package/docs/web_service.md +666 -0
- package/examples/README.md +202 -0
- package/examples/advanced-datamap.ts +108 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +95 -0
- package/examples/call-flow.ts +65 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +51 -0
- package/examples/datasphere-multi-instance.ts +66 -0
- package/examples/datasphere-serverless-env.ts +87 -0
- package/examples/datasphere-webhook-env.ts +65 -0
- package/examples/datasphere.ts +56 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +95 -0
- package/examples/gather-per-question-functions-demo.ts +139 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +75 -0
- package/examples/mcp-agent.ts +89 -0
- package/examples/mcp-gateway.ts +81 -0
- package/examples/multi-agent.ts +80 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pgi/case-domain.ts +114 -0
- package/examples/pgi/serve.ts +16 -0
- package/examples/pgi/support-agent.ts +265 -0
- package/examples/pom-prompt.ts +70 -0
- package/examples/prefab-concierge.ts +42 -0
- package/examples/prefab-faq.ts +58 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +69 -0
- package/examples/quickstart-agent.ts +29 -0
- package/examples/quickstart-relay.ts +25 -0
- package/examples/quickstart-rest.ts +25 -0
- package/examples/record-call.ts +65 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +93 -0
- package/examples/serverless-lambda.ts +43 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +41 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +193 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/swmlservice_ai_sidecar.ts +104 -0
- package/examples/swmlservice_swaig_standalone.ts +79 -0
- package/examples/tap.ts +67 -0
- package/examples/typed-tools.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +75 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +164 -0
- package/livewire/docs/migration-guide.md +251 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +196 -0
- package/livewire/examples/livewire-multi-tool.ts +121 -0
- package/package.json +88 -13
- package/relay/README.md +101 -0
- package/relay/docs/call-methods.md +622 -0
- package/relay/docs/client-reference.md +281 -0
- package/relay/docs/events.md +193 -0
- package/relay/docs/getting-started.md +221 -0
- package/relay/docs/guide.md +386 -0
- package/relay/docs/messaging.md +246 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +74 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +141 -0
- package/rest/docs/calling.md +313 -0
- package/rest/docs/client-reference.md +149 -0
- package/rest/docs/fabric.md +192 -0
- package/rest/docs/getting-started.md +138 -0
- package/rest/docs/guide.md +421 -0
- package/rest/docs/namespaces.md +367 -0
- package/rest/docs/phone-binding.md +116 -0
- package/rest/examples/rest-10dlc-registration.ts +177 -0
- package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
- package/rest/examples/rest-calling-play-and-record.ts +98 -0
- package/rest/examples/rest-client.ts +59 -0
- package/rest/examples/rest-datasphere-search.ts +81 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
- package/rest/examples/rest-manage-resources.ts +64 -0
- package/rest/examples/rest-phone-number-management.ts +200 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/tutorial/fred/fred.ts +218 -0
- package/tutorial/fred/tutorial/01-introduction.md +141 -0
- package/tutorial/fred/tutorial/02-setup.md +304 -0
- package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
- package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
- package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
- package/tutorial/fred/tutorial/06-running-testing.md +642 -0
- package/tutorial/fred/tutorial/README.md +56 -0
- package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
- package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
- package/tutorial/full-guardrails-agent/handlers.ts +436 -0
- package/tutorial/full-guardrails-agent/penny.ts +305 -0
- package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
- package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
- package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
- package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
- package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
- package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
- package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
- package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
- package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
- package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
- package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
- package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
- package/tutorial/full-guardrails-agent/workflow.ts +219 -0
- package/tutorial/multi_agents/README.md +175 -0
- package/tutorial/multi_agents/advanced_agent.ts +395 -0
- package/tutorial/multi_agents/extending_agents.ts +641 -0
- package/tutorial/multi_agents/knowledge.ts +59 -0
- package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
- package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
- package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
- package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
- package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
- package/tutorial/multi_agents/pc_builder.ts +529 -0
- package/tutorial/multi_agents/sales_agent.ts +88 -0
- package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
- package/tutorial/multi_agents/sales_knowledge.md +139 -0
- package/tutorial/multi_agents/support_knowledge.md +256 -0
- package/dist/cli/mock-data.d.ts +0 -37
- package/dist/cli/mock-data.js +0 -80
- package/dist/cli/mock-data.js.map +0 -1
- package/dist/generateVerbTypes.d.ts +0 -11
- package/dist/generateVerbTypes.js +0 -265
- package/dist/generateVerbTypes.js.map +0 -1
- package/dist/rest/namespaces/compat.d.ts +0 -585
- package/dist/rest/namespaces/compat.js +0 -735
- package/dist/rest/namespaces/compat.js.map +0 -1
|
@@ -0,0 +1,284 @@
|
|
|
1
|
+
# Lesson 3: Creating Fred's Basic Structure
|
|
2
|
+
|
|
3
|
+
This lesson builds Fred's foundation: the agent class, the prompt that sets its persona, its voice, and its conversation settings. Fred can't search anything yet. Lesson 4 adds that.
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
1. [Creating the Agent Class](#creating-the-agent-class)
|
|
8
|
+
2. [Defining Fred's Personality](#defining-freds-personality)
|
|
9
|
+
3. [Configuring Voice and Language](#configuring-voice-and-language)
|
|
10
|
+
4. [Setting Conversation Parameters](#setting-conversation-parameters)
|
|
11
|
+
5. [Adding Speech Recognition Hints](#adding-speech-recognition-hints)
|
|
12
|
+
6. [Testing the Basic Structure](#testing-the-basic-structure)
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Creating the Agent Class
|
|
17
|
+
|
|
18
|
+
Fred is a class that extends `AgentBase`. Create a new file called `fred.ts` in the project directory.
|
|
19
|
+
|
|
20
|
+
### Step 1: Import and Class Definition
|
|
21
|
+
|
|
22
|
+
Start with the import and the class:
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
/**
|
|
26
|
+
* Fred: a Wikipedia knowledge bot
|
|
27
|
+
*
|
|
28
|
+
* An agent that searches Wikipedia and shares facts about Wikipedia itself,
|
|
29
|
+
* with a friendly, curious persona.
|
|
30
|
+
*
|
|
31
|
+
* Run: npx tsx fred.ts
|
|
32
|
+
*/
|
|
33
|
+
|
|
34
|
+
import { AgentBase } from '@signalwire/sdk';
|
|
35
|
+
|
|
36
|
+
/** Fred, a Wikipedia assistant with a friendly persona. */
|
|
37
|
+
export class FredTheWikiBot extends AgentBase {
|
|
38
|
+
constructor() {
|
|
39
|
+
super({ name: 'Fred', route: '/fred' });
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Each part has a job:
|
|
45
|
+
|
|
46
|
+
- `AgentBase` is the SDK class every agent is built from. Lessons 4 and 5 add two more names to this import.
|
|
47
|
+
- `export` lets other files, and the SDK's test tool, use the class
|
|
48
|
+
- `name: 'Fred'` is the agent's name
|
|
49
|
+
- `route: '/fred'` is the agent's HTTP path, so Fred answers at `http://localhost:3000/fred`
|
|
50
|
+
|
|
51
|
+
Every step in the rest of this lesson adds code inside the constructor, after the `super()` call.
|
|
52
|
+
|
|
53
|
+
## Defining Fred's Personality
|
|
54
|
+
|
|
55
|
+
The prompt tells the model who Fred is and how to behave. The SDK builds it from named sections, using the Prompt Object Model (POM).
|
|
56
|
+
|
|
57
|
+
### Step 2: Add Personality Section
|
|
58
|
+
|
|
59
|
+
The first section sets the persona:
|
|
60
|
+
|
|
61
|
+
<!-- include: tutorial/fred/fred.ts#personality --> <!-- snippet: no-compile a quote from inside the constructor in tutorial/fred/fred.ts, which tsc checks whole -->
|
|
62
|
+
```typescript
|
|
63
|
+
// Set up Fred's personality with the Prompt Object Model
|
|
64
|
+
this.promptAddSection('Personality', {
|
|
65
|
+
body:
|
|
66
|
+
'You are Fred, a friendly and knowledgeable assistant who loves learning and ' +
|
|
67
|
+
"sharing information from Wikipedia. You're enthusiastic about facts and always " +
|
|
68
|
+
'eager to help people discover new things.',
|
|
69
|
+
});
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
`promptAddSection()` takes the section's title and an object with its content. A section has a `body`, a list of `bullets`, or both.
|
|
73
|
+
|
|
74
|
+
### Step 3: Add Goal and Instructions
|
|
75
|
+
|
|
76
|
+
Two more sections give Fred a goal and specific instructions:
|
|
77
|
+
|
|
78
|
+
<!-- include: tutorial/fred/fred.ts#goal --> <!-- snippet: no-compile a quote from inside the constructor in tutorial/fred/fred.ts, which tsc checks whole -->
|
|
79
|
+
```typescript
|
|
80
|
+
this.promptAddSection('Goal', {
|
|
81
|
+
body:
|
|
82
|
+
'Help users find reliable factual information by searching Wikipedia. ' +
|
|
83
|
+
'Make learning fun and engaging.',
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
this.promptAddSection('Instructions', {
|
|
87
|
+
bullets: [
|
|
88
|
+
'Introduce yourself as Fred when greeting users',
|
|
89
|
+
'Use the search_wiki function whenever users ask about factual topics',
|
|
90
|
+
'Be enthusiastic about sharing knowledge',
|
|
91
|
+
'Search before you say Wikipedia has nothing on a topic, even one that sounds made up',
|
|
92
|
+
"If Wikipedia doesn't have information, suggest alternative search terms",
|
|
93
|
+
'Make learning conversational and enjoyable',
|
|
94
|
+
'Add interesting context or follow-up questions to engage users',
|
|
95
|
+
],
|
|
96
|
+
});
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
Each section has a purpose:
|
|
100
|
+
|
|
101
|
+
- **Personality**: Fred's character and tone
|
|
102
|
+
- **Goal**: what Fred is for
|
|
103
|
+
- **Instructions**: specific behavior, as bullet points
|
|
104
|
+
|
|
105
|
+
The instructions name `search_wiki`, the function Lesson 4 adds. The fourth bullet comes from testing. Without it, the model sometimes decided a topic sounded made up, and said Wikipedia had nothing on it without searching.
|
|
106
|
+
|
|
107
|
+
## Configuring Voice and Language
|
|
108
|
+
|
|
109
|
+
A language entry sets the voice Fred speaks with, and the phrases it can say while it thinks.
|
|
110
|
+
|
|
111
|
+
### Step 4: Add Language Configuration
|
|
112
|
+
|
|
113
|
+
Add the language after the prompt sections:
|
|
114
|
+
|
|
115
|
+
<!-- include: tutorial/fred/fred.ts#voice --> <!-- snippet: no-compile a quote from inside the constructor in tutorial/fred/fred.ts, which tsc checks whole -->
|
|
116
|
+
```typescript
|
|
117
|
+
// Configure Fred's voice
|
|
118
|
+
this.addLanguage({
|
|
119
|
+
name: 'English',
|
|
120
|
+
code: 'en-US',
|
|
121
|
+
voice: 'rime.bolt', // A friendly, energetic voice for Fred
|
|
122
|
+
speechFillers: [
|
|
123
|
+
'Hmm, let me think...',
|
|
124
|
+
"Oh, that's interesting...",
|
|
125
|
+
'Great question!',
|
|
126
|
+
'Let me see...',
|
|
127
|
+
],
|
|
128
|
+
});
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
The settings work like this:
|
|
132
|
+
|
|
133
|
+
- `name`: a display name for the language
|
|
134
|
+
- `code`: the language code, `en-US` for US English
|
|
135
|
+
- `voice`: the text-to-speech voice, written as `provider.voice_name`. `rime.bolt` is the Rime provider's "bolt" voice.
|
|
136
|
+
- `speechFillers`: phrases the platform can say while the model prepares a reply
|
|
137
|
+
|
|
138
|
+
The SWML document spells this setting `fillers`, because Fred sets no function fillers. The agent guide's [Languages](../../../docs/agent-guide.md#languages) section covers the other language settings.
|
|
139
|
+
|
|
140
|
+
## Setting Conversation Parameters
|
|
141
|
+
|
|
142
|
+
Parameters control how the conversation runs: which model, who speaks first, and how long a pause ends a turn.
|
|
143
|
+
|
|
144
|
+
### Step 5: Set AI Parameters
|
|
145
|
+
|
|
146
|
+
Set the parameters with `setParams()`:
|
|
147
|
+
|
|
148
|
+
<!-- include: tutorial/fred/fred.ts#params --> <!-- snippet: no-compile a quote from inside the constructor in tutorial/fred/fred.ts, which tsc checks whole -->
|
|
149
|
+
```typescript
|
|
150
|
+
// Set conversation parameters
|
|
151
|
+
this.setParams({
|
|
152
|
+
ai_model: 'gpt-4.1-nano', // The model that runs the conversation
|
|
153
|
+
wait_for_user: true, // The caller speaks first
|
|
154
|
+
end_of_speech_timeout: 1000, // Milliseconds of silence that end the caller's turn
|
|
155
|
+
ai_volume: 7, // Voice volume adjustment (-50 to 50, default 0)
|
|
156
|
+
local_tz: 'America/New_York', // Time zone for time-related functions
|
|
157
|
+
});
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
The keys are the SWML schema's own names, in `snake_case`. Each has a range the platform accepts:
|
|
161
|
+
|
|
162
|
+
- `ai_model`: the model that runs the conversation. The SWML schema lists `gpt-4o-mini` (the default), `gpt-4.1-mini` and `gpt-4.1-nano`. Fred uses `gpt-4.1-nano`, the smallest of the three.
|
|
163
|
+
- `wait_for_user`: when `true`, the caller speaks first. When `false`, the agent opens the conversation.
|
|
164
|
+
- `end_of_speech_timeout`: how many milliseconds of silence end the caller's turn, from 250 to 10,000. The default is 700.
|
|
165
|
+
- `ai_volume`: raises or lowers the agent's voice, from -50 to 50. The default is 0.
|
|
166
|
+
- `local_tz`: the agent's time zone, as an IANA name
|
|
167
|
+
|
|
168
|
+
### Step 6: Add Global Data
|
|
169
|
+
|
|
170
|
+
Global data is session data that travels with the call:
|
|
171
|
+
|
|
172
|
+
<!-- include: tutorial/fred/fred.ts#global-data --> <!-- snippet: no-compile a quote from inside the constructor in tutorial/fred/fred.ts, which tsc checks whole -->
|
|
173
|
+
```typescript
|
|
174
|
+
// Add some context about Fred
|
|
175
|
+
this.setGlobalData({
|
|
176
|
+
assistant_name: 'Fred',
|
|
177
|
+
specialty: 'Wikipedia knowledge',
|
|
178
|
+
personality_traits: ['friendly', 'curious', 'enthusiastic', 'helpful'],
|
|
179
|
+
});
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
The model doesn't see global data unless a prompt refers to a key, such as `${global_data.specialty}`. Functions receive it with every request, as `rawData.global_data`, so it's a place for facts your code needs during the call.
|
|
183
|
+
|
|
184
|
+
## Adding Speech Recognition Hints
|
|
185
|
+
|
|
186
|
+
Hints tell speech recognition which words and phrases to expect.
|
|
187
|
+
|
|
188
|
+
### Step 7: Add Recognition Hints
|
|
189
|
+
|
|
190
|
+
Add the words callers are likely to say to Fred:
|
|
191
|
+
|
|
192
|
+
<!-- include: tutorial/fred/fred.ts#hints --> <!-- snippet: no-compile a quote from inside the constructor in tutorial/fred/fred.ts, which tsc checks whole -->
|
|
193
|
+
```typescript
|
|
194
|
+
// Add hints for better speech recognition
|
|
195
|
+
this.addHints([
|
|
196
|
+
'Wikipedia',
|
|
197
|
+
'Fred',
|
|
198
|
+
'tell me about',
|
|
199
|
+
'what is',
|
|
200
|
+
'who is',
|
|
201
|
+
'search for',
|
|
202
|
+
'look up',
|
|
203
|
+
]);
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
Hints improve recognition accuracy when callers say these words. The order of Steps 2 to 7 doesn't matter to the SDK. The finished `fred.ts` in [Appendix A](appendix-complete-code.md#complete-fredts) adds the hints before the parameters.
|
|
207
|
+
|
|
208
|
+
## Testing the Basic Structure
|
|
209
|
+
|
|
210
|
+
Creating Fred doesn't start a server, so a few lines at the end of the file can build it and print what it is. Add them after the class:
|
|
211
|
+
|
|
212
|
+
<!-- snippet: no-compile continues fred.ts from Step 1, whose FredTheWikiBot class it uses -->
|
|
213
|
+
```typescript
|
|
214
|
+
// Build Fred without starting a server, and show what it is
|
|
215
|
+
const fred = new FredTheWikiBot();
|
|
216
|
+
console.log('Fred created.');
|
|
217
|
+
console.log(` Name: ${fred.getName()}`);
|
|
218
|
+
console.log(` Route: ${fred.route}`);
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
Run the file to build the agent and print its name and route:
|
|
222
|
+
|
|
223
|
+
```bash
|
|
224
|
+
npx tsx fred.ts
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
Two warnings from the SDK come first. The first says that Fred doesn't check webhook signatures, and the second says the SDK generated a password, because none is set. [Lesson 6](06-running-testing.md#important-information) covers both. The rest of the output confirms the agent's name and route:
|
|
228
|
+
|
|
229
|
+
```text
|
|
230
|
+
2026-09-29T17:33:25.871Z [WARN] [AgentBase] [signalwire] webhook signature validation is disabled — set signingKey or SIGNALWIRE_SIGNING_KEY to enable
|
|
231
|
+
2026-09-29T17:33:25.872Z [WARN] [AgentBase] basic_auth_password_autogenerated: username="Fred". No SWML_BASIC_AUTH_PASSWORD found in environment and no basicAuth passed to the agent constructor. The SDK generated a random password that exists only in this process; external callers will get HTTP 401 unless this process hands it to them (getBasicAuthCredentials()). To fix, set SWML_BASIC_AUTH_USER and SWML_BASIC_AUTH_PASSWORD in your .env, or pass { basicAuth: [user, pass] } to the agent constructor.
|
|
232
|
+
Fred created.
|
|
233
|
+
Name: Fred
|
|
234
|
+
Route: /fred
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
The `typecheck` script from [Lesson 2](02-setup.md#the-packagejson-file) runs `tsc` over the file. `tsx` runs a file without checking its types, so run the check after each change:
|
|
238
|
+
|
|
239
|
+
```bash
|
|
240
|
+
npm run typecheck
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
When the types are right, the output shows only the command npm ran:
|
|
244
|
+
|
|
245
|
+
```text
|
|
246
|
+
> fred-bot@1.0.0 typecheck
|
|
247
|
+
> tsc --noEmit
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
## Key Concepts Review
|
|
251
|
+
|
|
252
|
+
This lesson used three of the SDK's building blocks.
|
|
253
|
+
|
|
254
|
+
### Prompt Object Model (POM)
|
|
255
|
+
|
|
256
|
+
POM organizes the prompt into named sections:
|
|
257
|
+
|
|
258
|
+
- Easier to maintain than one long prompt
|
|
259
|
+
- Each behavior can be updated in its own section
|
|
260
|
+
- A clear structure as the agent grows
|
|
261
|
+
|
|
262
|
+
### Voice Configuration
|
|
263
|
+
|
|
264
|
+
The language entry controls how Fred sounds:
|
|
265
|
+
|
|
266
|
+
- Several text-to-speech providers are available
|
|
267
|
+
- Each voice has its own character
|
|
268
|
+
- Speech fillers cover the pause while the model prepares a reply
|
|
269
|
+
|
|
270
|
+
### Global Data
|
|
271
|
+
|
|
272
|
+
Global data holds session facts:
|
|
273
|
+
|
|
274
|
+
- Functions receive it with every request
|
|
275
|
+
- The model sees a value only when a prompt refers to it
|
|
276
|
+
- It can hold any JSON-serializable data
|
|
277
|
+
|
|
278
|
+
## Next Steps
|
|
279
|
+
|
|
280
|
+
Fred has a persona and a voice, but it can't search Wikipedia yet. Continue with [Lesson 4: Adding the Wikipedia Search Skill](04-wikipedia-skill.md).
|
|
281
|
+
|
|
282
|
+
---
|
|
283
|
+
|
|
284
|
+
[Previous: Environment Setup](02-setup.md) | [Overview](README.md) | [Next: Wikipedia Skill](04-wikipedia-skill.md)
|
|
@@ -0,0 +1,298 @@
|
|
|
1
|
+
# Lesson 4: Adding the Wikipedia Search Skill
|
|
2
|
+
|
|
3
|
+
Fred's job is answering questions from Wikipedia. Instead of writing the search code, this lesson adds the SDK's `wikipedia_search` skill, configures it, and looks at what the skill does inside the agent.
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
1. [Understanding Skills](#understanding-skills)
|
|
8
|
+
2. [Adding the Wikipedia Skill](#adding-the-wikipedia-skill)
|
|
9
|
+
3. [Configuring the Skill](#configuring-the-skill)
|
|
10
|
+
4. [How Skills Work Internally](#how-skills-work-internally)
|
|
11
|
+
5. [Testing Wikipedia Search](#testing-wikipedia-search)
|
|
12
|
+
6. [How Fred Uses Wikipedia Search](#how-fred-uses-wikipedia-search)
|
|
13
|
+
7. [Skill Benefits](#skill-benefits)
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Understanding Skills
|
|
18
|
+
|
|
19
|
+
Skills are modules that add a capability to an agent, much like plugins.
|
|
20
|
+
|
|
21
|
+
### What Is a Skill?
|
|
22
|
+
|
|
23
|
+
A skill has four properties:
|
|
24
|
+
|
|
25
|
+
- It's a self-contained class with one capability
|
|
26
|
+
- It registers its own functions and prompt text with the agent
|
|
27
|
+
- It's configured with an object of parameters
|
|
28
|
+
- It can be reused across agents
|
|
29
|
+
|
|
30
|
+
### Available Built-in Skills
|
|
31
|
+
|
|
32
|
+
The SDK includes several ready-made skills, including:
|
|
33
|
+
|
|
34
|
+
- `wikipedia_search`: search Wikipedia articles
|
|
35
|
+
- `datetime`: get the current date and time
|
|
36
|
+
- `math`: perform calculations
|
|
37
|
+
- `web_search`: search the web with the Google Custom Search API (needs an API key and the `cheerio` package)
|
|
38
|
+
- `weather_api`: get the weather from OpenWeatherMap (needs an API key)
|
|
39
|
+
|
|
40
|
+
The [Skills System Guide](../../../docs/skills-guide.md#built-in-skills) lists every built-in skill and what it needs.
|
|
41
|
+
|
|
42
|
+
## Adding the Wikipedia Skill
|
|
43
|
+
|
|
44
|
+
A skill is a class. You create it, then pass it to the agent's `addSkill()` method.
|
|
45
|
+
|
|
46
|
+
### Step 1: Basic Skill Addition
|
|
47
|
+
|
|
48
|
+
`addSkill()` returns a promise, because a skill can do setup work before it's ready. A constructor can't wait for a promise, so the skill doesn't go in Fred's constructor. Instead, an `async` function builds Fred and then adds the skill.
|
|
49
|
+
|
|
50
|
+
First, add `WikipediaSearchSkill` to the import at the top of `fred.ts`:
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
import { AgentBase, WikipediaSearchSkill } from '@signalwire/sdk';
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Then add this function after the class:
|
|
57
|
+
|
|
58
|
+
<!-- snippet: no-compile continues fred.ts, whose FredTheWikiBot class it uses -->
|
|
59
|
+
```typescript
|
|
60
|
+
/** Build Fred, then add the Wikipedia search skill, which loads asynchronously. */
|
|
61
|
+
export async function createFred(): Promise<FredTheWikiBot> {
|
|
62
|
+
const fred = new FredTheWikiBot();
|
|
63
|
+
|
|
64
|
+
// Add the Wikipedia search skill
|
|
65
|
+
await fred.addSkill(new WikipediaSearchSkill());
|
|
66
|
+
|
|
67
|
+
return fred;
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
With that function, Fred can search Wikipedia. The next step tunes the skill for Fred.
|
|
72
|
+
|
|
73
|
+
### Step 2: Customized Configuration
|
|
74
|
+
|
|
75
|
+
Replace the function with a version that configures the skill:
|
|
76
|
+
|
|
77
|
+
<!-- include: tutorial/fred/fred.ts#create --> <!-- snippet: no-compile a quote of the createFred function in tutorial/fred/fred.ts, which tsc checks whole -->
|
|
78
|
+
```typescript
|
|
79
|
+
/** Build Fred, then add the Wikipedia search skill, which loads asynchronously. */
|
|
80
|
+
export async function createFred(): Promise<FredTheWikiBot> {
|
|
81
|
+
const fred = new FredTheWikiBot();
|
|
82
|
+
|
|
83
|
+
// Add the Wikipedia search skill with custom configuration
|
|
84
|
+
await fred.addSkill(
|
|
85
|
+
new WikipediaSearchSkill({
|
|
86
|
+
num_results: 2, // Get up to 2 articles for broader coverage
|
|
87
|
+
no_results_message:
|
|
88
|
+
"Oh, I couldn't find anything about '{query}' on Wikipedia. " +
|
|
89
|
+
'Maybe try different keywords or let me know if you meant something else!',
|
|
90
|
+
swaig_fields: {
|
|
91
|
+
fillers: {
|
|
92
|
+
'en-US': [
|
|
93
|
+
'Let me look that up on Wikipedia for you...',
|
|
94
|
+
'Searching Wikipedia for that information...',
|
|
95
|
+
'One moment, checking Wikipedia...',
|
|
96
|
+
'Let me find that in the encyclopedia...',
|
|
97
|
+
],
|
|
98
|
+
},
|
|
99
|
+
},
|
|
100
|
+
}),
|
|
101
|
+
);
|
|
102
|
+
|
|
103
|
+
return fred;
|
|
104
|
+
}
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
The configuration keys are `snake_case`, as they are in the SignalWire SDKs for other languages.
|
|
108
|
+
|
|
109
|
+
## Configuring the Skill
|
|
110
|
+
|
|
111
|
+
The configuration object has three options.
|
|
112
|
+
|
|
113
|
+
### Configuration Parameters
|
|
114
|
+
|
|
115
|
+
Each option changes one part of how the skill behaves:
|
|
116
|
+
|
|
117
|
+
| Option | Default | What it does |
|
|
118
|
+
|---|---|---|
|
|
119
|
+
| `num_results` | `1` | The number of Wikipedia articles to return. The skill's parameter schema allows 1 to 5. More results cover more ground, and make longer responses. Fred uses 2. |
|
|
120
|
+
| `no_results_message` | A generic "couldn't find" message | What the function returns when no article matches. `{query}` is replaced with the search term. Write it in the agent's voice, because the model relays it to the caller. |
|
|
121
|
+
| `swaig_fields` | None | Extra settings for the function the skill registers. `fillers` are phrases the platform says while the search runs, by language code. |
|
|
122
|
+
|
|
123
|
+
The skill searches English Wikipedia, `en.wikipedia.org`, and has no option for another language.
|
|
124
|
+
|
|
125
|
+
### Example Configurations
|
|
126
|
+
|
|
127
|
+
Different agents need different settings. This example gives three agents three configurations:
|
|
128
|
+
|
|
129
|
+
```typescript
|
|
130
|
+
import { AgentBase, WikipediaSearchSkill } from '@signalwire/sdk';
|
|
131
|
+
|
|
132
|
+
// Minimal configuration
|
|
133
|
+
const minimal = new AgentBase({ name: 'minimal', route: '/minimal' });
|
|
134
|
+
await minimal.addSkill(new WikipediaSearchSkill());
|
|
135
|
+
|
|
136
|
+
// Academic assistant
|
|
137
|
+
const academic = new AgentBase({ name: 'academic', route: '/academic' });
|
|
138
|
+
await academic.addSkill(
|
|
139
|
+
new WikipediaSearchSkill({
|
|
140
|
+
num_results: 3,
|
|
141
|
+
no_results_message:
|
|
142
|
+
"No Wikipedia entries found for '{query}'. Check the spelling or try related terms.",
|
|
143
|
+
}),
|
|
144
|
+
);
|
|
145
|
+
|
|
146
|
+
// Casual helper
|
|
147
|
+
const casual = new AgentBase({ name: 'casual', route: '/casual' });
|
|
148
|
+
await casual.addSkill(
|
|
149
|
+
new WikipediaSearchSkill({
|
|
150
|
+
num_results: 1,
|
|
151
|
+
no_results_message: "Hmm, Wikipedia doesn't have info on '{query}'. Got another topic?",
|
|
152
|
+
swaig_fields: {
|
|
153
|
+
fillers: { 'en-US': ['Let me check...', 'Looking that up...'] },
|
|
154
|
+
},
|
|
155
|
+
}),
|
|
156
|
+
);
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
## How Skills Work Internally
|
|
160
|
+
|
|
161
|
+
`addSkill()` does three things when it runs.
|
|
162
|
+
|
|
163
|
+
### What Happens When You Add a Skill
|
|
164
|
+
|
|
165
|
+
1. **Checks.** The agent's skill manager refuses a second copy of a skill that allows only one. It also checks the environment variables and packages the skill needs, and `wikipedia_search` needs none.
|
|
166
|
+
|
|
167
|
+
2. **Setup.** It awaits the skill's `setup()` method. The Wikipedia skill reads `num_results` and `no_results_message` there. A skill whose `setup()` returns `false` isn't added, and `addSkill()` rejects.
|
|
168
|
+
|
|
169
|
+
3. **Registration.** The agent registers what the skill contributes: its functions, its prompt sections, its hints and its global data. This is the function definition in the skill's own code, `src/skills/builtin/wikipedia_search.ts`:
|
|
170
|
+
|
|
171
|
+
<!-- copy of: src/skills/builtin/wikipedia_search.ts (excerpt) --> <!-- snippet: no-compile an excerpt from the skill's getTools() method in the SDK source -->
|
|
172
|
+
```typescript
|
|
173
|
+
defineSkillTool({
|
|
174
|
+
name: 'search_wiki',
|
|
175
|
+
description: 'Search Wikipedia for information about a topic and get article summaries',
|
|
176
|
+
parameters: {
|
|
177
|
+
query: {
|
|
178
|
+
type: 'string',
|
|
179
|
+
description: 'The search term or topic to look up on Wikipedia.',
|
|
180
|
+
},
|
|
181
|
+
},
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
The skill also adds a "Wikipedia Search" section to the prompt, which tells the model when to use the function and how many summaries it returns.
|
|
185
|
+
|
|
186
|
+
### The search_wiki Function
|
|
187
|
+
|
|
188
|
+
After adding the skill, Fred has a `search_wiki` function. It takes one string argument and returns text:
|
|
189
|
+
|
|
190
|
+
```text
|
|
191
|
+
search_wiki(query: string): string
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
When the model calls it, the function:
|
|
195
|
+
|
|
196
|
+
1. Searches Wikipedia for articles that match the query
|
|
197
|
+
2. Retrieves the introduction of each article
|
|
198
|
+
3. Returns the introductions as text, separated by a line of `=` characters
|
|
199
|
+
|
|
200
|
+
The model calls it with the caller's topic as the `query` argument, for example `{ "query": "Marie Curie" }`.
|
|
201
|
+
|
|
202
|
+
## Testing Wikipedia Search
|
|
203
|
+
|
|
204
|
+
A few lines at the end of `fred.ts` can confirm the skill loaded, without starting a server.
|
|
205
|
+
|
|
206
|
+
### Step 3: Update the Test Lines
|
|
207
|
+
|
|
208
|
+
Replace the test lines from Lesson 3 with these. `createFred` is `async`, so they `await` it:
|
|
209
|
+
|
|
210
|
+
<!-- snippet: no-compile continues fred.ts, whose createFred function it uses -->
|
|
211
|
+
```typescript
|
|
212
|
+
// Build Fred and list what the skill added
|
|
213
|
+
const fred = await createFred();
|
|
214
|
+
console.log(`Fred's skills: ${fred.listSkills().map((skill) => skill.name).join(', ')}`);
|
|
215
|
+
console.log(`Fred's tools: ${fred.getTools().map((tool) => tool.name).join(', ')}`);
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
`listSkills()` returns the loaded skills, and `getTools()` returns the functions the agent registered. Run the file:
|
|
219
|
+
|
|
220
|
+
```bash
|
|
221
|
+
npx tsx fred.ts
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
After the same two warnings as in Lesson 3, the output lists the skill and the function it added:
|
|
225
|
+
|
|
226
|
+
```text
|
|
227
|
+
Fred's skills: wikipedia_search
|
|
228
|
+
Fred's tools: search_wiki
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
## How Fred Uses Wikipedia Search
|
|
232
|
+
|
|
233
|
+
When a caller asks about a topic, five things happen:
|
|
234
|
+
|
|
235
|
+
1. **The caller says:** "Who was Marie Curie?"
|
|
236
|
+
2. **The model decides** the question needs Wikipedia
|
|
237
|
+
3. **The model calls** `search_wiki` with `{ "query": "Marie Curie" }`
|
|
238
|
+
4. **The skill returns** the article introductions
|
|
239
|
+
5. **The model answers** the caller, in Fred's voice
|
|
240
|
+
|
|
241
|
+
### Example Conversation Flow
|
|
242
|
+
|
|
243
|
+
This exchange is from a text chat with the finished Fred, shortened to two turns. On a phone call, the platform also says one of the fillers while the search runs.
|
|
244
|
+
|
|
245
|
+
```text
|
|
246
|
+
Caller: Hi there!
|
|
247
|
+
Fred: Hi there! I'm Fred, your friendly Wikipedia explorer. What fascinating fact or topic would you like to learn about today?
|
|
248
|
+
|
|
249
|
+
Caller: Who was Marie Curie, and what year did she win her second Nobel Prize?
|
|
250
|
+
[Fred calls search_wiki with {"query":"Marie Curie"}]
|
|
251
|
+
Fred: Marie Curie was a remarkable physicist and chemist who made groundbreaking discoveries in radioactivity. She won her second Nobel Prize in Chemistry in 1911, for the discovery of the elements radium and polonium, and for her studies on their nature and compounds. Would you like to learn more about her scientific achievements or her life story?
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
The answer comes from the article's introduction, which says she won the 1911 Nobel Prize in Chemistry.
|
|
255
|
+
|
|
256
|
+
## Skill Benefits
|
|
257
|
+
|
|
258
|
+
A skill saves you from writing and maintaining the integration yourself.
|
|
259
|
+
|
|
260
|
+
### Why Use Skills Instead of Custom Code?
|
|
261
|
+
|
|
262
|
+
With the skill, Wikipedia search is one call:
|
|
263
|
+
|
|
264
|
+
<!-- snippet: no-compile fragment: `fred` is the agent createFred builds -->
|
|
265
|
+
```typescript
|
|
266
|
+
await fred.addSkill(new WikipediaSearchSkill());
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
Without it, you'd write every part yourself:
|
|
270
|
+
|
|
271
|
+
```typescript
|
|
272
|
+
// You'd need to:
|
|
273
|
+
// 1. Choose a Wikipedia API
|
|
274
|
+
// 2. Make the API calls
|
|
275
|
+
// 3. Parse the responses
|
|
276
|
+
// 4. Format the results
|
|
277
|
+
// 5. Handle errors
|
|
278
|
+
// 6. Register a SWAIG function
|
|
279
|
+
// 7. Write its handler
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
### What Skills Provide
|
|
283
|
+
|
|
284
|
+
Using a skill gives you:
|
|
285
|
+
|
|
286
|
+
1. **Tested functionality**: built and tested with the SDK
|
|
287
|
+
2. **A consistent interface**: every skill is configured the same way
|
|
288
|
+
3. **Error handling**: failures return a message instead of crashing the call
|
|
289
|
+
4. **Documentation**: the [Skills System Guide](../../../docs/skills-guide.md) covers each built-in skill
|
|
290
|
+
5. **Maintenance**: fixes arrive with SDK updates
|
|
291
|
+
|
|
292
|
+
## Next Steps
|
|
293
|
+
|
|
294
|
+
Fred can search Wikipedia. Next, add a function of your own that shares facts about Wikipedia. Continue with [Lesson 5: Creating Custom Functions](05-custom-functions.md).
|
|
295
|
+
|
|
296
|
+
---
|
|
297
|
+
|
|
298
|
+
[Previous: Basic Agent](03-basic-agent.md) | [Overview](README.md) | [Next: Custom Functions](05-custom-functions.md)
|