Class: SignalWire::Skills::Builtin::WikipediaSearchSkill

Inherits:
SkillBase
  • Object
show all
Defined in:
lib/signalwire/skills/builtin/wikipedia_search.rb

Instance Attribute Summary

Attributes inherited from SkillBase

#agent, #logger, #params, #swaig_fields

Instance Method Summary collapse

Methods inherited from SkillBase

#cleanup, #get_global_data, #get_hints, #get_param, #initialize, #instance_key, #required_env_vars, #supports_multiple_instances?, #version

Constructor Details

This class inherits a constructor from SignalWire::Skills::SkillBase

Instance Method Details

#description ⇒ Object 



15
 
# File 'lib/signalwire/skills/builtin/wikipedia_search.rb', line 15

def description; 'Search Wikipedia for information about a topic and get article summaries'; end

#get_parameter_schema ⇒ Object 



51
52
53
54
55
56
 
# File 'lib/signalwire/skills/builtin/wikipedia_search.rb', line 51

def get_parameter_schema
  {
    'num_results'      => { 'type' => 'integer', 'default' => 1, 'min' => 1, 'max' => 5 },
    'no_results_message' => { 'type' => 'string' }
  }
end

#get_prompt_sections ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/signalwire/skills/builtin/wikipedia_search.rb', line 37

def get_prompt_sections
  [
    {
      'title' => 'Wikipedia Search',
      'body' => "You can search Wikipedia for factual information using search_wiki. This will return up to #{@num_results || 1} Wikipedia article summaries.",
      'bullets' => [
        'Use search_wiki for factual, encyclopedic information',
        'Great for answering questions about people, places, concepts, and history',
        'Returns reliable, well-sourced information from Wikipedia articles'
      ]
    }
  ]
end

#name ⇒ Object 



14
 
# File 'lib/signalwire/skills/builtin/wikipedia_search.rb', line 14

def name;        'wikipedia_search'; end

#register_tools ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/signalwire/skills/builtin/wikipedia_search.rb', line 24

def register_tools
  [
    {
      name: 'search_wiki',
      description: 'Search Wikipedia for information about a topic and get article summaries',
      parameters: {
        'query' => { 'type' => 'string', 'description' => 'The search term or topic to look up on Wikipedia' }
      },
      handler: method(:handle_search)
    }
  ]
end

#setup ⇒ Object 



17
18
19
20
21
22
 
# File 'lib/signalwire/skills/builtin/wikipedia_search.rb', line 17

def setup
  @num_results    = [1, (get_param('num_results', default: 1)).to_i].max
  @no_results_msg = get_param('no_results_message',
    default: "I couldn't find any Wikipedia articles for that query. Try rephrasing your search or using different keywords.")
  true
end