For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • BedrockAgent
      • CLI Tools
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions
      • LiveWire
      • MCP Gateway
      • PomBuilder
      • Prefabs
      • Search
      • SkillBase
        • cleanup
        • define_tool
        • get_global_data
        • get_hints
        • get_instance_key
        • get_parameter_schema
        • get_prompt_sections
        • get_skill_data
        • register_tools
        • setup
        • update_skill_data
        • validate_env_vars
        • validate_packages
      • Skills
      • SWAIGFunction
      • SWMLBuilder
      • SWMLService
      • WebService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • Chat
      • Compat
      • Datasphere
      • Fabric
      • Imported Numbers
      • Logs
      • Lookup
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSub
      • Queues
      • Recordings
      • Registry
      • RestClient
      • Short Codes
      • SignalWireRestError
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Returns
  • Example
AgentsSkillBase

get_hints

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

get_instance_key

Next
Built with

Return speech recognition hints relevant to this skill. The agent adds these to the SWML document to improve recognition accuracy.

Override this method to provide skill-specific hints.

Returns

list[str] — Words or phrases to boost (default: empty list).

Example

1from signalwire.core.skill_base import SkillBase
2
3class WeatherSkill(SkillBase):
4 SKILL_NAME = "weather"
5 SKILL_DESCRIPTION = "Provides weather information"
6
7 def get_hints(self):
8 return ["weather", "temperature", "forecast", "humidity", "wind speed"]
9
10 def setup(self) -> bool:
11 return True
12
13 def register_tools(self):
14 pass