@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,404 @@
|
|
|
1
|
+
# Lesson 2: Adding Intelligence with Knowledge Bases
|
|
2
|
+
|
|
3
|
+
This lesson gives Morgan, the sales agent from Lesson 1, a search tool over a Markdown knowledge base. With it, Morgan can look up builds, prices and compatibility rules instead of relying only on the prompt.
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
1. [How the search works](#how-the-search-works)
|
|
8
|
+
2. [Creating knowledge bases](#creating-knowledge-bases)
|
|
9
|
+
3. [Loading the knowledge base](#loading-the-knowledge-base)
|
|
10
|
+
4. [Adding search to your agent](#adding-search-to-your-agent)
|
|
11
|
+
5. [Testing knowledge queries](#testing-knowledge-queries)
|
|
12
|
+
6. [Using a vector index](#using-a-vector-index)
|
|
13
|
+
7. [Best practices](#best-practices)
|
|
14
|
+
8. [Summary](#summary)
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## How the search works
|
|
19
|
+
|
|
20
|
+
The `native_vector_search` skill adds a search tool to an agent. In the TypeScript SDK it searches in one of two modes:
|
|
21
|
+
|
|
22
|
+
- **In memory**: you pass the documents in the skill's `documents` option. The skill indexes them when the agent starts, and ranks them by keyword relevance (TF-IDF blended with keyword overlap). It needs no other package or service.
|
|
23
|
+
- **Remote**: you pass a `remote_url`, and the skill sends each query to a search server that serves a vector index. The server does the ranking.
|
|
24
|
+
|
|
25
|
+
This lesson uses the in-memory mode, so it runs with nothing but the SDK. The mode has limits you should know about:
|
|
26
|
+
|
|
27
|
+
- It matches words, not meanings. A query that shares no words with a section can't find it, even when the section answers it.
|
|
28
|
+
- Common words such as "the" and "for" are ignored, and so is punctuation. `$1500` matches the `1500` in "Mid-Range Gaming Build ($1500-$2000)".
|
|
29
|
+
- A document scores higher when the query's words make up more of it. A short section that names a part can outrank the section about that part.
|
|
30
|
+
- The index lives in the agent's memory, and the agent rebuilds it at every start. That suits a knowledge base of a few hundred sections, not a document library.
|
|
31
|
+
|
|
32
|
+
[Using a vector index](#using-a-vector-index) covers the remote mode, for when you need matching by meaning or a larger corpus.
|
|
33
|
+
|
|
34
|
+
## Creating knowledge bases
|
|
35
|
+
|
|
36
|
+
A knowledge base is a Markdown file. This tutorial has two, `sales_knowledge.md` and `support_knowledge.md`.
|
|
37
|
+
|
|
38
|
+
### The structure of sales_knowledge.md
|
|
39
|
+
|
|
40
|
+
The sales knowledge base groups its sections under a consistent heading structure. This excerpt shows the first two sections:
|
|
41
|
+
|
|
42
|
+
```markdown
|
|
43
|
+
# PC Builder Pro Sales Knowledge Base
|
|
44
|
+
|
|
45
|
+
## Gaming PC Builds
|
|
46
|
+
|
|
47
|
+
### Budget Gaming Build ($800-$1000)
|
|
48
|
+
- **CPU**: AMD Ryzen 5 5600X or Intel Core i5-12400F
|
|
49
|
+
- **GPU**: NVIDIA RTX 4060 or AMD RX 7600
|
|
50
|
+
- **RAM**: 16GB DDR4 3200MHz (2x8GB)
|
|
51
|
+
- **Storage**: 500GB NVMe SSD
|
|
52
|
+
|
|
53
|
+
### Mid-Range Gaming Build ($1500-$2000)
|
|
54
|
+
- **CPU**: AMD Ryzen 7 7700X or Intel Core i5-13600K
|
|
55
|
+
- **GPU**: NVIDIA RTX 4070 or AMD RX 7800 XT
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
These habits make a knowledge base easier to search:
|
|
59
|
+
|
|
60
|
+
1. **Use clear headings**: each `###` section becomes one search result, so give each one topic.
|
|
61
|
+
2. **Be specific**: include model numbers, prices and specifications, the words callers say.
|
|
62
|
+
3. **Structure consistently**: similar sections should follow similar patterns.
|
|
63
|
+
4. **Update regularly**: the agent reads the file at startup, so restart it after an edit.
|
|
64
|
+
|
|
65
|
+
## Loading the knowledge base
|
|
66
|
+
|
|
67
|
+
The skill indexes whatever documents you give it, and each document comes back whole as one result. A whole file as one document would return the entire file for every query, so split it into sections first.
|
|
68
|
+
|
|
69
|
+
### Step 1: Split the file into sections
|
|
70
|
+
|
|
71
|
+
Create `tutorial/multi_agents/knowledge.ts` with a function that reads a Markdown file and returns one document per `###` section:
|
|
72
|
+
|
|
73
|
+
<!-- snippet: no-compile a region of tutorial/multi_agents/knowledge.ts; the file itself is type-checked --> <!-- include: tutorial/multi_agents/knowledge.ts#loader -->
|
|
74
|
+
```typescript
|
|
75
|
+
import { readFileSync } from 'node:fs';
|
|
76
|
+
import { basename } from 'node:path';
|
|
77
|
+
|
|
78
|
+
/** One searchable section of a knowledge base file. */
|
|
79
|
+
export interface KnowledgeDocument {
|
|
80
|
+
id: string;
|
|
81
|
+
text: string;
|
|
82
|
+
metadata: { filename: string; section: string };
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* Read a Markdown file and return one document per `###` section. Each
|
|
87
|
+
* document starts with its `##` and `###` headings, so a result read on its
|
|
88
|
+
* own still says what it's about. A heading with no text under it adds no document.
|
|
89
|
+
*/
|
|
90
|
+
export function loadKnowledge(path: string): KnowledgeDocument[] {
|
|
91
|
+
const filename = basename(path);
|
|
92
|
+
const docs: KnowledgeDocument[] = [];
|
|
93
|
+
let chapter = '';
|
|
94
|
+
let heading = '';
|
|
95
|
+
let body: string[] = [];
|
|
96
|
+
|
|
97
|
+
const flush = (): void => {
|
|
98
|
+
const text = body.join('\n').trim();
|
|
99
|
+
const section = heading && chapter ? `${chapter} > ${heading}` : heading || chapter;
|
|
100
|
+
if (section && text) {
|
|
101
|
+
docs.push({
|
|
102
|
+
id: `${filename}#${docs.length + 1}`,
|
|
103
|
+
text: `${section}\n${text}`,
|
|
104
|
+
metadata: { filename, section },
|
|
105
|
+
});
|
|
106
|
+
}
|
|
107
|
+
body = [];
|
|
108
|
+
};
|
|
109
|
+
|
|
110
|
+
for (const line of readFileSync(path, 'utf8').split('\n')) {
|
|
111
|
+
const match = /^(#{1,3})\s+(.*)$/.exec(line);
|
|
112
|
+
if (!match) {
|
|
113
|
+
body.push(line);
|
|
114
|
+
continue;
|
|
115
|
+
}
|
|
116
|
+
flush();
|
|
117
|
+
const [, hashes, title] = match;
|
|
118
|
+
if (hashes !== '###') chapter = hashes === '##' ? title!.trim() : '';
|
|
119
|
+
heading = hashes === '###' ? title!.trim() : '';
|
|
120
|
+
}
|
|
121
|
+
flush();
|
|
122
|
+
return docs;
|
|
123
|
+
}
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
The documents have the shape the skill expects: an `id`, the `text` to search, and `metadata`. The skill shows `metadata.filename` and `metadata.section` in each result. `sales_knowledge.md` becomes 18 documents, and `support_knowledge.md` becomes 19.
|
|
127
|
+
|
|
128
|
+
## Adding search to your agent
|
|
129
|
+
|
|
130
|
+
`sales_agent_with_search.ts` starts from Lesson 1's agent. It has a new name, and the changes in this section.
|
|
131
|
+
|
|
132
|
+
### Step 2: Create the agent
|
|
133
|
+
|
|
134
|
+
Create the agent, and import the search skill and the loader with it:
|
|
135
|
+
|
|
136
|
+
<!-- snippet: no-compile a region of tutorial/multi_agents/sales_agent_with_search.ts; the file itself is type-checked --> <!-- include: tutorial/multi_agents/sales_agent_with_search.ts#construct -->
|
|
137
|
+
```typescript
|
|
138
|
+
import { fileURLToPath, pathToFileURL } from 'node:url';
|
|
139
|
+
import { AgentBase, NativeVectorSearchSkill } from '@signalwire/sdk';
|
|
140
|
+
import { loadKnowledge } from './knowledge.js';
|
|
141
|
+
|
|
142
|
+
export const agent = new AgentBase({
|
|
143
|
+
name: 'PC Builder Sales Agent - Morgan (Enhanced)',
|
|
144
|
+
route: '/',
|
|
145
|
+
host: '0.0.0.0',
|
|
146
|
+
});
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
The `AI Role`, `Your Expertise` and `Voice Instructions` sections, and the voice, are the same as in Lesson 1.
|
|
150
|
+
|
|
151
|
+
### Step 3: Update the workflow
|
|
152
|
+
|
|
153
|
+
Replace the `Your Tasks` section with one that tells Morgan to search:
|
|
154
|
+
|
|
155
|
+
<!-- snippet: no-compile a region of tutorial/multi_agents/sales_agent_with_search.ts; the file itself is type-checked --> <!-- include: tutorial/multi_agents/sales_agent_with_search.ts#tasks -->
|
|
156
|
+
```typescript
|
|
157
|
+
// Define the sales workflow with search integration
|
|
158
|
+
agent.promptAddSection('Your Tasks', {
|
|
159
|
+
body: 'Complete sales process workflow with passion and expertise:',
|
|
160
|
+
bullets: [
|
|
161
|
+
'Greet customers warmly and introduce yourself',
|
|
162
|
+
'Understand their specific PC building requirements',
|
|
163
|
+
'Ask about budget, intended use, and preferences',
|
|
164
|
+
'Use search_sales_knowledge to find relevant product information',
|
|
165
|
+
'Provide knowledgeable recommendations based on search results',
|
|
166
|
+
'Share your enthusiasm for PC building',
|
|
167
|
+
'Offer to explain technical details when helpful',
|
|
168
|
+
],
|
|
169
|
+
});
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### Step 4: Say when to use the tool
|
|
173
|
+
|
|
174
|
+
Add two sections that tell Morgan when to search, and how to use what it finds:
|
|
175
|
+
|
|
176
|
+
<!-- snippet: no-compile a region of tutorial/multi_agents/sales_agent_with_search.ts; the file itself is type-checked --> <!-- include: tutorial/multi_agents/sales_agent_with_search.ts#tools-section -->
|
|
177
|
+
```typescript
|
|
178
|
+
// Tool usage instructions
|
|
179
|
+
agent.promptAddSection('Tools Available', {
|
|
180
|
+
body: 'Use these tools to assist customers:',
|
|
181
|
+
bullets: [
|
|
182
|
+
'search_sales_knowledge: Find current product information and build recommendations',
|
|
183
|
+
'Search when customers ask about specific budgets or use cases',
|
|
184
|
+
'Use search results to provide accurate, up-to-date information',
|
|
185
|
+
],
|
|
186
|
+
});
|
|
187
|
+
|
|
188
|
+
// Important guidelines
|
|
189
|
+
agent.promptAddSection('Important', {
|
|
190
|
+
body: 'Key guidelines for using knowledge search:',
|
|
191
|
+
bullets: [
|
|
192
|
+
'Always search when customers mention specific budgets',
|
|
193
|
+
'Search for compatibility information when needed',
|
|
194
|
+
'Use search results to support your recommendations',
|
|
195
|
+
"Acknowledge when searching: 'Let me find the perfect options for you'",
|
|
196
|
+
],
|
|
197
|
+
});
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
### Step 5: Add the search skill
|
|
201
|
+
|
|
202
|
+
Load the knowledge base and add the skill, after the language:
|
|
203
|
+
|
|
204
|
+
<!-- snippet: no-compile a region of tutorial/multi_agents/sales_agent_with_search.ts; the file itself is type-checked --> <!-- include: tutorial/multi_agents/sales_agent_with_search.ts#search-skill -->
|
|
205
|
+
```typescript
|
|
206
|
+
// Load the knowledge base, one document per section, and add the search tool
|
|
207
|
+
const salesKnowledge = fileURLToPath(new URL('./sales_knowledge.md', import.meta.url));
|
|
208
|
+
|
|
209
|
+
await agent.addSkill(
|
|
210
|
+
new NativeVectorSearchSkill({
|
|
211
|
+
tool_name: 'search_sales_knowledge',
|
|
212
|
+
description: 'Search sales and product information',
|
|
213
|
+
documents: loadKnowledge(salesKnowledge),
|
|
214
|
+
count: 3,
|
|
215
|
+
}),
|
|
216
|
+
);
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
These options configure the tool:
|
|
220
|
+
|
|
221
|
+
- `tool_name`: the tool's name, which the prompt refers to. The default is `search_knowledge`.
|
|
222
|
+
- `description`: what the model reads to decide when to call the tool
|
|
223
|
+
- `documents`: the documents to index in memory
|
|
224
|
+
- `count`: how many results a search returns unless the model asks for another number, from 1 to 20. The default is 5.
|
|
225
|
+
|
|
226
|
+
The path is built from `import.meta.url`, so the file is found wherever you run the agent from. `addSkill()` returns a promise, because a skill's setup can do asynchronous work, so the file awaits it at the top level.
|
|
227
|
+
|
|
228
|
+
The skill also adds a `Knowledge Search` section to the prompt. It tells the model it can search "local document indexes using the search_sales_knowledge tool over 18 indexed document(s)". The last part of the file starts the server, as in Lesson 1.
|
|
229
|
+
|
|
230
|
+
## Testing knowledge queries
|
|
231
|
+
|
|
232
|
+
Test the tool with `swaig-test` before you call the agent.
|
|
233
|
+
|
|
234
|
+
### Method 1: Use swaig-test
|
|
235
|
+
|
|
236
|
+
List the agent's tools:
|
|
237
|
+
|
|
238
|
+
```bash
|
|
239
|
+
npx tsx src/cli/swaig-test.ts tutorial/multi_agents/sales_agent_with_search.ts --list-tools
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
The skill registered one tool, with a required `query` and an optional `count`:
|
|
243
|
+
|
|
244
|
+
```text
|
|
245
|
+
Available SWAIG functions:
|
|
246
|
+
search_sales_knowledge - Search sales and product information (LOCAL webhook)
|
|
247
|
+
Parameters:
|
|
248
|
+
query (string) (required): Search query or question
|
|
249
|
+
count (integer [default: 3]): Number of results to return (default: 3)
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
Call the tool with a query. Everything after `--exec search_sales_knowledge` is an argument to the tool. Quote the query in single quotes, so the shell doesn't expand `$1500`:
|
|
253
|
+
|
|
254
|
+
```bash
|
|
255
|
+
npx tsx src/cli/swaig-test.ts tutorial/multi_agents/sales_agent_with_search.ts \
|
|
256
|
+
--exec search_sales_knowledge --query 'gaming PC under $1500'
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
The build in that price range ranks first. This output is shortened after the first result:
|
|
260
|
+
|
|
261
|
+
```text
|
|
262
|
+
RESULT:
|
|
263
|
+
Response: Found 3 relevant results for 'gaming PC under $1500':
|
|
264
|
+
|
|
265
|
+
**Result 1** (from sales_knowledge.md, section: Gaming PC Builds > Mid-Range Gaming Build ($1500-$2000), relevance: 0.31)
|
|
266
|
+
Gaming PC Builds > Mid-Range Gaming Build ($1500-$2000)
|
|
267
|
+
- **CPU**: AMD Ryzen 7 7700X or Intel Core i5-13600K
|
|
268
|
+
- **GPU**: NVIDIA RTX 4070 or AMD RX 7800 XT
|
|
269
|
+
- **RAM**: 32GB DDR5 5600MHz (2x16GB)
|
|
270
|
+
- **Storage**: 1TB NVMe Gen4 SSD
|
|
271
|
+
- **PSU**: 750W 80+ Gold
|
|
272
|
+
- **Case**: Mid-tower with RGB and tempered glass
|
|
273
|
+
- **Motherboard**: X670 (AMD) or Z790 (Intel)
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
The model receives this text as the tool's result, and answers the caller from it.
|
|
277
|
+
|
|
278
|
+
### Method 2: See where keyword ranking falls short
|
|
279
|
+
|
|
280
|
+
Search for a part by name, and ask for two results:
|
|
281
|
+
|
|
282
|
+
```bash
|
|
283
|
+
npx tsx src/cli/swaig-test.ts tutorial/multi_agents/sales_agent_with_search.ts \
|
|
284
|
+
--exec search_sales_knowledge --query "RTX 4090" --count 2
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
The power supply table ranks first. It names the RTX 4090 in a short section, so the query's words make up more of it than of the enthusiast build:
|
|
288
|
+
|
|
289
|
+
```text
|
|
290
|
+
RESULT:
|
|
291
|
+
Response: Found 2 relevant results for 'RTX 4090':
|
|
292
|
+
|
|
293
|
+
**Result 1** (from sales_knowledge.md, section: Component Compatibility Guide > Power Supply Requirements, relevance: 0.45)
|
|
294
|
+
Component Compatibility Guide > Power Supply Requirements
|
|
295
|
+
- **RTX 4060/RX 7600**: 550W minimum
|
|
296
|
+
- **RTX 4070/RX 7800 XT**: 650W minimum
|
|
297
|
+
- **RTX 4080/RX 7900 XTX**: 750W minimum
|
|
298
|
+
- **RTX 4090**: 850W minimum (1000W recommended)
|
|
299
|
+
- Always add 20% headroom for efficiency and upgrades
|
|
300
|
+
|
|
301
|
+
**Result 2** (from sales_knowledge.md, section: Gaming PC Builds > Enthusiast Gaming Build ($4000+), relevance: 0.37)
|
|
302
|
+
Gaming PC Builds > Enthusiast Gaming Build ($4000+)
|
|
303
|
+
- **CPU**: AMD Ryzen 9 7950X or Intel Core i9-13900K
|
|
304
|
+
- **GPU**: NVIDIA RTX 4090
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
A query in words the file doesn't use finds nothing. The query `inexpensive rig` returns `No information found for 'inexpensive rig'`, although the budget build answers it. The `count` of 3 gives the model more than one section to work from, which covers the first case. The second needs a vector index, or a knowledge base written in your callers' words.
|
|
308
|
+
|
|
309
|
+
### Method 3: Test by calling the agent
|
|
310
|
+
|
|
311
|
+
When you call the agent, try these requests:
|
|
312
|
+
|
|
313
|
+
- "I need a gaming PC for around $1000"
|
|
314
|
+
- "What's the best build for video editing?"
|
|
315
|
+
- "How big a power supply does an RTX 4090 need?"
|
|
316
|
+
|
|
317
|
+
## Using a vector index
|
|
318
|
+
|
|
319
|
+
A vector index compares the meaning of a query with the meaning of each section. It can match a query to a section that uses different words. The TypeScript SDK doesn't build or read vector indexes itself. It queries a search server over HTTP with the skill's remote mode.
|
|
320
|
+
|
|
321
|
+
The Python SDK's search service is one such server: it builds `.swsearch` vector indexes from your documents with `sw-search`, and serves them. Point the skill at it with `remote_url`, and name the index with `index_name`:
|
|
322
|
+
|
|
323
|
+
<!-- snippet: no-run needs a search server listening at search.example.com -->
|
|
324
|
+
```typescript
|
|
325
|
+
import { AgentBase, NativeVectorSearchSkill } from '@signalwire/sdk';
|
|
326
|
+
|
|
327
|
+
const agent = new AgentBase({ name: 'Morgan', route: '/' });
|
|
328
|
+
|
|
329
|
+
await agent.addSkill(
|
|
330
|
+
new NativeVectorSearchSkill({
|
|
331
|
+
tool_name: 'search_sales_knowledge',
|
|
332
|
+
description: 'Search sales and product information',
|
|
333
|
+
remote_url: 'https://user:password@search.example.com',
|
|
334
|
+
index_name: 'sales',
|
|
335
|
+
count: 3,
|
|
336
|
+
}),
|
|
337
|
+
);
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
When the skill loads, it checks that the server's `/health` answers 200, and the add fails otherwise. Credentials in the URL are sent as basic auth. The URL must not resolve to a private or internal address unless `SWML_ALLOW_PRIVATE_URLS` is set. For the full list of options, see [native_vector_search](../../docs/skills-guide.md#native_vector_search) in the skills guide.
|
|
341
|
+
|
|
342
|
+
## Best practices
|
|
343
|
+
|
|
344
|
+
These practices apply to both modes.
|
|
345
|
+
|
|
346
|
+
### Knowledge base design
|
|
347
|
+
|
|
348
|
+
Keep the knowledge base current and consistent:
|
|
349
|
+
|
|
350
|
+
- Include specific model numbers and prices
|
|
351
|
+
- Keep each section on one topic, and short enough to read aloud in pieces
|
|
352
|
+
- Use the same terms throughout, and the terms your callers use
|
|
353
|
+
- Remove outdated information instead of adding a correction elsewhere
|
|
354
|
+
|
|
355
|
+
### Search integration
|
|
356
|
+
|
|
357
|
+
The prompt shapes how the agent uses results. These patterns help:
|
|
358
|
+
|
|
359
|
+
1. **Acknowledge the search**: "Let me find the best options in your budget."
|
|
360
|
+
2. **Handle no results**: "I don't have specific information about that, but based on similar builds..."
|
|
361
|
+
3. **Combine results**: "Based on our current recommendations, I found three options."
|
|
362
|
+
|
|
363
|
+
### Performance
|
|
364
|
+
|
|
365
|
+
These habits keep searches fast and results useful:
|
|
366
|
+
|
|
367
|
+
1. **Focused knowledge bases**: one per domain, as this tutorial does for sales and support
|
|
368
|
+
2. **A small result count**: 3 to 5 results give the model enough without a long tool result
|
|
369
|
+
3. **Startup indexing**: the in-memory index is built once, when the agent starts
|
|
370
|
+
4. **A size limit**: `max_content_length` caps the characters in a tool result, shared by its results, 32768 by default
|
|
371
|
+
|
|
372
|
+
## Summary
|
|
373
|
+
|
|
374
|
+
This lesson gave Morgan a searchable product knowledge base. The main points:
|
|
375
|
+
|
|
376
|
+
- `native_vector_search` searches documents in memory, or a remote vector index
|
|
377
|
+
- The in-memory mode ranks by keywords, and returns each document whole, so split files into sections
|
|
378
|
+
- `swaig-test --exec` calls the search tool without a server
|
|
379
|
+
- The prompt tells the model when to search, and the skill adds its own instructions
|
|
380
|
+
|
|
381
|
+
### Practice exercises
|
|
382
|
+
|
|
383
|
+
Try these before you move on:
|
|
384
|
+
|
|
385
|
+
1. **Create a knowledge base**: write a Markdown file about PC accessories (monitors, keyboards, mice), and load it into a second search tool.
|
|
386
|
+
2. **Adjust the result count**: try `count` values of 1 and 5, and compare the answers.
|
|
387
|
+
3. **Refine the search**: update the prompt to ask clarifying questions before searching.
|
|
388
|
+
4. **Test edge cases**: see how the agent handles a query with no good match.
|
|
389
|
+
|
|
390
|
+
### Troubleshooting
|
|
391
|
+
|
|
392
|
+
These problems come up most often in this lesson:
|
|
393
|
+
|
|
394
|
+
- **`No documents are loaded for searching`**: the `documents` array was empty. Check the path to the knowledge file.
|
|
395
|
+
- **`ENOENT` at startup**: the knowledge file doesn't exist at the path. Build the path from `import.meta.url`, as the lesson does.
|
|
396
|
+
- **Results that miss the obvious section**: the query and the section share no words. Add the missing terms to the knowledge base, or use a vector index.
|
|
397
|
+
|
|
398
|
+
### Next steps
|
|
399
|
+
|
|
400
|
+
Next, host Morgan with a triage agent and a support agent, and transfer calls between them. Continue with [Lesson 3: Building Multi-Agent Systems](lesson3_multi_agent_systems.md).
|
|
401
|
+
|
|
402
|
+
---
|
|
403
|
+
|
|
404
|
+
[Previous: Lesson 1 - Creating Your First Agent](lesson1_first_agent.md) | [Tutorial Overview](README.md) | [Next: Lesson 3 - Building Multi-Agent Systems](lesson3_multi_agent_systems.md)
|