Public Member Functions | Public Attributes | Static Public Attributes | Private Member Functions | List of all members
mycroft.skills.core.FallbackSkill Class Reference
Inheritance diagram for mycroft.skills.core.FallbackSkill:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, name=None, bus=None, use_settings=True)
 
def default_shutdown (self)
 
def make_intent_failure_handler (cls, bus)
 
def register_fallback (self, handler, priority)
 
def remove_fallback (cls, handler_to_del)
 
def remove_instance_handlers (self)
 
- Public Member Functions inherited from mycroft.skills.core.MycroftSkill
def __init__ (self, name=None, bus=None, use_settings=True)
 
def acknowledge (self)
 
def add_event (self, name, handler, handler_info=None, once=False)
 
def ask_yesno (self, prompt, data=None)
 
def bind (self, bus)
 
def bus (self)
 
def cancel_all_repeating_events (self)
 
def cancel_scheduled_event (self, name)
 
def config (self)
 
def converse (self, utterances, lang=None)
 
def default_shutdown (self)
 
def detach (self)
 
def disable_intent (self, intent_name)
 
def enable_intent (self, intent_name)
 
def enclosure (self)
 
def find_resource (self, res_name, res_dirname=None)
 
def get_intro_message (self)
 
def get_response (self, dialog='', data=None, validator=None, on_fail=None, num_retries=-1)
 
def get_scheduled_event_status (self, name)
 
def handle_disable_intent (self, message)
 
def handle_enable_intent (self, message)
 
def handle_remove_cross_context (self, message)
 
def handle_set_cross_context (self, message)
 
def init_dialog (self, root_directory)
 
def initialize (self)
 
def lang (self)
 
def load_data_files (self, root_directory)
 
def load_regex_files (self, root_directory)
 
def load_vocab_files (self, root_directory)
 
def location (self)
 
def location_pretty (self)
 
def location_timezone (self)
 
def make_active (self)
 
def register_entity_file (self, entity_file)
 
def register_intent (self, intent_parser, handler)
 
def register_intent_file (self, intent_file, handler)
 
def register_regex (self, regex_str)
 
def register_resting_screen (self)
 
def register_vocabulary (self, entity, entity_type)
 
def remove_context (self, context)
 
def remove_cross_skill_context (self, context)
 
def remove_event (self, name)
 
def report_metric (self, name, data)
 
def schedule_event (self, handler, when, data=None, name=None)
 
def schedule_repeating_event (self, handler, when, frequency, data=None, name=None)
 
def send_email (self, title, body)
 
def set_context (self, context, word='', origin=None)
 
def set_cross_skill_context (self, context, word='')
 
def shutdown (self)
 
def speak (self, utterance, expect_response=False, wait=False)
 
def speak_dialog (self, key, data=None, expect_response=False, wait=False)
 
def stop (self)
 
def translate (self, text, data=None)
 
def translate_list (self, list_name, data=None)
 
def translate_namedvalues (self, name, delim=None)
 
def translate_template (self, template_name, data=None)
 
def update_scheduled_event (self, name, data=None)
 
def voc_match (self, utt, voc_filename, lang=None)
 

Public Attributes

 instance_fallback_handlers
 
- Public Attributes inherited from mycroft.skills.core.MycroftSkill
 config_core
 
 converse
 
 dialog_renderer
 
 events
 
 file_system
 
 gui
 
 log
 
 name
 
 registered_intents
 
 reload_skill
 
 resting_name
 
 root_dir
 
 scheduled_repeats
 
 settings
 
 skill_id
 
 voc_match_cache
 

Static Public Attributes

dictionary fallback_handlers = {}
 

Private Member Functions

def _register_fallback (cls, handler, priority)
 

Detailed Description

    Fallbacks come into play when no skill matches an Adapt or closely with
    a Padatious intent.  All Fallback skills work together to give them a
    view of the user's utterance.  Fallback handlers are called in an order
    determined the priority provided when the the handler is registered.

    ========   ========   ================================================
    Priority   Who?       Purpose
    ========   ========   ================================================
       1-4     RESERVED   Unused for now, slot for pre-Padatious if needed
         5     MYCROFT    Padatious near match (conf > 0.8)
      6-88     USER       General
        89     MYCROFT    Padatious loose match (conf > 0.5)
     90-99     USER       Uncaught intents
       100+    MYCROFT    Fallback Unknown or other future use
    ========   ========   ================================================

    Handlers with the numerically lowest priority are invoked first.
    Multiple fallbacks can exist at the same priority, but no order is
    guaranteed.

    A Fallback can either observe or consume an utterance. A consumed
    utterance will not be see by any other Fallback handlers.

Definition at line 1703 of file core.py.

Constructor & Destructor Documentation

def mycroft.skills.core.FallbackSkill.__init__ (   self,
  name = None,
  bus = None,
  use_settings = True 
)

Definition at line 1730 of file core.py.

Member Function Documentation

def mycroft.skills.core.FallbackSkill._register_fallback (   cls,
  handler,
  priority 
)
private
Register a function to be called as a general info fallback
Fallback should receive message and return
a boolean (True if succeeded or False if failed)

Lower priority gets run first
0 for high priority 100 for low priority

Definition at line 1779 of file core.py.

def mycroft.skills.core.FallbackSkill.default_shutdown (   self)
    Remove all registered handlers and perform skill shutdown.

Definition at line 1830 of file core.py.

def mycroft.skills.core.FallbackSkill.make_intent_failure_handler (   cls,
  bus 
)
Goes through all fallback handlers until one returns True

Definition at line 1737 of file core.py.

def mycroft.skills.core.FallbackSkill.register_fallback (   self,
  handler,
  priority 
)
    register a fallback with the list of fallback handlers
    and with the list of handlers registered by this instance

Definition at line 1793 of file core.py.

def mycroft.skills.core.FallbackSkill.remove_fallback (   cls,
  handler_to_del 
)
    Remove a fallback handler

    Args:
handler_to_del: reference to handler

Definition at line 1809 of file core.py.

def mycroft.skills.core.FallbackSkill.remove_instance_handlers (   self)
    Remove all fallback handlers registered by the fallback skill.

Definition at line 1822 of file core.py.

Member Data Documentation

dictionary mycroft.skills.core.FallbackSkill.fallback_handlers = {}
static

Definition at line 1728 of file core.py.

mycroft.skills.core.FallbackSkill.instance_fallback_handlers

Definition at line 1734 of file core.py.


The documentation for this class was generated from the following file:


mycroft_ros
Author(s):
autogenerated on Mon Apr 26 2021 02:35:40