@signalwire/sdk 2.0.5 → 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 +481 -126
- package/dist/AgentBase.js +1502 -438
- 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 +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 +158 -58
- package/dist/SWMLService.js +435 -127
- 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/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 +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 +916 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +47 -68
- package/dist/index.js +44 -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 +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 +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 +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 +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,642 @@
|
|
|
1
|
+
# Lesson 6: Running and Testing Fred
|
|
2
|
+
|
|
3
|
+
Fred is complete. This lesson runs it, tests its functions with `swaig-test` and `curl`, adds a script to manage it, and covers the problems you're most likely to hit.
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
1. [Running Fred](#running-fred)
|
|
8
|
+
2. [Understanding the Endpoints](#understanding-the-endpoints)
|
|
9
|
+
3. [Testing with swaig-test](#testing-with-swaig-test)
|
|
10
|
+
4. [Testing with curl](#testing-with-curl)
|
|
11
|
+
5. [Managing Fred with Scripts](#managing-fred-with-scripts)
|
|
12
|
+
6. [Troubleshooting](#troubleshooting)
|
|
13
|
+
7. [Production Considerations](#production-considerations)
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Running Fred
|
|
18
|
+
|
|
19
|
+
Running `fred.ts` starts a web server that SignalWire can call.
|
|
20
|
+
|
|
21
|
+
### Step 1: Run Fred Directly
|
|
22
|
+
|
|
23
|
+
Start Fred from the project directory:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npx tsx fred.ts
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
The output looks like this, with the second warning shortened. Your password will differ:
|
|
30
|
+
|
|
31
|
+
```text
|
|
32
|
+
2026-09-29T17:41:55.751Z [WARN] [AgentBase] [signalwire] webhook signature validation is disabled — set signingKey or SIGNALWIRE_SIGNING_KEY to enable
|
|
33
|
+
2026-09-29T17:41:55.752Z [WARN] [AgentBase] basic_auth_password_autogenerated: username="Fred". No SWML_BASIC_AUTH_PASSWORD found in environment ...
|
|
34
|
+
============================================================
|
|
35
|
+
Fred: a Wikipedia knowledge bot
|
|
36
|
+
============================================================
|
|
37
|
+
|
|
38
|
+
Fred searches Wikipedia and shares facts about Wikipedia itself.
|
|
39
|
+
|
|
40
|
+
Questions to try:
|
|
41
|
+
- Tell me about Albert Einstein
|
|
42
|
+
- What is quantum physics?
|
|
43
|
+
- Who was Marie Curie?
|
|
44
|
+
- Search for information about the solar system
|
|
45
|
+
- Can you share a fun fact?
|
|
46
|
+
|
|
47
|
+
Fred is available at: http://localhost:3000/fred
|
|
48
|
+
Basic Auth: Fred:5a37e6447524c6858a2395d234c2e910
|
|
49
|
+
|
|
50
|
+
Starting Fred. Press Ctrl+C to stop.
|
|
51
|
+
============================================================
|
|
52
|
+
2026-09-29T17:41:55.758Z [INFO] [AgentBase] Agent 'Fred' running at http://0.0.0.0:3000/fred
|
|
53
|
+
2026-09-29T17:41:55.758Z [INFO] [AgentBase] Auth: Fred:**** (source: generated)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Important Information
|
|
57
|
+
|
|
58
|
+
Note three details from the output:
|
|
59
|
+
|
|
60
|
+
- **URL**: `http://localhost:3000/fred`. The server listens on every network interface, `0.0.0.0`.
|
|
61
|
+
- **Credentials**: the username and password for basic authentication. Without `SWML_BASIC_AUTH_USER` and `SWML_BASIC_AUTH_PASSWORD` set, the SDK generates a new password each time Fred starts, and warns that it did. The SDK's own log line masks the password, so the banner is where you read it.
|
|
62
|
+
- **The signature warning**: webhook signature validation is off until you set `SIGNALWIRE_SIGNING_KEY`. That's fine on your own machine. [Production Considerations](#production-considerations) covers when to set it.
|
|
63
|
+
|
|
64
|
+
Press Ctrl+C to stop Fred.
|
|
65
|
+
|
|
66
|
+
## Understanding the Endpoints
|
|
67
|
+
|
|
68
|
+
Fred answers on three HTTP endpoints, all under its route.
|
|
69
|
+
|
|
70
|
+
### 1. SWML Endpoint (/fred)
|
|
71
|
+
|
|
72
|
+
Returns Fred's configuration as a SWML document:
|
|
73
|
+
|
|
74
|
+
- **Purpose**: tells SignalWire how Fred behaves
|
|
75
|
+
- **Method**: SignalWire requests it with a `POST`. You can fetch it with `GET` to inspect it.
|
|
76
|
+
- **Auth**: required
|
|
77
|
+
|
|
78
|
+
### 2. SWAIG Endpoint (POST /fred/swaig)
|
|
79
|
+
|
|
80
|
+
Runs Fred's functions:
|
|
81
|
+
|
|
82
|
+
- **Purpose**: executes a function the model called
|
|
83
|
+
- **Method**: `POST`
|
|
84
|
+
- **Auth**: required
|
|
85
|
+
- **Token**: required. Each function's URL in the SWML carries a token that's valid for one call.
|
|
86
|
+
- **Content-Type**: `application/json`
|
|
87
|
+
|
|
88
|
+
### 3. Health Endpoint (GET /fred/health)
|
|
89
|
+
|
|
90
|
+
Reports whether Fred is running. It needs no credentials, so load balancers and container health checks can use it.
|
|
91
|
+
|
|
92
|
+
## Testing with swaig-test
|
|
93
|
+
|
|
94
|
+
The SDK includes a command-line tool, `swaig-test`, that loads an agent from its file and runs its functions without starting a server. It loads `fred.ts` with Node.js's own TypeScript support, which is why Fred needs Node.js 22.18 or later.
|
|
95
|
+
|
|
96
|
+
### List Fred's Functions
|
|
97
|
+
|
|
98
|
+
List the functions Fred registers:
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
npx swaig-test fred.ts --list-tools
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
`swaig-test` imports `fred.ts` and finds the exported `fred`. The import doesn't run the banner or the server, so the function list is the whole output:
|
|
105
|
+
|
|
106
|
+
```text
|
|
107
|
+
Available SWAIG functions:
|
|
108
|
+
search_wiki - Search Wikipedia for information about a topic and get article summaries (LOCAL webhook)
|
|
109
|
+
Parameters:
|
|
110
|
+
query (string): The search term or topic to look up on Wikipedia.
|
|
111
|
+
share_fun_fact - Share an interesting fact about Wikipedia itself (LOCAL webhook)
|
|
112
|
+
Parameters:
|
|
113
|
+
category (string [options: statistics, history, records, random]): Type of fact to share
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Test Functions Without Running the Server
|
|
117
|
+
|
|
118
|
+
Run a function with `--exec`, followed by its arguments:
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
# Test Wikipedia search
|
|
122
|
+
npx swaig-test fred.ts --exec search_wiki --query "Python programming language"
|
|
123
|
+
|
|
124
|
+
# Test fun fact with category
|
|
125
|
+
npx swaig-test fred.ts --exec share_fun_fact --category history
|
|
126
|
+
|
|
127
|
+
# Test fun fact without parameters (uses default)
|
|
128
|
+
npx swaig-test fred.ts --exec share_fun_fact
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
The fun fact with a category prints one fact from it:
|
|
132
|
+
|
|
133
|
+
```text
|
|
134
|
+
RESULT:
|
|
135
|
+
Response: Here's a history fact about Wikipedia: Wikipedia was launched on January 15, 2001!
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
Everything after `--exec` and the function name is passed to the function as an argument. Put `swaig-test`'s own options, such as `--verbose` or `--call-id`, before `--exec`.
|
|
139
|
+
|
|
140
|
+
### Generate and Inspect SWML
|
|
141
|
+
|
|
142
|
+
`--dump-swml` prints the SWML document SignalWire would receive:
|
|
143
|
+
|
|
144
|
+
```bash
|
|
145
|
+
# Generate SWML document
|
|
146
|
+
npx swaig-test fred.ts --dump-swml
|
|
147
|
+
|
|
148
|
+
# Get raw JSON for processing
|
|
149
|
+
npx swaig-test fred.ts --dump-swml --raw | jq '.sections.main[] | select(.ai) | .ai.SWAIG.functions'
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
The `ai` verb isn't the first entry in `main`. An `answer` verb comes before it, so the `jq` filter selects the entry that has `ai`.
|
|
153
|
+
|
|
154
|
+
### Test Different Call Scenarios
|
|
155
|
+
|
|
156
|
+
Options that describe the call change the request `swaig-test` simulates:
|
|
157
|
+
|
|
158
|
+
```bash
|
|
159
|
+
# Simulate an inbound SIP call
|
|
160
|
+
npx swaig-test fred.ts --dump-swml --call-type sip --call-direction inbound
|
|
161
|
+
|
|
162
|
+
# Custom caller info
|
|
163
|
+
npx swaig-test fred.ts --dump-swml --from-number "+15551234567" --to-extension "+15559876543"
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### Test Serverless Deployment
|
|
167
|
+
|
|
168
|
+
`--simulate-serverless` renders the agent as it would run on a serverless platform:
|
|
169
|
+
|
|
170
|
+
```bash
|
|
171
|
+
# Test Lambda deployment
|
|
172
|
+
npx swaig-test fred.ts --simulate-serverless lambda --dump-swml
|
|
173
|
+
|
|
174
|
+
# Test with Lambda function execution
|
|
175
|
+
npx swaig-test fred.ts --simulate-serverless lambda --exec search_wiki --query "SignalWire"
|
|
176
|
+
|
|
177
|
+
# Test CGI deployment
|
|
178
|
+
npx swaig-test fred.ts --simulate-serverless cgi --cgi-host example.com --dump-swml
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
### Debug Mode
|
|
182
|
+
|
|
183
|
+
`--verbose` shows the SDK's logs while a function runs. Like every `swaig-test` option, it goes before `--exec`:
|
|
184
|
+
|
|
185
|
+
```bash
|
|
186
|
+
# See the SDK's logs during the call
|
|
187
|
+
npx swaig-test fred.ts --verbose --exec search_wiki --query "Albert Einstein"
|
|
188
|
+
|
|
189
|
+
# Run a function as part of a specific call
|
|
190
|
+
npx swaig-test fred.ts --call-id custom-123 --exec share_fun_fact
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
### Benefits of swaig-test
|
|
194
|
+
|
|
195
|
+
`swaig-test` is the fastest way to check an agent:
|
|
196
|
+
|
|
197
|
+
1. **No server required**: functions run without starting Fred
|
|
198
|
+
2. **Quick validation**: check a function before you deploy
|
|
199
|
+
3. **SWML inspection**: see exactly what SignalWire receives
|
|
200
|
+
4. **Serverless testing**: check Lambda and CGI configurations
|
|
201
|
+
5. **Debugging**: see the SDK's logs for one function call
|
|
202
|
+
|
|
203
|
+
For every option, see the [CLI guide](../../../docs/cli-guide.md).
|
|
204
|
+
|
|
205
|
+
## Testing with curl
|
|
206
|
+
|
|
207
|
+
With Fred running, you can also test it over HTTP. Replace `username:password` with the credentials from Fred's output. The commands use `jq` to read the JSON.
|
|
208
|
+
|
|
209
|
+
### Step 2: Fetch Fred's SWML Configuration
|
|
210
|
+
|
|
211
|
+
Fetch the SWML document, and format it:
|
|
212
|
+
|
|
213
|
+
```bash
|
|
214
|
+
# Get Fred's SWML document
|
|
215
|
+
curl -u username:password http://localhost:3000/fred | jq
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
The response is Fred's SWML document. This excerpt is shortened:
|
|
219
|
+
|
|
220
|
+
```json
|
|
221
|
+
{
|
|
222
|
+
"version": "1.0.0",
|
|
223
|
+
"sections": {
|
|
224
|
+
"main": [
|
|
225
|
+
{
|
|
226
|
+
"answer": {}
|
|
227
|
+
},
|
|
228
|
+
{
|
|
229
|
+
"ai": {
|
|
230
|
+
"prompt": {
|
|
231
|
+
"pom": [
|
|
232
|
+
{
|
|
233
|
+
"body": "You are Fred, a friendly and knowledgeable assistant...",
|
|
234
|
+
"title": "Personality"
|
|
235
|
+
}
|
|
236
|
+
]
|
|
237
|
+
},
|
|
238
|
+
"SWAIG": {
|
|
239
|
+
"functions": [
|
|
240
|
+
{
|
|
241
|
+
"function": "search_wiki",
|
|
242
|
+
"description": "Search Wikipedia for information about a topic and get article summaries"
|
|
243
|
+
},
|
|
244
|
+
{
|
|
245
|
+
"function": "share_fun_fact",
|
|
246
|
+
"description": "Share an interesting fact about Wikipedia itself"
|
|
247
|
+
}
|
|
248
|
+
]
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
]
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
### Step 3: Test Wikipedia Search
|
|
258
|
+
|
|
259
|
+
SignalWire calls a function at the URL Fred's SWML gives it, and that URL carries a security token that's valid for one call only. A test does the same. It fetches the SWML for a test call, takes the function's URL from it, and posts to that URL with the same call ID.
|
|
260
|
+
|
|
261
|
+
```bash
|
|
262
|
+
# Fetch the SWML for a test call, and take search_wiki's URL from it
|
|
263
|
+
URL=$(curl -s -u username:password "http://localhost:3000/fred?call_id=test-call-123" \
|
|
264
|
+
| jq -r '.sections.main[] | select(.ai) | .ai.SWAIG.functions[] | select(.function == "search_wiki") | .web_hook_url')
|
|
265
|
+
|
|
266
|
+
# Call search_wiki the way SignalWire does, with the same call ID
|
|
267
|
+
curl -X POST -H "Content-Type: application/json" \
|
|
268
|
+
-d '{
|
|
269
|
+
"function": "search_wiki",
|
|
270
|
+
"argument": {
|
|
271
|
+
"parsed": [
|
|
272
|
+
{
|
|
273
|
+
"query": "FreeSWITCH"
|
|
274
|
+
}
|
|
275
|
+
]
|
|
276
|
+
},
|
|
277
|
+
"call_id": "test-call-123"
|
|
278
|
+
}' \
|
|
279
|
+
"$URL"
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
The URL already includes Fred's credentials, so the second `curl` doesn't need `-u`.
|
|
283
|
+
|
|
284
|
+
The response holds up to two article introductions, separated by a line of `=` characters. This one is shortened:
|
|
285
|
+
|
|
286
|
+
```json
|
|
287
|
+
{"response":"**FreeSWITCH**\n\nFreeSWITCH is a free and open-source telephony software for real-time communication protocols using audio, video, text and other forms of media...\n\n==================================================\n\n**Siren (codec)**\n\n..."}
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
### Step 4: Test Fun Fact Function
|
|
291
|
+
|
|
292
|
+
Each function has its own token, so take `share_fun_fact`'s URL the same way:
|
|
293
|
+
|
|
294
|
+
```bash
|
|
295
|
+
# Fetch the SWML for a test call, and take share_fun_fact's URL from it
|
|
296
|
+
URL=$(curl -s -u username:password "http://localhost:3000/fred?call_id=test-call-456" \
|
|
297
|
+
| jq -r '.sections.main[] | select(.ai) | .ai.SWAIG.functions[] | select(.function == "share_fun_fact") | .web_hook_url')
|
|
298
|
+
|
|
299
|
+
# Get a history fact
|
|
300
|
+
curl -X POST -H "Content-Type: application/json" \
|
|
301
|
+
-d '{
|
|
302
|
+
"function": "share_fun_fact",
|
|
303
|
+
"argument": {
|
|
304
|
+
"parsed": [
|
|
305
|
+
{
|
|
306
|
+
"category": "history"
|
|
307
|
+
}
|
|
308
|
+
]
|
|
309
|
+
},
|
|
310
|
+
"call_id": "test-call-456"
|
|
311
|
+
}' \
|
|
312
|
+
"$URL"
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
The response is one fact from the category:
|
|
316
|
+
|
|
317
|
+
```json
|
|
318
|
+
{"response":"Here's a history fact about Wikipedia: Wikipedia's name comes from 'wiki' (Hawaiian for 'quick') and 'encyclopedia'!"}
|
|
319
|
+
```
|
|
320
|
+
|
|
321
|
+
## Managing Fred with Scripts
|
|
322
|
+
|
|
323
|
+
A small shell script can start Fred in the background, stop it, and report its status.
|
|
324
|
+
|
|
325
|
+
### Step 5: Create Management Script
|
|
326
|
+
|
|
327
|
+
Create `fred.sh` with this minimal version. [Appendix A](appendix-complete-code.md#management-script-fredsh) has the complete script, which adds a `logs` command and waits for Fred to stop.
|
|
328
|
+
|
|
329
|
+
The script runs Fred with `node --import tsx fred.ts`. That loads the same TypeScript support `npx tsx` uses, in a single process, so the process ID the script saves is Fred's. `npx tsx` runs Fred in a child process of its own, and stopping the process the script started would leave Fred running.
|
|
330
|
+
|
|
331
|
+
```bash
|
|
332
|
+
#!/bin/bash
|
|
333
|
+
# Start, stop and check Fred
|
|
334
|
+
|
|
335
|
+
PID_FILE="fred.pid"
|
|
336
|
+
LOG_FILE="fred.log"
|
|
337
|
+
|
|
338
|
+
# Colors for output
|
|
339
|
+
GREEN='\033[0;32m'
|
|
340
|
+
RED='\033[0;31m'
|
|
341
|
+
YELLOW='\033[1;33m'
|
|
342
|
+
NC='\033[0m' # No Color
|
|
343
|
+
|
|
344
|
+
# Function to check if Fred is running
|
|
345
|
+
is_running() {
|
|
346
|
+
if [ -f "$PID_FILE" ]; then
|
|
347
|
+
PID=$(cat "$PID_FILE")
|
|
348
|
+
if ps -p "$PID" > /dev/null 2>&1; then
|
|
349
|
+
return 0
|
|
350
|
+
fi
|
|
351
|
+
fi
|
|
352
|
+
return 1
|
|
353
|
+
}
|
|
354
|
+
|
|
355
|
+
# Start Fred
|
|
356
|
+
start_fred() {
|
|
357
|
+
if is_running; then
|
|
358
|
+
echo -e "${YELLOW}Fred is already running${NC}"
|
|
359
|
+
return 1
|
|
360
|
+
fi
|
|
361
|
+
|
|
362
|
+
echo -e "${GREEN}Starting Fred...${NC}"
|
|
363
|
+
nohup node --import tsx fred.ts > "$LOG_FILE" 2>&1 &
|
|
364
|
+
PID=$!
|
|
365
|
+
echo $PID > "$PID_FILE"
|
|
366
|
+
|
|
367
|
+
sleep 2
|
|
368
|
+
|
|
369
|
+
if is_running; then
|
|
370
|
+
echo -e "${GREEN}Fred started${NC}"
|
|
371
|
+
echo " PID: $PID"
|
|
372
|
+
echo " Logs: $LOG_FILE"
|
|
373
|
+
|
|
374
|
+
# Extract auth from log
|
|
375
|
+
AUTH=$(grep "Basic Auth:" "$LOG_FILE" | head -1)
|
|
376
|
+
if [ ! -z "$AUTH" ]; then
|
|
377
|
+
echo " $AUTH"
|
|
378
|
+
fi
|
|
379
|
+
else
|
|
380
|
+
echo -e "${RED}Fred failed to start${NC}"
|
|
381
|
+
return 1
|
|
382
|
+
fi
|
|
383
|
+
}
|
|
384
|
+
|
|
385
|
+
# Stop Fred
|
|
386
|
+
stop_fred() {
|
|
387
|
+
if ! is_running; then
|
|
388
|
+
echo -e "${YELLOW}Fred is not running${NC}"
|
|
389
|
+
return 1
|
|
390
|
+
fi
|
|
391
|
+
|
|
392
|
+
PID=$(cat "$PID_FILE")
|
|
393
|
+
echo -e "${GREEN}Stopping Fred...${NC}"
|
|
394
|
+
kill $PID
|
|
395
|
+
rm -f "$PID_FILE"
|
|
396
|
+
echo -e "${GREEN}Fred stopped${NC}"
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
# Main script
|
|
400
|
+
case "$1" in
|
|
401
|
+
start)
|
|
402
|
+
start_fred
|
|
403
|
+
;;
|
|
404
|
+
stop)
|
|
405
|
+
stop_fred
|
|
406
|
+
;;
|
|
407
|
+
restart)
|
|
408
|
+
stop_fred
|
|
409
|
+
sleep 1
|
|
410
|
+
start_fred
|
|
411
|
+
;;
|
|
412
|
+
status)
|
|
413
|
+
if is_running; then
|
|
414
|
+
echo -e "${GREEN}Fred is running${NC}"
|
|
415
|
+
PID=$(cat "$PID_FILE")
|
|
416
|
+
echo " PID: $PID"
|
|
417
|
+
else
|
|
418
|
+
echo -e "${RED}Fred is not running${NC}"
|
|
419
|
+
fi
|
|
420
|
+
;;
|
|
421
|
+
*)
|
|
422
|
+
echo "Usage: $0 {start|stop|restart|status}"
|
|
423
|
+
exit 1
|
|
424
|
+
;;
|
|
425
|
+
esac
|
|
426
|
+
```
|
|
427
|
+
|
|
428
|
+
Make it executable:
|
|
429
|
+
|
|
430
|
+
```bash
|
|
431
|
+
chmod +x fred.sh
|
|
432
|
+
```
|
|
433
|
+
|
|
434
|
+
### Using the Management Script
|
|
435
|
+
|
|
436
|
+
The script's commands start, check and stop Fred:
|
|
437
|
+
|
|
438
|
+
```bash
|
|
439
|
+
# Start Fred in background
|
|
440
|
+
./fred.sh start
|
|
441
|
+
|
|
442
|
+
# Check status
|
|
443
|
+
./fred.sh status
|
|
444
|
+
|
|
445
|
+
# View logs
|
|
446
|
+
tail -f fred.log
|
|
447
|
+
|
|
448
|
+
# Stop Fred
|
|
449
|
+
./fred.sh stop
|
|
450
|
+
```
|
|
451
|
+
|
|
452
|
+
## Troubleshooting
|
|
453
|
+
|
|
454
|
+
Most problems when running Fred fall into a few groups.
|
|
455
|
+
|
|
456
|
+
### Common Issues and Solutions
|
|
457
|
+
|
|
458
|
+
#### Port Already in Use
|
|
459
|
+
|
|
460
|
+
Another program is using port 3000. Node.js stops with `EADDRINUSE`:
|
|
461
|
+
|
|
462
|
+
```text
|
|
463
|
+
Error: listen EADDRINUSE: address already in use 0.0.0.0:3000
|
|
464
|
+
```
|
|
465
|
+
|
|
466
|
+
Find the program that holds the port, and stop it:
|
|
467
|
+
|
|
468
|
+
```bash
|
|
469
|
+
# Find process using port 3000
|
|
470
|
+
lsof -i :3000
|
|
471
|
+
```
|
|
472
|
+
|
|
473
|
+
Or run Fred on another port:
|
|
474
|
+
|
|
475
|
+
```bash
|
|
476
|
+
PORT=3001 npx tsx fred.ts
|
|
477
|
+
```
|
|
478
|
+
|
|
479
|
+
#### Authentication Failed
|
|
480
|
+
|
|
481
|
+
A request with missing or wrong credentials gets `401` and this body:
|
|
482
|
+
|
|
483
|
+
```json
|
|
484
|
+
{"error":"Unauthorized"}
|
|
485
|
+
```
|
|
486
|
+
|
|
487
|
+
To fix it, check three things:
|
|
488
|
+
|
|
489
|
+
- The username and password match the ones in Fred's output
|
|
490
|
+
- The credentials are current. A generated password changes each time Fred restarts.
|
|
491
|
+
- The `curl` command includes `-u username:password`
|
|
492
|
+
|
|
493
|
+
#### Cannot Find the Package
|
|
494
|
+
|
|
495
|
+
Node.js can't find the SDK when it isn't installed in the project that runs Fred:
|
|
496
|
+
|
|
497
|
+
```text
|
|
498
|
+
Cannot find package '@signalwire/sdk' imported from /home/you/fred-bot/fred.ts
|
|
499
|
+
```
|
|
500
|
+
|
|
501
|
+
Install the dependencies from the project directory, and run Fred from there:
|
|
502
|
+
|
|
503
|
+
```bash
|
|
504
|
+
npm install
|
|
505
|
+
```
|
|
506
|
+
|
|
507
|
+
#### Invalid or Expired Token
|
|
508
|
+
|
|
509
|
+
A function call through `/fred/swaig` can answer "the security token for this function is invalid or expired". The request either lacks the token from Fred's SWML, or carries a token from another call. [Step 3](#step-3-test-wikipedia-search) shows how to call a function with its token.
|
|
510
|
+
|
|
511
|
+
#### No Response from Functions
|
|
512
|
+
|
|
513
|
+
If a function call returns nothing useful, check three things:
|
|
514
|
+
|
|
515
|
+
1. The function name matches exactly (`search_wiki`, not `search_wikipedia`)
|
|
516
|
+
2. The JSON has the right structure, including the `parsed` array
|
|
517
|
+
3. The `Content-Type: application/json` header is set
|
|
518
|
+
|
|
519
|
+
### Debug Tips
|
|
520
|
+
|
|
521
|
+
These checks narrow down most problems.
|
|
522
|
+
|
|
523
|
+
#### Enable Debug Logging
|
|
524
|
+
|
|
525
|
+
`SIGNALWIRE_LOG_LEVEL` sets how much the SDK logs. Run Fred with debug logging:
|
|
526
|
+
|
|
527
|
+
```bash
|
|
528
|
+
SIGNALWIRE_LOG_LEVEL=debug npx tsx fred.ts
|
|
529
|
+
```
|
|
530
|
+
|
|
531
|
+
#### Test a Function Without the Server
|
|
532
|
+
|
|
533
|
+
`swaig-test` runs a function without a server, credentials or a token:
|
|
534
|
+
|
|
535
|
+
```bash
|
|
536
|
+
# Simplest possible function call: no server, no credentials, no token
|
|
537
|
+
npx swaig-test fred.ts --exec share_fun_fact
|
|
538
|
+
```
|
|
539
|
+
|
|
540
|
+
If this works but a call over HTTP doesn't, the problem is in the request, not in Fred's code.
|
|
541
|
+
|
|
542
|
+
#### Check Fred's Health
|
|
543
|
+
|
|
544
|
+
The health endpoint needs no credentials:
|
|
545
|
+
|
|
546
|
+
```bash
|
|
547
|
+
curl http://localhost:3000/fred/health
|
|
548
|
+
```
|
|
549
|
+
|
|
550
|
+
A running Fred answers:
|
|
551
|
+
|
|
552
|
+
```json
|
|
553
|
+
{"status":"ok"}
|
|
554
|
+
```
|
|
555
|
+
|
|
556
|
+
## Production Considerations
|
|
557
|
+
|
|
558
|
+
Running Fred for real callers needs fixed secrets, HTTPS, and a process manager.
|
|
559
|
+
|
|
560
|
+
### Security
|
|
561
|
+
|
|
562
|
+
Set these environment variables before Fred takes real calls:
|
|
563
|
+
|
|
564
|
+
1. **Fixed credentials**, so they don't change on restart:
|
|
565
|
+
|
|
566
|
+
```bash
|
|
567
|
+
export SWML_BASIC_AUTH_USER="fred"
|
|
568
|
+
export SWML_BASIC_AUTH_PASSWORD="a-long-random-password"
|
|
569
|
+
```
|
|
570
|
+
|
|
571
|
+
2. **Your project's signing key**, from the SignalWire dashboard. With it set, the SDK rejects requests that SignalWire didn't sign.
|
|
572
|
+
|
|
573
|
+
```bash
|
|
574
|
+
export SIGNALWIRE_SIGNING_KEY="your-signing-key"
|
|
575
|
+
```
|
|
576
|
+
|
|
577
|
+
3. **A fixed secret for tool tokens.** Without one, the SDK generates a new secret each time Fred starts. Calls in progress during a restart then lose their tokens. Every copy of Fred must use the same secret.
|
|
578
|
+
|
|
579
|
+
```bash
|
|
580
|
+
export SIGNALWIRE_SWAIG_SECRET="another-long-random-string"
|
|
581
|
+
```
|
|
582
|
+
|
|
583
|
+
Serve Fred over HTTPS, either behind a reverse proxy such as nginx, or with the SDK's own TLS support (`SWML_SSL_ENABLED`, `SWML_SSL_CERT_PATH` and `SWML_SSL_KEY_PATH`).
|
|
584
|
+
|
|
585
|
+
Fred's banner prints the password. With fixed credentials in production, keep the log where only operators can read it, or remove the `Basic Auth` line from the banner.
|
|
586
|
+
|
|
587
|
+
### Deployment Options
|
|
588
|
+
|
|
589
|
+
Three common ways to keep Fred running:
|
|
590
|
+
|
|
591
|
+
1. **Direct**, choosing the port with `PORT`:
|
|
592
|
+
|
|
593
|
+
```bash
|
|
594
|
+
PORT=8080 npx tsx fred.ts
|
|
595
|
+
```
|
|
596
|
+
|
|
597
|
+
2. **Docker**: [Appendix B](appendix-docker-deployment.md) has two Dockerfiles and a Compose file.
|
|
598
|
+
|
|
599
|
+
3. **systemd**: [Appendix A](appendix-complete-code.md) has a service file.
|
|
600
|
+
|
|
601
|
+
## Summary
|
|
602
|
+
|
|
603
|
+
In this tutorial you:
|
|
604
|
+
|
|
605
|
+
- Built Fred from scratch
|
|
606
|
+
- Ran Fred locally
|
|
607
|
+
- Tested Wikipedia search and fun facts with `swaig-test` and `curl`
|
|
608
|
+
- Created a management script
|
|
609
|
+
- Learned how to troubleshoot common problems
|
|
610
|
+
|
|
611
|
+
## Next Steps
|
|
612
|
+
|
|
613
|
+
To take real phone calls with Fred:
|
|
614
|
+
|
|
615
|
+
1. Sign up for a SignalWire account
|
|
616
|
+
2. Make Fred reachable at a public HTTPS address, with a deployment or a tunnel such as ngrok
|
|
617
|
+
3. Set `SWML_PROXY_URL_BASE` to that address
|
|
618
|
+
4. Buy or configure a phone number, and point it at `https://username:password@your-address/fred`
|
|
619
|
+
|
|
620
|
+
The appendices have the complete code and deployment files. Continue with [Appendix A: Complete Code and Management Script](appendix-complete-code.md).
|
|
621
|
+
|
|
622
|
+
---
|
|
623
|
+
|
|
624
|
+
The commands from this lesson, for quick reference:
|
|
625
|
+
|
|
626
|
+
```bash
|
|
627
|
+
# Start Fred
|
|
628
|
+
npx tsx fred.ts
|
|
629
|
+
|
|
630
|
+
# Test SWML
|
|
631
|
+
curl -u user:pass http://localhost:3000/fred
|
|
632
|
+
|
|
633
|
+
# Test Wikipedia search
|
|
634
|
+
npx swaig-test fred.ts --exec search_wiki --query "Python"
|
|
635
|
+
|
|
636
|
+
# Test fun fact
|
|
637
|
+
npx swaig-test fred.ts --exec share_fun_fact
|
|
638
|
+
```
|
|
639
|
+
|
|
640
|
+
---
|
|
641
|
+
|
|
642
|
+
[Previous: Custom Functions](05-custom-functions.md) | [Overview](README.md) | [Next: Complete Code](appendix-complete-code.md)
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Fred Bot Tutorial: Building a Wikipedia AI Assistant
|
|
2
|
+
|
|
3
|
+
This tutorial builds Fred, a voice agent that answers questions from Wikipedia, using the SignalWire TypeScript SDK. Each lesson adds one part of the agent, and by the end you run Fred locally and test it from the command line.
|
|
4
|
+
|
|
5
|
+
## What You'll Build
|
|
6
|
+
|
|
7
|
+
Fred is an AI voice agent with a friendly persona. It can:
|
|
8
|
+
|
|
9
|
+
- Search Wikipedia for information on a topic
|
|
10
|
+
- Share facts about Wikipedia itself
|
|
11
|
+
- Hold a conversation about what it finds
|
|
12
|
+
- Answer voice calls through the SignalWire platform
|
|
13
|
+
|
|
14
|
+
## Lessons
|
|
15
|
+
|
|
16
|
+
Each lesson builds on the one before it, so work through them in order:
|
|
17
|
+
|
|
18
|
+
1. [Introduction to SignalWire Agents](01-introduction.md): the SDK's core concepts and how an agent handles a call
|
|
19
|
+
2. [Setting Up Your Environment](02-setup.md): create a Node.js project, install the SDK and check that it works
|
|
20
|
+
3. [Creating Fred's Basic Structure](03-basic-agent.md): the agent class, its prompt, and its voice
|
|
21
|
+
4. [Adding the Wikipedia Search Skill](04-wikipedia-skill.md): add Wikipedia search with the skills system
|
|
22
|
+
5. [Creating Custom Functions](05-custom-functions.md): write a SWAIG function that shares facts about Wikipedia
|
|
23
|
+
6. [Running and Testing Fred](06-running-testing.md): run Fred, and test it with `swaig-test` and `curl`
|
|
24
|
+
|
|
25
|
+
The appendices are for reference:
|
|
26
|
+
|
|
27
|
+
- [Appendix A: Complete Code and Management Script](appendix-complete-code.md): `fred.ts`, `fred.sh`, the project files and a quick start
|
|
28
|
+
- [Appendix B: Docker Deployment](appendix-docker-deployment.md): run Fred in a container
|
|
29
|
+
|
|
30
|
+
## Prerequisites
|
|
31
|
+
|
|
32
|
+
You need:
|
|
33
|
+
|
|
34
|
+
- Node.js 22.18 or later, with npm
|
|
35
|
+
- Basic TypeScript knowledge
|
|
36
|
+
- Familiarity with the command line
|
|
37
|
+
|
|
38
|
+
Knowing how REST APIs or telephony applications work helps, but isn't required.
|
|
39
|
+
|
|
40
|
+
The tutorial takes 45 to 60 minutes in total, 5 to 10 minutes per lesson.
|
|
41
|
+
|
|
42
|
+
## Getting Help
|
|
43
|
+
|
|
44
|
+
These resources cover the SDK and the platform:
|
|
45
|
+
|
|
46
|
+
- **SignalWire documentation:** [signalwire.com/docs](https://signalwire.com/docs)
|
|
47
|
+
- **SDK documentation:** the [docs](../../../docs/) folder in this repository, which also ships in the npm package and prints with `npx sw-tsdocs`
|
|
48
|
+
- **GitHub Issues:** [github.com/signalwire/signalwire-typescript](https://github.com/signalwire/signalwire-typescript)
|
|
49
|
+
|
|
50
|
+
When you've built Fred, the [Full-Guardrails Agent tutorial](../../full-guardrails-agent/tutorial/README.md) goes further: an agent whose actions have consequences, kept correct by code instead of by the prompt.
|
|
51
|
+
|
|
52
|
+
Start with [Lesson 1: Introduction to SignalWire Agents](01-introduction.md).
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
*This tutorial was written for `@signalwire/sdk` 3.5.0.*
|