Class: Punchblock::Component::Input

Inherits:
ComponentNode show all
Includes:
HasHeaders
Defined in:
lib/punchblock/component/input.rb

Defined Under Namespace

Classes: Complete, Grammar, Signal

Constant Summary collapse

NLSML_NAMESPACE = 
'http://www.ietf.org/xml/ns/mrcpv2'

Instance Attribute Summary

Attributes inherited from RayoNode

#client, #connection, #original_component

Instance Method Summary collapse

Methods included from HasHeaders

#headers=, included

Methods inherited from ComponentNode

#add_event, #complete_event, #complete_event=, #initialize, #register_event_handler, #register_internal_handlers, #response=, #stop!, #stop_action, #trigger_event_handler, #write_action

Methods inherited from Punchblock::CommandNode

#initialize, #response, #response=

Methods inherited from RayoNode

#==, class_from_registration, from_xml, #inspect, register, #source, #to_rayo, #to_xml

Constructor Details

This class inherits a constructor from Punchblock::Component::ComponentNode

Instance Method Details

#grammar=(other) ⇒ Object

Parameters:

  • other (Hash)

Options Hash (other):

  • :content_type (String) —

    the document content type

  • :value (String) —

    the grammar doucment

  • :url (String) —

    the url from which to fetch the grammar



54
55
56
 
# File 'lib/punchblock/component/input.rb', line 54

def grammar=(other)
  self.grammars = [other].compact
end

#grammars=(others) ⇒ Object 



44
45
46
 
# File 'lib/punchblock/component/input.rb', line 44

def grammars=(others)
  super others.map { |other| Grammar.new(other) }
end

#inherit(xml_node) ⇒ Object 



58
59
60
61
62
 
# File 'lib/punchblock/component/input.rb', line 58

def inherit(xml_node)
  grammar_nodes = xml_node.xpath('ns:grammar', ns: self.class.registered_ns)
  self.grammars = grammar_nodes.to_a.map { |grammar_node| Grammar.from_xml(grammar_node)}
  super
end

#initial_timeout ⇒ Integer

Returns Indicates the amount of time (in milliseconds) preceding input which may expire before a timeout is triggered.

Returns:

  • (Integer) —

    Indicates the amount of time (in milliseconds) preceding input which may expire before a timeout is triggered.



35
 
# File 'lib/punchblock/component/input.rb', line 35

attribute :initial_timeout, Integer

#inter_digit_timeout ⇒ Integer

Returns Indicates (in the case of DTMF input) the amount of time (in milliseconds) between input digits which may expire before a timeout is triggered.

Returns:

  • (Integer) —

    Indicates (in the case of DTMF input) the amount of time (in milliseconds) between input digits which may expire before a timeout is triggered.



38
 
# File 'lib/punchblock/component/input.rb', line 38

attribute :inter_digit_timeout, Integer

#language ⇒ String

Returns language to use for speech recognition.

Returns:

  • (String) —

    language to use for speech recognition



26
 
# File 'lib/punchblock/component/input.rb', line 26

attribute :language, String

#max_silence ⇒ Integer

Returns the amount of time in milliseconds that an input command will wait until considered that a silence becomes a NO-MATCH.

Returns:

  • (Integer) —

    the amount of time in milliseconds that an input command will wait until considered that a silence becomes a NO-MATCH



14
 
# File 'lib/punchblock/component/input.rb', line 14

attribute :max_silence, Integer

#min_confidence ⇒ Float

Returns Confidence with which to consider a response acceptable.

Returns:

  • (Float) —

    Confidence with which to consider a response acceptable



17
 
# File 'lib/punchblock/component/input.rb', line 17

attribute :min_confidence, Float

#mode ⇒ Symbol

Returns mode by which to accept input. Can be :voice, :dtmf or :any.

Returns:

  • (Symbol) —

    mode by which to accept input. Can be :voice, :dtmf or :any



20
 
# File 'lib/punchblock/component/input.rb', line 20

attribute :mode, Symbol, default: :dtmf

#rayo_attributes ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/punchblock/component/input.rb', line 64

def rayo_attributes
  {
    'max-silence' => max_silence,
    'min-confidence' => min_confidence,
    'mode' => mode,
    'recognizer' => recognizer,
    'language' => language,
    'terminator' => terminator,
    'sensitivity' => sensitivity,
    'initial-timeout' => initial_timeout,
    'inter-digit-timeout' => inter_digit_timeout,
    'recognition-timeout' => recognition_timeout
  }
end

#rayo_children(root) ⇒ Object 



79
80
81
82
83
84
 
# File 'lib/punchblock/component/input.rb', line 79

def rayo_children(root)
  grammars.each do |grammar|
    grammar.to_rayo(root)
  end
  super
end

#recognition_timeout ⇒ Integer

Returns Indicates the amount of time during input that recognition will occur before a timeout is triggered.

Returns:

  • (Integer) —

    Indicates the amount of time during input that recognition will occur before a timeout is triggered.



41
 
# File 'lib/punchblock/component/input.rb', line 41

attribute :recognition_timeout, Integer

#recognizer ⇒ String

Returns recognizer to use for speech recognition.

Returns:

  • (String) —

    recognizer to use for speech recognition



23
 
# File 'lib/punchblock/component/input.rb', line 23

attribute :recognizer, String

#sensitivity ⇒ Float

Returns Indicates how sensitive the interpreter should be to loud versus quiet input. Higher values represent greater sensitivity.

Returns:

  • (Float) —

    Indicates how sensitive the interpreter should be to loud versus quiet input. Higher values represent greater sensitivity.



32
 
# File 'lib/punchblock/component/input.rb', line 32

attribute :sensitivity, Float

#terminator ⇒ String

Returns terminator by which to signal the end of input.

Returns:

  • (String) —

    terminator by which to signal the end of input



29
 
# File 'lib/punchblock/component/input.rb', line 29

attribute :terminator, String