@signalwire/sdk 2.0.1 → 2.0.3
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/dist/AgentBase.d.ts +1045 -0
- package/dist/AgentBase.js +2375 -0
- package/dist/AgentBase.js.map +1 -0
- package/dist/AgentServer.d.ts +146 -0
- package/dist/AgentServer.js +388 -0
- package/dist/AgentServer.js.map +1 -0
- package/dist/AuthHandler.d.ts +127 -0
- package/dist/AuthHandler.js +212 -0
- package/dist/AuthHandler.js.map +1 -0
- package/dist/ConfigLoader.d.ts +170 -0
- package/dist/ConfigLoader.js +393 -0
- package/dist/ConfigLoader.js.map +1 -0
- package/dist/ContextBuilder.d.ts +652 -0
- package/dist/ContextBuilder.js +1115 -0
- package/dist/ContextBuilder.js.map +1 -0
- package/dist/DataMap.d.ts +271 -0
- package/dist/DataMap.js +430 -0
- package/dist/DataMap.js.map +1 -0
- package/dist/FunctionResult.d.ts +481 -0
- package/dist/FunctionResult.js +775 -0
- package/dist/FunctionResult.js.map +1 -0
- package/dist/Logger.d.ts +113 -0
- package/dist/Logger.js +320 -0
- package/dist/Logger.js.map +1 -0
- package/dist/PomBuilder.d.ts +208 -0
- package/dist/PomBuilder.js +409 -0
- package/dist/PomBuilder.js.map +1 -0
- package/dist/PromptManager.d.ts +85 -0
- package/dist/PromptManager.js +108 -0
- package/dist/PromptManager.js.map +1 -0
- package/dist/SWMLHandler.d.ts +159 -0
- package/dist/SWMLHandler.js +229 -0
- package/dist/SWMLHandler.js.map +1 -0
- package/dist/SWMLService.d.ts +326 -0
- package/dist/SWMLService.js +610 -0
- package/dist/SWMLService.js.map +1 -0
- package/dist/SchemaUtils.d.ts +108 -0
- package/dist/SchemaUtils.js +317 -0
- package/dist/SchemaUtils.js.map +1 -0
- package/dist/SecurityUtils.d.ts +60 -0
- package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
- package/dist/SecurityUtils.js.map +1 -0
- package/dist/ServerlessAdapter.d.ts +119 -0
- package/dist/ServerlessAdapter.js +188 -0
- package/dist/ServerlessAdapter.js.map +1 -0
- package/dist/SessionManager.d.ts +142 -0
- package/dist/SessionManager.js +260 -0
- package/dist/SessionManager.js.map +1 -0
- package/dist/SslConfig.d.ts +77 -0
- package/dist/SslConfig.js +100 -0
- package/dist/SslConfig.js.map +1 -0
- package/dist/SwaigFunction.d.ts +159 -0
- package/dist/SwaigFunction.js +209 -0
- package/dist/SwaigFunction.js.map +1 -0
- package/dist/SwmlBuilder.d.ts +165 -0
- package/dist/SwmlBuilder.js +247 -0
- package/dist/SwmlBuilder.js.map +1 -0
- package/dist/SwmlVerbMethods.generated.d.ts +254 -0
- package/dist/SwmlVerbMethods.generated.js +9 -0
- package/dist/SwmlVerbMethods.generated.js.map +1 -0
- package/dist/TypeInference.d.ts +71 -0
- package/dist/TypeInference.js +164 -0
- package/dist/TypeInference.js.map +1 -0
- package/dist/WebService.d.ts +148 -0
- package/dist/WebService.js +532 -0
- package/dist/WebService.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +22 -0
- package/dist/cli/agent-loader.js +144 -0
- package/dist/cli/agent-loader.js.map +1 -0
- package/dist/cli/mock-data.d.ts +37 -0
- package/dist/cli/mock-data.js +80 -0
- package/dist/cli/mock-data.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +32 -0
- package/dist/cli/swaig-test.js +418 -0
- package/dist/cli/swaig-test.js.map +1 -0
- package/dist/generateVerbTypes.d.ts +11 -0
- package/dist/generateVerbTypes.js +265 -0
- package/dist/generateVerbTypes.js.map +1 -0
- package/{src/index.ts → dist/index.d.ts} +13 -100
- package/dist/index.js +152 -0
- package/dist/index.js.map +1 -0
- package/dist/livewire/index.d.ts +653 -0
- package/dist/livewire/index.js +992 -0
- package/dist/livewire/index.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +89 -0
- package/dist/prefabs/ConciergeAgent.js +245 -0
- package/dist/prefabs/ConciergeAgent.js.map +1 -0
- package/dist/prefabs/FAQBotAgent.d.ts +113 -0
- package/dist/prefabs/FAQBotAgent.js +329 -0
- package/dist/prefabs/FAQBotAgent.js.map +1 -0
- package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
- package/dist/prefabs/InfoGathererAgent.js +287 -0
- package/dist/prefabs/InfoGathererAgent.js.map +1 -0
- package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
- package/dist/prefabs/ReceptionistAgent.js +303 -0
- package/dist/prefabs/ReceptionistAgent.js.map +1 -0
- package/dist/prefabs/SurveyAgent.d.ts +148 -0
- package/dist/prefabs/SurveyAgent.js +540 -0
- package/dist/prefabs/SurveyAgent.js.map +1 -0
- package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
- package/dist/prefabs/index.js +14 -0
- package/dist/prefabs/index.js.map +1 -0
- package/dist/relay/Action.d.ts +258 -0
- package/dist/relay/Action.js +402 -0
- package/dist/relay/Action.js.map +1 -0
- package/dist/relay/Call.d.ts +697 -0
- package/dist/relay/Call.js +1062 -0
- package/dist/relay/Call.js.map +1 -0
- package/dist/relay/Deferred.d.ts +44 -0
- package/dist/relay/Deferred.js +69 -0
- package/dist/relay/Deferred.js.map +1 -0
- package/dist/relay/Message.d.ts +103 -0
- package/dist/relay/Message.js +169 -0
- package/dist/relay/Message.js.map +1 -0
- package/dist/relay/RelayClient.d.ts +302 -0
- package/dist/relay/RelayClient.js +1026 -0
- package/dist/relay/RelayClient.js.map +1 -0
- package/dist/relay/RelayError.d.ts +15 -0
- package/dist/relay/RelayError.js +20 -0
- package/dist/relay/RelayError.js.map +1 -0
- package/dist/relay/RelayEvent.d.ts +254 -0
- package/dist/relay/RelayEvent.js +509 -0
- package/dist/relay/RelayEvent.js.map +1 -0
- package/dist/relay/constants.d.ts +90 -0
- package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
- package/dist/relay/constants.js.map +1 -0
- package/dist/relay/index.d.ts +16 -0
- package/dist/relay/index.js +18 -0
- package/dist/relay/index.js.map +1 -0
- package/dist/relay/types.d.ts +142 -0
- package/dist/relay/types.js +5 -0
- package/dist/relay/types.js.map +1 -0
- package/dist/rest/HttpClient.d.ts +80 -0
- package/dist/rest/HttpClient.js +148 -0
- package/dist/rest/HttpClient.js.map +1 -0
- package/dist/rest/RestError.d.ts +30 -0
- package/dist/rest/RestError.js +39 -0
- package/dist/rest/RestError.js.map +1 -0
- package/dist/rest/base/BaseResource.d.ts +24 -0
- package/dist/rest/base/BaseResource.js +29 -0
- package/dist/rest/base/BaseResource.js.map +1 -0
- package/dist/rest/base/CrudResource.d.ts +68 -0
- package/dist/rest/base/CrudResource.js +82 -0
- package/dist/rest/base/CrudResource.js.map +1 -0
- package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
- package/dist/rest/base/CrudWithAddresses.js +25 -0
- package/dist/rest/base/CrudWithAddresses.js.map +1 -0
- package/dist/rest/index.d.ts +131 -0
- package/{src/rest/index.ts → dist/rest/index.js} +101 -136
- package/dist/rest/index.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +46 -0
- package/dist/rest/namespaces/addresses.js +55 -0
- package/dist/rest/namespaces/addresses.js.map +1 -0
- package/dist/rest/namespaces/calling.d.ts +382 -0
- package/dist/rest/namespaces/calling.js +478 -0
- package/dist/rest/namespaces/calling.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +22 -0
- package/dist/rest/namespaces/chat.js +26 -0
- package/dist/rest/namespaces/chat.js.map +1 -0
- package/dist/rest/namespaces/compat.d.ts +585 -0
- package/dist/rest/namespaces/compat.js +735 -0
- package/dist/rest/namespaces/compat.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +66 -0
- package/dist/rest/namespaces/datasphere.js +77 -0
- package/dist/rest/namespaces/datasphere.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +282 -0
- package/dist/rest/namespaces/fabric.js +373 -0
- package/dist/rest/namespaces/fabric.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
- package/dist/rest/namespaces/imported-numbers.js +26 -0
- package/dist/rest/namespaces/imported-numbers.js.map +1 -0
- package/dist/rest/namespaces/logs.d.ts +105 -0
- package/dist/rest/namespaces/logs.js +133 -0
- package/dist/rest/namespaces/logs.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +29 -0
- package/dist/rest/namespaces/lookup.js +32 -0
- package/dist/rest/namespaces/lookup.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +46 -0
- package/dist/rest/namespaces/mfa.js +54 -0
- package/dist/rest/namespaces/mfa.js.map +1 -0
- package/dist/rest/namespaces/number-groups.d.ts +49 -0
- package/dist/rest/namespaces/number-groups.js +58 -0
- package/dist/rest/namespaces/number-groups.js.map +1 -0
- package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
- package/dist/rest/namespaces/phone-numbers.js +67 -0
- package/dist/rest/namespaces/phone-numbers.js.map +1 -0
- package/dist/rest/namespaces/project.d.ts +46 -0
- package/dist/rest/namespaces/project.js +56 -0
- package/dist/rest/namespaces/project.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +22 -0
- package/dist/rest/namespaces/pubsub.js +26 -0
- package/dist/rest/namespaces/pubsub.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +42 -0
- package/dist/rest/namespaces/queues.js +49 -0
- package/dist/rest/namespaces/queues.js.map +1 -0
- package/dist/rest/namespaces/recordings.d.ts +38 -0
- package/dist/rest/namespaces/recordings.js +45 -0
- package/dist/rest/namespaces/recordings.js.map +1 -0
- package/dist/rest/namespaces/registry.d.ts +141 -0
- package/dist/rest/namespaces/registry.js +178 -0
- package/dist/rest/namespaces/registry.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +39 -0
- package/dist/rest/namespaces/short-codes.js +46 -0
- package/dist/rest/namespaces/short-codes.js.map +1 -0
- package/dist/rest/namespaces/sip-profile.d.ts +28 -0
- package/dist/rest/namespaces/sip-profile.js +34 -0
- package/dist/rest/namespaces/sip-profile.js.map +1 -0
- package/dist/rest/namespaces/verified-callers.d.ts +33 -0
- package/dist/rest/namespaces/verified-callers.js +39 -0
- package/dist/rest/namespaces/verified-callers.js.map +1 -0
- package/dist/rest/namespaces/video.d.ts +235 -0
- package/dist/rest/namespaces/video.js +297 -0
- package/dist/rest/namespaces/video.js.map +1 -0
- package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
- package/dist/rest/pagination.js +78 -0
- package/dist/rest/pagination.js.map +1 -0
- package/dist/rest/types.d.ts +54 -0
- package/dist/rest/types.js +5 -0
- package/dist/rest/types.js.map +1 -0
- package/dist/skills/SkillBase.d.ts +404 -0
- package/dist/skills/SkillBase.js +471 -0
- package/dist/skills/SkillBase.js.map +1 -0
- package/dist/skills/SkillManager.d.ts +195 -0
- package/dist/skills/SkillManager.js +378 -0
- package/dist/skills/SkillManager.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +176 -0
- package/dist/skills/SkillRegistry.js +310 -0
- package/dist/skills/SkillRegistry.js.map +1 -0
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
- package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
- package/dist/skills/builtin/ask_claude.d.ts +37 -0
- package/dist/skills/builtin/ask_claude.js +162 -0
- package/dist/skills/builtin/ask_claude.js.map +1 -0
- package/dist/skills/builtin/claude_skills.d.ts +75 -0
- package/dist/skills/builtin/claude_skills.js +753 -0
- package/dist/skills/builtin/claude_skills.js.map +1 -0
- package/dist/skills/builtin/custom_skills.d.ts +79 -0
- package/dist/skills/builtin/custom_skills.js +227 -0
- package/dist/skills/builtin/custom_skills.js.map +1 -0
- package/dist/skills/builtin/datasphere.d.ts +73 -0
- package/dist/skills/builtin/datasphere.js +350 -0
- package/dist/skills/builtin/datasphere.js.map +1 -0
- package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
- package/dist/skills/builtin/datasphere_serverless.js +291 -0
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
- package/dist/skills/builtin/datetime.d.ts +40 -0
- package/dist/skills/builtin/datetime.js +118 -0
- package/dist/skills/builtin/datetime.js.map +1 -0
- package/dist/skills/builtin/google_maps.d.ts +48 -0
- package/dist/skills/builtin/google_maps.js +470 -0
- package/dist/skills/builtin/google_maps.js.map +1 -0
- package/dist/skills/builtin/index.d.ts +31 -0
- package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
- package/dist/skills/builtin/index.js.map +1 -0
- package/dist/skills/builtin/info_gatherer.d.ts +115 -0
- package/dist/skills/builtin/info_gatherer.js +328 -0
- package/dist/skills/builtin/info_gatherer.js.map +1 -0
- package/dist/skills/builtin/joke.d.ts +41 -0
- package/dist/skills/builtin/joke.js +156 -0
- package/dist/skills/builtin/joke.js.map +1 -0
- package/dist/skills/builtin/math.d.ts +39 -0
- package/dist/skills/builtin/math.js +119 -0
- package/dist/skills/builtin/math.js.map +1 -0
- package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
- package/dist/skills/builtin/mcp_gateway.js +574 -0
- package/dist/skills/builtin/mcp_gateway.js.map +1 -0
- package/dist/skills/builtin/native_vector_search.d.ts +128 -0
- package/dist/skills/builtin/native_vector_search.js +752 -0
- package/dist/skills/builtin/native_vector_search.js.map +1 -0
- package/dist/skills/builtin/play_background_file.d.ts +59 -0
- package/dist/skills/builtin/play_background_file.js +274 -0
- package/dist/skills/builtin/play_background_file.js.map +1 -0
- package/dist/skills/builtin/spider.d.ts +91 -0
- package/dist/skills/builtin/spider.js +758 -0
- package/dist/skills/builtin/spider.js.map +1 -0
- package/dist/skills/builtin/swml_transfer.d.ts +66 -0
- package/dist/skills/builtin/swml_transfer.js +475 -0
- package/dist/skills/builtin/swml_transfer.js.map +1 -0
- package/dist/skills/builtin/weather_api.d.ts +59 -0
- package/dist/skills/builtin/weather_api.js +196 -0
- package/dist/skills/builtin/weather_api.js.map +1 -0
- package/dist/skills/builtin/web_search.d.ts +160 -0
- package/dist/skills/builtin/web_search.js +894 -0
- package/dist/skills/builtin/web_search.js.map +1 -0
- package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
- package/dist/skills/builtin/wikipedia_search.js +241 -0
- package/dist/skills/builtin/wikipedia_search.js.map +1 -0
- package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
- package/dist/skills/index.js +10 -0
- package/dist/skills/index.js.map +1 -0
- package/dist/types.d.ts +118 -0
- package/dist/types.js +5 -0
- package/dist/types.js.map +1 -0
- package/package.json +7 -1
- package/.github/workflows/publish.yml +0 -27
- package/.github/workflows/test.yml +0 -17
- package/CLAUDE.md +0 -112
- package/docs/MIGRATION-2.0.md +0 -81
- package/docs/agent-guide.md +0 -869
- package/docs/agent_guide.md +0 -1026
- package/docs/api-reference.md +0 -2420
- package/docs/api_reference.md +0 -1301
- package/docs/architecture.md +0 -843
- package/docs/cli-guide.md +0 -579
- package/docs/cli_guide.md +0 -448
- package/docs/cloud_functions_guide.md +0 -474
- package/docs/configuration.md +0 -422
- package/docs/contexts-guide.md +0 -787
- package/docs/contexts_guide.md +0 -511
- package/docs/datamap-guide.md +0 -1141
- package/docs/datamap_guide.md +0 -595
- package/docs/llm_parameters.md +0 -239
- package/docs/mcp_gateway_reference.md +0 -648
- package/docs/mcp_integration.md +0 -108
- package/docs/prefabs-guide.md +0 -800
- package/docs/sdk_features.md +0 -477
- package/docs/security.md +0 -436
- package/docs/serverless-guide.md +0 -513
- package/docs/skills-guide.md +0 -857
- package/docs/skills-system.md +0 -301
- package/docs/skills_parameter_schema.md +0 -392
- package/docs/skills_system.md +0 -467
- package/docs/swaig-reference.md +0 -1627
- package/docs/swaig_reference.md +0 -910
- package/docs/swml_service_guide.md +0 -600
- package/docs/third_party_skills.md +0 -533
- package/docs/web_service.md +0 -677
- package/examples/README.md +0 -131
- package/examples/advanced-datamap.ts +0 -100
- package/examples/advanced-dynamic-config.ts +0 -70
- package/examples/auto-vivified.ts +0 -94
- package/examples/call-flow.ts +0 -63
- package/examples/comprehensive-dynamic.ts +0 -125
- package/examples/contexts-steps.ts +0 -65
- package/examples/custom-path.ts +0 -45
- package/examples/datamap-tools.ts +0 -55
- package/examples/datasphere-multi-instance.ts +0 -63
- package/examples/datasphere-serverless-env.ts +0 -68
- package/examples/datasphere-webhook-env.ts +0 -66
- package/examples/datasphere.ts +0 -37
- package/examples/declarative.ts +0 -100
- package/examples/dynamic-config.ts +0 -54
- package/examples/dynamic-info-gatherer.ts +0 -69
- package/examples/dynamic-swml-service.ts +0 -67
- package/examples/gather-info.ts +0 -71
- package/examples/gather-per-question-functions-demo.ts +0 -140
- package/examples/joke-agent.ts +0 -34
- package/examples/kubernetes-agent.ts +0 -45
- package/examples/llm-params.ts +0 -69
- package/examples/mcp-agent.ts +0 -84
- package/examples/mcp-gateway.ts +0 -35
- package/examples/multi-agent.ts +0 -73
- package/examples/multi-endpoint.ts +0 -79
- package/examples/pom-prompt.ts +0 -71
- package/examples/prefab-concierge.ts +0 -47
- package/examples/prefab-faq.ts +0 -54
- package/examples/prefab-info-gatherer.ts +0 -33
- package/examples/prefab-receptionist.ts +0 -36
- package/examples/prefab-survey.ts +0 -68
- package/examples/record-call.ts +0 -67
- package/examples/relay-demo.ts +0 -33
- package/examples/room-and-sip.ts +0 -94
- package/examples/serverless-lambda.ts +0 -35
- package/examples/session-state.ts +0 -83
- package/examples/simple-agent.ts +0 -36
- package/examples/simple-static.ts +0 -29
- package/examples/skills-demo.ts +0 -38
- package/examples/step-function-inheritance-demo.ts +0 -124
- package/examples/swaig-features.ts +0 -187
- package/examples/swml-service-routing.ts +0 -66
- package/examples/swml-service.ts +0 -38
- package/examples/tap.ts +0 -68
- package/examples/verb-methods.ts +0 -45
- package/examples/web-search-multi-instance.ts +0 -72
- package/examples/web-search.ts +0 -38
- package/examples/wikipedia.ts +0 -36
- package/livewire/README.md +0 -140
- package/livewire/docs/migration-guide.md +0 -228
- package/livewire/examples/livewire-basic-agent.ts +0 -74
- package/livewire/examples/livewire-handoff.ts +0 -197
- package/livewire/examples/livewire-multi-tool.ts +0 -117
- package/relay/README.md +0 -70
- package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
- package/relay/docs/call-methods.md +0 -474
- package/relay/docs/client-reference.md +0 -142
- package/relay/docs/events.md +0 -134
- package/relay/docs/getting-started.md +0 -134
- package/relay/docs/guide.md +0 -306
- package/relay/docs/messaging.md +0 -182
- package/relay/examples/relay-inbound.ts +0 -66
- package/relay/examples/relay-messaging.ts +0 -71
- package/relay/examples/relay-outbound.ts +0 -76
- package/rest/README.md +0 -95
- package/rest/docs/calling.md +0 -273
- package/rest/docs/client-reference.md +0 -107
- package/rest/docs/compat.md +0 -204
- package/rest/docs/fabric.md +0 -183
- package/rest/docs/getting-started.md +0 -110
- package/rest/docs/guide.md +0 -351
- package/rest/docs/namespaces.md +0 -285
- package/rest/examples/rest-10dlc-registration.ts +0 -161
- package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
- package/rest/examples/rest-calling-play-and-record.ts +0 -91
- package/rest/examples/rest-client.ts +0 -65
- package/rest/examples/rest-compat-laml.ts +0 -210
- package/rest/examples/rest-datasphere-search.ts +0 -82
- package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
- package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
- package/rest/examples/rest-manage-resources.ts +0 -65
- package/rest/examples/rest-phone-number-management.ts +0 -197
- package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
- package/rest/examples/rest-video-rooms.ts +0 -186
- package/src/AgentBase.ts +0 -2598
- package/src/AgentServer.ts +0 -442
- package/src/AuthHandler.ts +0 -256
- package/src/ConfigLoader.ts +0 -447
- package/src/ContextBuilder.ts +0 -1181
- package/src/DataMap.ts +0 -477
- package/src/FunctionResult.ts +0 -903
- package/src/Logger.ts +0 -337
- package/src/PomBuilder.ts +0 -467
- package/src/PromptManager.ts +0 -133
- package/src/SWMLHandler.ts +0 -298
- package/src/SWMLService.ts +0 -749
- package/src/SchemaUtils.ts +0 -361
- package/src/ServerlessAdapter.ts +0 -240
- package/src/SessionManager.ts +0 -311
- package/src/SslConfig.ts +0 -118
- package/src/SwaigFunction.ts +0 -276
- package/src/SwmlBuilder.ts +0 -283
- package/src/SwmlVerbMethods.generated.ts +0 -234
- package/src/TypeInference.ts +0 -199
- package/src/WebService.ts +0 -641
- package/src/cli/agent-loader.ts +0 -166
- package/src/cli/mock-data.ts +0 -111
- package/src/cli/swaig-test.ts +0 -452
- package/src/generateVerbTypes.ts +0 -322
- package/src/livewire/index.ts +0 -1252
- package/src/prefabs/ConciergeAgent.ts +0 -309
- package/src/prefabs/FAQBotAgent.ts +0 -415
- package/src/prefabs/InfoGathererAgent.ts +0 -379
- package/src/prefabs/ReceptionistAgent.ts +0 -395
- package/src/prefabs/SurveyAgent.ts +0 -671
- package/src/relay/Action.ts +0 -482
- package/src/relay/Call.ts +0 -1270
- package/src/relay/Deferred.ts +0 -94
- package/src/relay/Message.ts +0 -199
- package/src/relay/RelayClient.ts +0 -1185
- package/src/relay/RelayError.ts +0 -20
- package/src/relay/RelayEvent.ts +0 -944
- package/src/relay/index.ts +0 -123
- package/src/relay/types.ts +0 -149
- package/src/rest/HttpClient.ts +0 -164
- package/src/rest/RestError.ts +0 -45
- package/src/rest/base/BaseResource.ts +0 -32
- package/src/rest/base/CrudResource.ts +0 -98
- package/src/rest/base/CrudWithAddresses.ts +0 -37
- package/src/rest/namespaces/addresses.ts +0 -64
- package/src/rest/namespaces/calling.ts +0 -534
- package/src/rest/namespaces/chat.ts +0 -31
- package/src/rest/namespaces/compat.ts +0 -812
- package/src/rest/namespaces/datasphere.ts +0 -88
- package/src/rest/namespaces/fabric.ts +0 -417
- package/src/rest/namespaces/imported-numbers.ts +0 -31
- package/src/rest/namespaces/logs.ts +0 -151
- package/src/rest/namespaces/lookup.ts +0 -38
- package/src/rest/namespaces/mfa.ts +0 -61
- package/src/rest/namespaces/number-groups.ts +0 -68
- package/src/rest/namespaces/phone-numbers.ts +0 -76
- package/src/rest/namespaces/project.ts +0 -65
- package/src/rest/namespaces/pubsub.ts +0 -31
- package/src/rest/namespaces/queues.ts +0 -58
- package/src/rest/namespaces/recordings.ts +0 -53
- package/src/rest/namespaces/registry.ts +0 -200
- package/src/rest/namespaces/short-codes.ts +0 -54
- package/src/rest/namespaces/sip-profile.ts +0 -40
- package/src/rest/namespaces/verified-callers.ts +0 -46
- package/src/rest/namespaces/video.ts +0 -332
- package/src/rest/types.ts +0 -61
- package/src/skills/SkillBase.ts +0 -582
- package/src/skills/SkillManager.ts +0 -419
- package/src/skills/SkillRegistry.ts +0 -367
- package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
- package/src/skills/builtin/ask_claude.ts +0 -246
- package/src/skills/builtin/claude_skills.ts +0 -983
- package/src/skills/builtin/custom_skills.ts +0 -327
- package/src/skills/builtin/datasphere.ts +0 -447
- package/src/skills/builtin/datasphere_serverless.ts +0 -347
- package/src/skills/builtin/datetime.ts +0 -137
- package/src/skills/builtin/google_maps.ts +0 -656
- package/src/skills/builtin/info_gatherer.ts +0 -415
- package/src/skills/builtin/joke.ts +0 -196
- package/src/skills/builtin/math.ts +0 -149
- package/src/skills/builtin/mcp_gateway.ts +0 -685
- package/src/skills/builtin/native_vector_search.ts +0 -910
- package/src/skills/builtin/play_background_file.ts +0 -367
- package/src/skills/builtin/spider.ts +0 -874
- package/src/skills/builtin/swml_transfer.ts +0 -645
- package/src/skills/builtin/weather_api.ts +0 -255
- package/src/skills/builtin/web_search.ts +0 -1083
- package/src/skills/builtin/wikipedia_search.ts +0 -304
- package/src/types.ts +0 -132
- package/tests/AgentBase.test.ts +0 -1093
- package/tests/AgentServer.test.ts +0 -126
- package/tests/AuthHandler.test.ts +0 -133
- package/tests/ConfigLoader.test.ts +0 -151
- package/tests/ContextBuilder.test.ts +0 -108
- package/tests/DataMap.test.ts +0 -367
- package/tests/EphemeralSkillCopy.test.ts +0 -107
- package/tests/FunctionResult.test.ts +0 -298
- package/tests/GracefulShutdown.test.ts +0 -46
- package/tests/Logger.test.ts +0 -420
- package/tests/PomBuilder.test.ts +0 -228
- package/tests/ProxyDetection.test.ts +0 -228
- package/tests/SWMLService.test.ts +0 -320
- package/tests/SWMLVerbHandler.test.ts +0 -523
- package/tests/SchemaUtils.test.ts +0 -106
- package/tests/SchemaUtils.verb.test.ts +0 -206
- package/tests/SecurityUtils.test.ts +0 -192
- package/tests/ServerlessAdapter.test.ts +0 -222
- package/tests/SessionManager.test.ts +0 -257
- package/tests/SkillBaseFeatures.test.ts +0 -130
- package/tests/SkillMultiInstance.test.ts +0 -102
- package/tests/SkillParameterSchemas.test.ts +0 -134
- package/tests/SkillRegistrySchema.test.ts +0 -84
- package/tests/SslConfig.test.ts +0 -97
- package/tests/SwmlBuilder.test.ts +0 -400
- package/tests/TypeInference.test.ts +0 -165
- package/tests/VerbHandlerRegistry.test.ts +0 -128
- package/tests/cli/mock-data.test.ts +0 -113
- package/tests/cli/swaig-test.test.ts +0 -108
- package/tests/examples.test.ts +0 -194
- package/tests/fixtures/scrape-parity/README.md +0 -53
- package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
- package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
- package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
- package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
- package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
- package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
- package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
- package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
- package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
- package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
- package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
- package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
- package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
- package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
- package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
- package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
- package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
- package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
- package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
- package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
- package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
- package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
- package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
- package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
- package/tests/fixtures/scrape-parity/python_extract.py +0 -109
- package/tests/livewire/livewire.test.ts +0 -780
- package/tests/mcp.test.ts +0 -221
- package/tests/prefabs/prefabs.test.ts +0 -1093
- package/tests/relay/Action.test.ts +0 -392
- package/tests/relay/Call.test.ts +0 -535
- package/tests/relay/Deferred.test.ts +0 -71
- package/tests/relay/Message.test.ts +0 -164
- package/tests/relay/RelayClient.test.ts +0 -779
- package/tests/relay/RelayEvent.test.ts +0 -463
- package/tests/relay/helpers.ts +0 -79
- package/tests/rest/HttpClient.test.ts +0 -274
- package/tests/rest/RestError.test.ts +0 -53
- package/tests/rest/calling.test.ts +0 -156
- package/tests/rest/client.test.ts +0 -197
- package/tests/rest/compat.test.ts +0 -335
- package/tests/rest/datasphere.test.ts +0 -71
- package/tests/rest/fabric.test.ts +0 -186
- package/tests/rest/helpers.ts +0 -95
- package/tests/rest/logs.test.ts +0 -68
- package/tests/rest/pagination.test.ts +0 -133
- package/tests/rest/registry.test.ts +0 -94
- package/tests/rest/relay-rest.test.ts +0 -290
- package/tests/rest/video.test.ts +0 -173
- package/tests/setup.ts +0 -6
- package/tests/skills/SkillBase.test.ts +0 -108
- package/tests/skills/SkillManager.test.ts +0 -268
- package/tests/skills/SkillRegistry.test.ts +0 -176
- package/tests/skills/builtin.test.ts +0 -1472
- package/tests/skills/claude-skills.test.ts +0 -54
- package/tests/skills/custom-skills.test.ts +0 -53
- package/tests/skills/datasphere-serverless.test.ts +0 -70
- package/tests/skills/datasphere.test.ts +0 -107
- package/tests/skills/datetime.test.ts +0 -101
- package/tests/skills/google-maps.test.ts +0 -78
- package/tests/skills/info-gatherer.test.ts +0 -411
- package/tests/skills/joke.test.ts +0 -81
- package/tests/skills/math.test.ts +0 -68
- package/tests/skills/mcp-gateway.test.ts +0 -101
- package/tests/skills/play-background.test.ts +0 -54
- package/tests/skills/spider.test.ts +0 -108
- package/tests/skills/swml-transfer.test.ts +0 -178
- package/tests/skills/trivia.test.ts +0 -54
- package/tests/skills/vector-search.test.ts +0 -135
- package/tests/skills/weather-api.test.ts +0 -77
- package/tests/skills/web-search-parity.test.ts +0 -59
- package/tests/skills/web-search.test.ts +0 -103
- package/tests/skills/wikipedia.test.ts +0 -63
- package/tsconfig.json +0 -18
- package/vitest.config.ts +0 -9
- /package/{src → dist}/schema.json +0 -0
|
@@ -0,0 +1,350 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* DataSphere Skill - Searches SignalWire DataSphere for knowledge base content.
|
|
3
|
+
*
|
|
4
|
+
* Tier 3 built-in skill matching the Python SDK. All credentials (`space_name`,
|
|
5
|
+
* `project_id`, `token`) and `document_id` are supplied via skill params. Env
|
|
6
|
+
* var fallbacks (`SIGNALWIRE_PROJECT_ID`, `SIGNALWIRE_TOKEN`, `SIGNALWIRE_SPACE`)
|
|
7
|
+
* are honored when the corresponding param is not set.
|
|
8
|
+
*/
|
|
9
|
+
import { SkillBase } from '../SkillBase.js';
|
|
10
|
+
import { FunctionResult } from '../../FunctionResult.js';
|
|
11
|
+
import { getLogger } from '../../Logger.js';
|
|
12
|
+
const log = getLogger('DataSphereSkill');
|
|
13
|
+
const DEFAULT_NO_RESULTS_MESSAGE = "I couldn't find any relevant information for '{query}' in the knowledge base. " +
|
|
14
|
+
'Try rephrasing your question or asking about a different topic.';
|
|
15
|
+
/**
|
|
16
|
+
* Searches SignalWire DataSphere for knowledge base content using semantic search.
|
|
17
|
+
*
|
|
18
|
+
* Tier 3 built-in skill. Credentials can be supplied via params or fall back to
|
|
19
|
+
* `SIGNALWIRE_PROJECT_ID`, `SIGNALWIRE_TOKEN`, and `SIGNALWIRE_SPACE` environment
|
|
20
|
+
* variables. Supports `count`, `distance`, `tags`, `language`, `pos_to_expand`,
|
|
21
|
+
* `max_synonyms`, and `no_results_message` config options.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* agent.addSkill('datasphere', {
|
|
26
|
+
* document_id: 'doc_abc123',
|
|
27
|
+
* count: 3,
|
|
28
|
+
* tags: ['faq'],
|
|
29
|
+
* });
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
export class DataSphereSkill extends SkillBase {
|
|
33
|
+
// Python ground truth: skills/datasphere/skill.py:20-27.
|
|
34
|
+
// REQUIRED_PACKAGES = ["requests"] in Python; TS uses native fetch so [].
|
|
35
|
+
static SKILL_NAME = 'datasphere';
|
|
36
|
+
static SKILL_DESCRIPTION = 'Search knowledge using SignalWire DataSphere RAG stack';
|
|
37
|
+
static SKILL_VERSION = '1.0.0';
|
|
38
|
+
static REQUIRED_PACKAGES = [];
|
|
39
|
+
static REQUIRED_ENV_VARS = [];
|
|
40
|
+
static SUPPORTS_MULTIPLE_INSTANCES = true;
|
|
41
|
+
static getParameterSchema() {
|
|
42
|
+
return {
|
|
43
|
+
...super.getParameterSchema(),
|
|
44
|
+
tool_name: {
|
|
45
|
+
type: 'string',
|
|
46
|
+
description: 'Custom tool name for this DataSphere instance.',
|
|
47
|
+
default: 'search_knowledge',
|
|
48
|
+
required: false,
|
|
49
|
+
},
|
|
50
|
+
space_name: {
|
|
51
|
+
type: 'string',
|
|
52
|
+
description: "SignalWire space name (e.g., 'mycompany' from mycompany.signalwire.com)",
|
|
53
|
+
required: true,
|
|
54
|
+
},
|
|
55
|
+
project_id: {
|
|
56
|
+
type: 'string',
|
|
57
|
+
description: 'SignalWire project ID',
|
|
58
|
+
required: true,
|
|
59
|
+
env_var: 'SIGNALWIRE_PROJECT_ID',
|
|
60
|
+
},
|
|
61
|
+
token: {
|
|
62
|
+
type: 'string',
|
|
63
|
+
description: 'SignalWire API token',
|
|
64
|
+
required: true,
|
|
65
|
+
hidden: true,
|
|
66
|
+
env_var: 'SIGNALWIRE_TOKEN',
|
|
67
|
+
},
|
|
68
|
+
document_id: {
|
|
69
|
+
type: 'string',
|
|
70
|
+
description: 'DataSphere document ID to search within',
|
|
71
|
+
required: true,
|
|
72
|
+
},
|
|
73
|
+
count: {
|
|
74
|
+
type: 'integer',
|
|
75
|
+
description: 'Number of search results to return',
|
|
76
|
+
default: 1,
|
|
77
|
+
required: false,
|
|
78
|
+
min: 1,
|
|
79
|
+
max: 10,
|
|
80
|
+
},
|
|
81
|
+
distance: {
|
|
82
|
+
type: 'number',
|
|
83
|
+
description: 'Maximum distance threshold for results (lower is more relevant)',
|
|
84
|
+
default: 3.0,
|
|
85
|
+
required: false,
|
|
86
|
+
min: 0,
|
|
87
|
+
max: 10,
|
|
88
|
+
},
|
|
89
|
+
tags: {
|
|
90
|
+
type: 'array',
|
|
91
|
+
description: 'Tags to filter search results',
|
|
92
|
+
required: false,
|
|
93
|
+
items: { type: 'string' },
|
|
94
|
+
},
|
|
95
|
+
language: {
|
|
96
|
+
type: 'string',
|
|
97
|
+
description: "Language code for query expansion (e.g., 'en', 'es')",
|
|
98
|
+
required: false,
|
|
99
|
+
},
|
|
100
|
+
pos_to_expand: {
|
|
101
|
+
type: 'array',
|
|
102
|
+
description: 'Parts of speech to expand with synonyms',
|
|
103
|
+
required: false,
|
|
104
|
+
items: { type: 'string', enum: ['NOUN', 'VERB', 'ADJ', 'ADV'] },
|
|
105
|
+
},
|
|
106
|
+
max_synonyms: {
|
|
107
|
+
type: 'integer',
|
|
108
|
+
description: 'Maximum number of synonyms to use for query expansion',
|
|
109
|
+
required: false,
|
|
110
|
+
min: 1,
|
|
111
|
+
max: 10,
|
|
112
|
+
},
|
|
113
|
+
no_results_message: {
|
|
114
|
+
type: 'string',
|
|
115
|
+
description: 'Message to return when no results are found',
|
|
116
|
+
default: DEFAULT_NO_RESULTS_MESSAGE,
|
|
117
|
+
required: false,
|
|
118
|
+
},
|
|
119
|
+
};
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* Instance key for the SkillManager. Defaults to `datasphere_search_knowledge`,
|
|
123
|
+
* matching the Python SDK default. When `tool_name` is set, uses
|
|
124
|
+
* `datasphere_<tool_name>`.
|
|
125
|
+
*/
|
|
126
|
+
getInstanceKey() {
|
|
127
|
+
const toolName = this.getConfig('tool_name', 'search_knowledge');
|
|
128
|
+
return `${this.skillName}_${toolName}`;
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* Global data injected into the agent's SWML context. Matches Python's
|
|
132
|
+
* `get_global_data()` so downstream consumers can detect DataSphere
|
|
133
|
+
* availability, the configured `document_id`, and the knowledge provider.
|
|
134
|
+
*/
|
|
135
|
+
getGlobalData() {
|
|
136
|
+
return {
|
|
137
|
+
datasphere_enabled: true,
|
|
138
|
+
document_id: this.getConfig('document_id', undefined),
|
|
139
|
+
knowledge_provider: 'SignalWire DataSphere',
|
|
140
|
+
};
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* Validate required credentials before the skill becomes active.
|
|
144
|
+
*
|
|
145
|
+
* Mirrors Python skills/datasphere/skill.py:120-128: `setup()` returns false
|
|
146
|
+
* when any of `space_name`, `project_id`, `token`, or `document_id` is
|
|
147
|
+
* missing from either config or env. Fails closed so SkillManager refuses
|
|
148
|
+
* to register a skill that would break at call time.
|
|
149
|
+
*/
|
|
150
|
+
async setup() {
|
|
151
|
+
const spaceName = this.getConfig('space_name', undefined) ??
|
|
152
|
+
process.env['SIGNALWIRE_SPACE'];
|
|
153
|
+
const projectId = this.getConfig('project_id', undefined) ??
|
|
154
|
+
process.env['SIGNALWIRE_PROJECT_ID'];
|
|
155
|
+
const token = this.getConfig('token', undefined) ??
|
|
156
|
+
process.env['SIGNALWIRE_TOKEN'];
|
|
157
|
+
const documentId = this.getConfig('document_id', undefined);
|
|
158
|
+
const missing = [];
|
|
159
|
+
if (!spaceName)
|
|
160
|
+
missing.push('space_name');
|
|
161
|
+
if (!projectId)
|
|
162
|
+
missing.push('project_id');
|
|
163
|
+
if (!token)
|
|
164
|
+
missing.push('token');
|
|
165
|
+
if (!documentId)
|
|
166
|
+
missing.push('document_id');
|
|
167
|
+
if (missing.length > 0) {
|
|
168
|
+
log.error('datasphere: missing required parameters', { missing });
|
|
169
|
+
return false;
|
|
170
|
+
}
|
|
171
|
+
return true;
|
|
172
|
+
}
|
|
173
|
+
/** Resolve the tool name (defaults to `search_knowledge`, matching Python SDK). */
|
|
174
|
+
getToolName() {
|
|
175
|
+
return this.getConfig('tool_name', 'search_knowledge');
|
|
176
|
+
}
|
|
177
|
+
/** @returns A single tool (named via `tool_name`) that performs semantic search. */
|
|
178
|
+
getTools() {
|
|
179
|
+
const count = this.getConfig('count', 1);
|
|
180
|
+
const distance = this.getConfig('distance', 3.0);
|
|
181
|
+
const configDocumentId = this.getConfig('document_id', undefined);
|
|
182
|
+
const tags = this.getConfig('tags', undefined);
|
|
183
|
+
const language = this.getConfig('language', undefined);
|
|
184
|
+
const posToExpand = this.getConfig('pos_to_expand', undefined);
|
|
185
|
+
const maxSynonyms = this.getConfig('max_synonyms', undefined);
|
|
186
|
+
const noResultsMessage = this.getConfig('no_results_message', DEFAULT_NO_RESULTS_MESSAGE);
|
|
187
|
+
const toolName = this.getToolName();
|
|
188
|
+
return [
|
|
189
|
+
{
|
|
190
|
+
name: toolName,
|
|
191
|
+
description: 'Search the knowledge base for information on any topic and return relevant results.',
|
|
192
|
+
parameters: {
|
|
193
|
+
query: {
|
|
194
|
+
type: 'string',
|
|
195
|
+
description: "The search query — what information you're looking for in the knowledge base.",
|
|
196
|
+
},
|
|
197
|
+
},
|
|
198
|
+
required: ['query'],
|
|
199
|
+
handler: async (args, _rawData) => {
|
|
200
|
+
const rawQuery = args['query'];
|
|
201
|
+
if (!rawQuery ||
|
|
202
|
+
typeof rawQuery !== 'string' ||
|
|
203
|
+
rawQuery.trim().length === 0) {
|
|
204
|
+
return new FunctionResult('Please provide a search query. What would you like me to search for in the knowledge base?');
|
|
205
|
+
}
|
|
206
|
+
const query = rawQuery.trim();
|
|
207
|
+
const projectId = this.getConfig('project_id', undefined) ??
|
|
208
|
+
process.env['SIGNALWIRE_PROJECT_ID'];
|
|
209
|
+
const token = this.getConfig('token', undefined) ??
|
|
210
|
+
process.env['SIGNALWIRE_TOKEN'];
|
|
211
|
+
const space = this.getConfig('space_name', undefined) ??
|
|
212
|
+
process.env['SIGNALWIRE_SPACE'];
|
|
213
|
+
if (!projectId || !token || !space) {
|
|
214
|
+
return new FunctionResult('DataSphere is not configured. The SIGNALWIRE_PROJECT_ID, SIGNALWIRE_TOKEN, and SIGNALWIRE_SPACE environment variables (or equivalent config params) are required.');
|
|
215
|
+
}
|
|
216
|
+
// setup() validated document_id is present; always include it
|
|
217
|
+
// unconditionally, matching Python skill.py:186-191.
|
|
218
|
+
const documentId = configDocumentId ?? '';
|
|
219
|
+
log.info('datasphere_search', { query, document_id: documentId });
|
|
220
|
+
try {
|
|
221
|
+
const spaceHost = space.includes('.') ? space : `${space}.signalwire.com`;
|
|
222
|
+
const url = `https://${spaceHost}/api/datasphere/documents/search`;
|
|
223
|
+
const requestBody = {
|
|
224
|
+
document_id: documentId,
|
|
225
|
+
query_string: query,
|
|
226
|
+
count,
|
|
227
|
+
distance,
|
|
228
|
+
};
|
|
229
|
+
if (tags !== undefined) {
|
|
230
|
+
requestBody['tags'] = tags;
|
|
231
|
+
}
|
|
232
|
+
if (language !== undefined) {
|
|
233
|
+
requestBody['language'] = language;
|
|
234
|
+
}
|
|
235
|
+
if (posToExpand !== undefined) {
|
|
236
|
+
requestBody['pos_to_expand'] = posToExpand;
|
|
237
|
+
}
|
|
238
|
+
if (maxSynonyms !== undefined) {
|
|
239
|
+
requestBody['max_synonyms'] = maxSynonyms;
|
|
240
|
+
}
|
|
241
|
+
const authHeader = Buffer.from(`${projectId}:${token}`).toString('base64');
|
|
242
|
+
const controller = new AbortController();
|
|
243
|
+
const timeout = setTimeout(() => controller.abort(), 30_000);
|
|
244
|
+
let response;
|
|
245
|
+
try {
|
|
246
|
+
response = await fetch(url, {
|
|
247
|
+
method: 'POST',
|
|
248
|
+
headers: {
|
|
249
|
+
'Content-Type': 'application/json',
|
|
250
|
+
Accept: 'application/json',
|
|
251
|
+
Authorization: `Basic ${authHeader}`,
|
|
252
|
+
},
|
|
253
|
+
body: JSON.stringify(requestBody),
|
|
254
|
+
signal: controller.signal,
|
|
255
|
+
});
|
|
256
|
+
}
|
|
257
|
+
catch (err) {
|
|
258
|
+
clearTimeout(timeout);
|
|
259
|
+
if (err instanceof Error && err.name === 'AbortError') {
|
|
260
|
+
log.error('datasphere_timeout');
|
|
261
|
+
return new FunctionResult('Sorry, the knowledge search timed out. Please try again.');
|
|
262
|
+
}
|
|
263
|
+
throw err;
|
|
264
|
+
}
|
|
265
|
+
clearTimeout(timeout);
|
|
266
|
+
if (!response.ok) {
|
|
267
|
+
log.error('datasphere_api_error', { status: response.status });
|
|
268
|
+
return new FunctionResult('Sorry, there was an error accessing the knowledge base. Please try again later.');
|
|
269
|
+
}
|
|
270
|
+
const data = (await response.json());
|
|
271
|
+
if (!data || typeof data !== 'object') {
|
|
272
|
+
log.warn('datasphere_invalid_response');
|
|
273
|
+
return new FunctionResult(DataSphereSkill._formatNoResultsMessage(noResultsMessage, query));
|
|
274
|
+
}
|
|
275
|
+
// DataSphere API returns 'chunks', not 'results'.
|
|
276
|
+
const chunks = data.chunks ?? [];
|
|
277
|
+
if (chunks.length === 0) {
|
|
278
|
+
return new FunctionResult(DataSphereSkill._formatNoResultsMessage(noResultsMessage, query));
|
|
279
|
+
}
|
|
280
|
+
return new FunctionResult(DataSphereSkill._formatSearchResults(query, chunks));
|
|
281
|
+
}
|
|
282
|
+
catch (err) {
|
|
283
|
+
log.error('datasphere_search_failed', {
|
|
284
|
+
error: err instanceof Error ? err.message : String(err),
|
|
285
|
+
});
|
|
286
|
+
return new FunctionResult('Sorry, I encountered an error while searching the knowledge base. Please try again later.');
|
|
287
|
+
}
|
|
288
|
+
},
|
|
289
|
+
},
|
|
290
|
+
];
|
|
291
|
+
}
|
|
292
|
+
/** Format search result chunks into a user-facing string. */
|
|
293
|
+
static _formatSearchResults(query, chunks) {
|
|
294
|
+
const header = chunks.length === 1
|
|
295
|
+
? `I found 1 result for '${query}':\n\n`
|
|
296
|
+
: `I found ${chunks.length} results for '${query}':\n\n`;
|
|
297
|
+
const blocks = [];
|
|
298
|
+
const separator = '='.repeat(50);
|
|
299
|
+
for (let i = 0; i < chunks.length; i++) {
|
|
300
|
+
const chunk = chunks[i];
|
|
301
|
+
let content = `=== RESULT ${i + 1} ===\n`;
|
|
302
|
+
if (typeof chunk.text === 'string') {
|
|
303
|
+
content += chunk.text;
|
|
304
|
+
}
|
|
305
|
+
else if (typeof chunk.content === 'string') {
|
|
306
|
+
content += chunk.content;
|
|
307
|
+
}
|
|
308
|
+
else if (typeof chunk.chunk === 'string') {
|
|
309
|
+
content += chunk.chunk;
|
|
310
|
+
}
|
|
311
|
+
else {
|
|
312
|
+
content += JSON.stringify(chunk, null, 2);
|
|
313
|
+
}
|
|
314
|
+
content += `\n${separator}\n\n`;
|
|
315
|
+
blocks.push(content);
|
|
316
|
+
}
|
|
317
|
+
return header + blocks.join('\n');
|
|
318
|
+
}
|
|
319
|
+
/** Apply the `{query}` template to the no-results message. */
|
|
320
|
+
static _formatNoResultsMessage(template, query) {
|
|
321
|
+
return template.includes('{query}')
|
|
322
|
+
? template.replace(/\{query\}/g, query)
|
|
323
|
+
: template;
|
|
324
|
+
}
|
|
325
|
+
/** @returns Prompt section describing DataSphere knowledge base search capabilities. */
|
|
326
|
+
_getPromptSections() {
|
|
327
|
+
const toolName = this.getToolName();
|
|
328
|
+
return [
|
|
329
|
+
{
|
|
330
|
+
title: 'Knowledge Search Capability',
|
|
331
|
+
body: `You can search a knowledge base for information using the ${toolName} tool.`,
|
|
332
|
+
bullets: [
|
|
333
|
+
`Use the ${toolName} tool when users ask for information that might be in the knowledge base`,
|
|
334
|
+
'Search for relevant information using clear, specific queries',
|
|
335
|
+
'Summarize search results in a clear, helpful way',
|
|
336
|
+
'If no results are found, suggest the user try rephrasing their question',
|
|
337
|
+
],
|
|
338
|
+
},
|
|
339
|
+
];
|
|
340
|
+
}
|
|
341
|
+
}
|
|
342
|
+
/**
|
|
343
|
+
* Factory function for creating DataSphereSkill instances.
|
|
344
|
+
* @param config - Optional skill configuration.
|
|
345
|
+
* @returns A new DataSphereSkill instance.
|
|
346
|
+
*/
|
|
347
|
+
export function createSkill(config) {
|
|
348
|
+
return new DataSphereSkill(config);
|
|
349
|
+
}
|
|
350
|
+
//# sourceMappingURL=datasphere.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"datasphere.js","sourceRoot":"","sources":["../../../src/skills/builtin/datasphere.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAO5C,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,MAAM,GAAG,GAAG,SAAS,CAAC,iBAAiB,CAAC,CAAC;AAEzC,MAAM,0BAA0B,GAC9B,gFAAgF;IAChF,iEAAiE,CAAC;AA8BpE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAC5C,yDAAyD;IACzD,0EAA0E;IAC1E,MAAM,CAAU,UAAU,GAAG,YAAY,CAAC;IAC1C,MAAM,CAAU,iBAAiB,GAAG,wDAAwD,CAAC;IAC7F,MAAM,CAAU,aAAa,GAAG,OAAO,CAAC;IACxC,MAAM,CAAU,iBAAiB,GAAsB,EAAE,CAAC;IAC1D,MAAM,CAAU,iBAAiB,GAAsB,EAAE,CAAC;IAC1D,MAAM,CAAU,2BAA2B,GAAG,IAAI,CAAC;IAEnD,MAAM,CAAU,kBAAkB;QAChC,OAAO;YACL,GAAG,KAAK,CAAC,kBAAkB,EAAE;YAC7B,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,gDAAgD;gBAC7D,OAAO,EAAE,kBAAkB;gBAC3B,QAAQ,EAAE,KAAK;aAChB;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,yEAAyE;gBAC3E,QAAQ,EAAE,IAAI;aACf;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,uBAAuB;gBACpC,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,uBAAuB;aACjC;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,sBAAsB;gBACnC,QAAQ,EAAE,IAAI;gBACd,MAAM,EAAE,IAAI;gBACZ,OAAO,EAAE,kBAAkB;aAC5B;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,yCAAyC;gBACtD,QAAQ,EAAE,IAAI;aACf;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,oCAAoC;gBACjD,OAAO,EAAE,CAAC;gBACV,QAAQ,EAAE,KAAK;gBACf,GAAG,EAAE,CAAC;gBACN,GAAG,EAAE,EAAE;aACR;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,iEAAiE;gBACnE,OAAO,EAAE,GAAG;gBACZ,QAAQ,EAAE,KAAK;gBACf,GAAG,EAAE,CAAC;gBACN,GAAG,EAAE,EAAE;aACR;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,+BAA+B;gBAC5C,QAAQ,EAAE,KAAK;gBACf,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;aAC1B;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,sDAAsD;gBACnE,QAAQ,EAAE,KAAK;aAChB;YACD,aAAa,EAAE;gBACb,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,yCAAyC;gBACtD,QAAQ,EAAE,KAAK;gBACf,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;aAChE;YACD,YAAY,EAAE;gBACZ,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,uDAAuD;gBACpE,QAAQ,EAAE,KAAK;gBACf,GAAG,EAAE,CAAC;gBACN,GAAG,EAAE,EAAE;aACR;YACD,kBAAkB,EAAE;gBAClB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,6CAA6C;gBAC1D,OAAO,EAAE,0BAA0B;gBACnC,QAAQ,EAAE,KAAK;aAChB;SACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACM,cAAc;QACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAS,WAAW,EAAE,kBAAkB,CAAC,CAAC;QACzE,OAAO,GAAG,IAAI,CAAC,SAAS,IAAI,QAAQ,EAAE,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACM,aAAa;QACpB,OAAO;YACL,kBAAkB,EAAE,IAAI;YACxB,WAAW,EAAE,IAAI,CAAC,SAAS,CAAqB,aAAa,EAAE,SAAS,CAAC;YACzE,kBAAkB,EAAE,uBAAuB;SAC5C,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACM,KAAK,CAAC,KAAK;QAClB,MAAM,SAAS,GACb,IAAI,CAAC,SAAS,CAAqB,YAAY,EAAE,SAAS,CAAC;YAC3D,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QAClC,MAAM,SAAS,GACb,IAAI,CAAC,SAAS,CAAqB,YAAY,EAAE,SAAS,CAAC;YAC3D,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QACvC,MAAM,KAAK,GACT,IAAI,CAAC,SAAS,CAAqB,OAAO,EAAE,SAAS,CAAC;YACtD,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QAClC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAqB,aAAa,EAAE,SAAS,CAAC,CAAC;QAChF,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,IAAI,CAAC,SAAS;YAAE,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3C,IAAI,CAAC,SAAS;YAAE,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK;YAAE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClC,IAAI,CAAC,UAAU;YAAE,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC7C,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,GAAG,CAAC,KAAK,CAAC,yCAAyC,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;YAClE,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mFAAmF;IAC3E,WAAW;QACjB,OAAO,IAAI,CAAC,SAAS,CAAS,WAAW,EAAE,kBAAkB,CAAC,CAAC;IACjE,CAAC;IAED,oFAAoF;IACpF,QAAQ;QACN,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAS,OAAO,EAAE,CAAC,CAAC,CAAC;QACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAS,UAAU,EAAE,GAAG,CAAC,CAAC;QACzD,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAqB,aAAa,EAAE,SAAS,CAAC,CAAC;QACtF,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAuB,MAAM,EAAE,SAAS,CAAC,CAAC;QACrE,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAqB,UAAU,EAAE,SAAS,CAAC,CAAC;QAC3E,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAuB,eAAe,EAAE,SAAS,CAAC,CAAC;QACrF,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAqB,cAAc,EAAE,SAAS,CAAC,CAAC;QAClF,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CACrC,oBAAoB,EACpB,0BAA0B,CAC3B,CAAC;QACF,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAEpC,OAAO;YACL;gBACE,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,qFAAqF;gBACvF,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,WAAW,EACT,+EAA+E;qBAClF;iBACF;gBACD,QAAQ,EAAE,CAAC,OAAO,CAAC;gBACnB,OAAO,EAAE,KAAK,EAAE,IAA6B,EAAE,QAAiC,EAAE,EAAE;oBAClF,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;oBAE/B,IACE,CAAC,QAAQ;wBACT,OAAO,QAAQ,KAAK,QAAQ;wBAC5B,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAC5B,CAAC;wBACD,OAAO,IAAI,cAAc,CACvB,4FAA4F,CAC7F,CAAC;oBACJ,CAAC;oBAED,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;oBAE9B,MAAM,SAAS,GACb,IAAI,CAAC,SAAS,CAAqB,YAAY,EAAE,SAAS,CAAC;wBAC3D,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;oBACvC,MAAM,KAAK,GACT,IAAI,CAAC,SAAS,CAAqB,OAAO,EAAE,SAAS,CAAC;wBACtD,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;oBAClC,MAAM,KAAK,GACT,IAAI,CAAC,SAAS,CAAqB,YAAY,EAAE,SAAS,CAAC;wBAC3D,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;oBAElC,IAAI,CAAC,SAAS,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;wBACnC,OAAO,IAAI,cAAc,CACvB,mKAAmK,CACpK,CAAC;oBACJ,CAAC;oBAED,8DAA8D;oBAC9D,qDAAqD;oBACrD,MAAM,UAAU,GAAG,gBAAgB,IAAI,EAAE,CAAC;oBAE1C,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC;oBAElE,IAAI,CAAC;wBACH,MAAM,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,iBAAiB,CAAC;wBAC1E,MAAM,GAAG,GAAG,WAAW,SAAS,kCAAkC,CAAC;wBAEnE,MAAM,WAAW,GAA4B;4BAC3C,WAAW,EAAE,UAAU;4BACvB,YAAY,EAAE,KAAK;4BACnB,KAAK;4BACL,QAAQ;yBACT,CAAC;wBAEF,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;4BACvB,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;wBAC7B,CAAC;wBACD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;4BAC3B,WAAW,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC;wBACrC,CAAC;wBACD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;4BAC9B,WAAW,CAAC,eAAe,CAAC,GAAG,WAAW,CAAC;wBAC7C,CAAC;wBACD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;4BAC9B,WAAW,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC;wBAC5C,CAAC;wBAED,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,SAAS,IAAI,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;wBAE3E,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;wBACzC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,MAAM,CAAC,CAAC;wBAC7D,IAAI,QAAkB,CAAC;wBACvB,IAAI,CAAC;4BACH,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gCAC1B,MAAM,EAAE,MAAM;gCACd,OAAO,EAAE;oCACP,cAAc,EAAE,kBAAkB;oCAClC,MAAM,EAAE,kBAAkB;oCAC1B,aAAa,EAAE,SAAS,UAAU,EAAE;iCACrC;gCACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;gCACjC,MAAM,EAAE,UAAU,CAAC,MAAM;6BAC1B,CAAC,CAAC;wBACL,CAAC;wBAAC,OAAO,GAAG,EAAE,CAAC;4BACb,YAAY,CAAC,OAAO,CAAC,CAAC;4BACtB,IAAI,GAAG,YAAY,KAAK,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gCACtD,GAAG,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;gCAChC,OAAO,IAAI,cAAc,CACvB,0DAA0D,CAC3D,CAAC;4BACJ,CAAC;4BACD,MAAM,GAAG,CAAC;wBACZ,CAAC;wBACD,YAAY,CAAC,OAAO,CAAC,CAAC;wBAEtB,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;4BACjB,GAAG,CAAC,KAAK,CAAC,sBAAsB,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;4BAC/D,OAAO,IAAI,cAAc,CACvB,iFAAiF,CAClF,CAAC;wBACJ,CAAC;wBAED,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAuB,CAAC;wBAE3D,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;4BACtC,GAAG,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;4BACxC,OAAO,IAAI,cAAc,CACvB,eAAe,CAAC,uBAAuB,CAAC,gBAAgB,EAAE,KAAK,CAAC,CACjE,CAAC;wBACJ,CAAC;wBAED,kDAAkD;wBAClD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;wBAEjC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;4BACxB,OAAO,IAAI,cAAc,CACvB,eAAe,CAAC,uBAAuB,CAAC,gBAAgB,EAAE,KAAK,CAAC,CACjE,CAAC;wBACJ,CAAC;wBAED,OAAO,IAAI,cAAc,CACvB,eAAe,CAAC,oBAAoB,CAAC,KAAK,EAAE,MAAM,CAAC,CACpD,CAAC;oBACJ,CAAC;oBAAC,OAAO,GAAG,EAAE,CAAC;wBACb,GAAG,CAAC,KAAK,CAAC,0BAA0B,EAAE;4BACpC,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;yBACxD,CAAC,CAAC;wBACH,OAAO,IAAI,cAAc,CACvB,2FAA2F,CAC5F,CAAC;oBACJ,CAAC;gBACH,CAAC;aACF;SACF,CAAC;IACJ,CAAC;IAED,6DAA6D;IACrD,MAAM,CAAC,oBAAoB,CACjC,KAAa,EACb,MAAyB;QAEzB,MAAM,MAAM,GACV,MAAM,CAAC,MAAM,KAAK,CAAC;YACjB,CAAC,CAAC,yBAAyB,KAAK,QAAQ;YACxC,CAAC,CAAC,WAAW,MAAM,CAAC,MAAM,iBAAiB,KAAK,QAAQ,CAAC;QAE7D,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,MAAM,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAEjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACxB,IAAI,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC;YAE1C,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACnC,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC;YACxB,CAAC;iBAAM,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAC7C,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC;YAC3B,CAAC;iBAAM,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC3C,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC;YACzB,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAC5C,CAAC;YAED,OAAO,IAAI,KAAK,SAAS,MAAM,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;QAED,OAAO,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,8DAA8D;IACtD,MAAM,CAAC,uBAAuB,CAAC,QAAgB,EAAE,KAAa;QACpE,OAAO,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC;YACjC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC;YACvC,CAAC,CAAC,QAAQ,CAAC;IACf,CAAC;IAED,wFAAwF;IACrE,kBAAkB;QACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACpC,OAAO;YACL;gBACE,KAAK,EAAE,6BAA6B;gBACpC,IAAI,EAAE,6DAA6D,QAAQ,QAAQ;gBACnF,OAAO,EAAE;oBACP,WAAW,QAAQ,0EAA0E;oBAC7F,+DAA+D;oBAC/D,kDAAkD;oBAClD,yEAAyE;iBAC1E;aACF;SACF,CAAC;IACJ,CAAC;;AAGH;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,MAAoB;IAC9C,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;AACrC,CAAC"}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* DataSphere Serverless Skill - Searches SignalWire DataSphere using a DataMap.
|
|
3
|
+
*
|
|
4
|
+
* Tier 3 built-in skill. Matches the Python SDK's param-driven design: all
|
|
5
|
+
* credentials (`space_name`, `project_id`, `token`) are supplied via skill
|
|
6
|
+
* params. At `setup()` time the skill resolves these params, composes the
|
|
7
|
+
* full DataSphere API URL and a base64 Basic-auth header, and bakes both as
|
|
8
|
+
* literal values into the emitted DataMap SWAIG JSON (mirrors Python
|
|
9
|
+
* `skills/datasphere_serverless/skill.py:152-157, 182-201`).
|
|
10
|
+
*/
|
|
11
|
+
import { SkillBase } from '../SkillBase.js';
|
|
12
|
+
import type { SkillToolDefinition, SkillPromptSection, SkillConfig, ParameterSchemaEntry } from '../SkillBase.js';
|
|
13
|
+
/**
|
|
14
|
+
* Searches SignalWire DataSphere using a server-side DataMap for serverless execution.
|
|
15
|
+
*
|
|
16
|
+
* Tier 3 built-in skill that generates a DataMap configuration SignalWire
|
|
17
|
+
* executes directly, without a webhook endpoint. Supports `document_id`,
|
|
18
|
+
* `count`, `distance`, `tags`, `language`, `pos_to_expand`, `max_synonyms`,
|
|
19
|
+
* and `no_results_message` config options.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* agent.addSkill('datasphere_serverless', {
|
|
24
|
+
* document_id: 'doc_abc123',
|
|
25
|
+
* count: 3,
|
|
26
|
+
* });
|
|
27
|
+
* ```
|
|
28
|
+
*/
|
|
29
|
+
export declare class DataSphereServerlessSkill extends SkillBase {
|
|
30
|
+
static SKILL_NAME: string;
|
|
31
|
+
static SKILL_DESCRIPTION: string;
|
|
32
|
+
static SKILL_VERSION: string;
|
|
33
|
+
static REQUIRED_PACKAGES: readonly string[];
|
|
34
|
+
static REQUIRED_ENV_VARS: readonly string[];
|
|
35
|
+
static SUPPORTS_MULTIPLE_INSTANCES: boolean;
|
|
36
|
+
static getParameterSchema(): Record<string, ParameterSchemaEntry>;
|
|
37
|
+
/**
|
|
38
|
+
* Instance key for the SkillManager. Defaults to
|
|
39
|
+
* `datasphere_serverless_search_knowledge`, matching the Python SDK default.
|
|
40
|
+
* When `tool_name` is set, uses `datasphere_serverless_<tool_name>`.
|
|
41
|
+
*/
|
|
42
|
+
getInstanceKey(): string;
|
|
43
|
+
/**
|
|
44
|
+
* Validate required configuration parameters before the skill becomes active.
|
|
45
|
+
*
|
|
46
|
+
* Mirrors Python's `setup()` which checks `space_name`, `project_id`, `token`,
|
|
47
|
+
* and `document_id` and returns `False` (logging an error) if any are absent.
|
|
48
|
+
* @returns `true` if all required params are present, `false` otherwise.
|
|
49
|
+
*/
|
|
50
|
+
setup(): Promise<boolean>;
|
|
51
|
+
/**
|
|
52
|
+
* Global data injected into the agent's SWML/SWAIG context. Matches
|
|
53
|
+
* Python's `get_global_data()` shape so downstream consumers can
|
|
54
|
+
* detect DataSphere availability.
|
|
55
|
+
*/
|
|
56
|
+
getGlobalData(): Record<string, unknown>;
|
|
57
|
+
/**
|
|
58
|
+
* Resolve the tool name used in DataMap registration. Defaults to
|
|
59
|
+
* `search_knowledge` to match the Python SDK default.
|
|
60
|
+
*/
|
|
61
|
+
private getToolName;
|
|
62
|
+
/**
|
|
63
|
+
* Build the DataMap-based SWAIG function definition for server-side
|
|
64
|
+
* DataSphere search. This generates a data_map configuration that
|
|
65
|
+
* SignalWire executes directly, without needing a webhook callback.
|
|
66
|
+
*/
|
|
67
|
+
private buildDataMapFunction;
|
|
68
|
+
/**
|
|
69
|
+
* Return a stub tool definition since this skill uses DataMap-based execution.
|
|
70
|
+
* The actual DataMap function is provided by getDataMapTools().
|
|
71
|
+
* @returns A single stub tool (named via `tool_name`) that explains its DataMap nature.
|
|
72
|
+
*/
|
|
73
|
+
getTools(): SkillToolDefinition[];
|
|
74
|
+
/**
|
|
75
|
+
* Get DataMap-based tool definitions for server-side execution.
|
|
76
|
+
* These are registered directly in the SWML output as data_map functions
|
|
77
|
+
* rather than as webhook-backed SWAIG tools.
|
|
78
|
+
* @returns Array containing the DataSphere search DataMap function definition.
|
|
79
|
+
*/
|
|
80
|
+
getDataMapTools(): Record<string, unknown>[];
|
|
81
|
+
/** @returns Prompt section describing serverless DataSphere search capabilities. */
|
|
82
|
+
protected _getPromptSections(): SkillPromptSection[];
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Factory function for creating DataSphereServerlessSkill instances.
|
|
86
|
+
* @param config - Optional skill configuration.
|
|
87
|
+
* @returns A new DataSphereServerlessSkill instance.
|
|
88
|
+
*/
|
|
89
|
+
export declare function createSkill(config?: SkillConfig): DataSphereServerlessSkill;
|