Skip to content

Latest commit

 

History

History
42 lines (36 loc) · 3.85 KB

GetSpeech.md

File metadata and controls

42 lines (36 loc) · 3.85 KB

Freeclimb::GetSpeech

Properties

Name Type Description Notes
action_url String When the caller has finished speaking or the command has timed out, FreeClimb will make a POST request to this URL. A PerCL response is expected to continue handling the call.
grammar_type GrammarType [optional]
grammar_file String The grammar file to use for speech recognition. If grammarType is set to URL, this attribute is specified as a download URL.
grammar_rule String The grammar rule within the specified grammar file to use for speech recognition. This attribute is optional if `grammarType` is `URL` and ignored if `grammarType` is `BUILTIN`. [optional]
play_beep Boolean Indicates whether a beep should be played just before speech recognition is initiated so that the speaker can start to speak. [optional]
prompts Array<PerclCommand> The JSON array of PerCL commands to nest within the `GetSpeech` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the caller. This allows for playing menu options to the caller and to prompt for the expected input. These commands stop executing when the caller begins to input speech. [optional]
no_input_timeout_ms Integer When recognition is started and there is no speech detected for `noInputTimeoutMs` milliseconds, the recognizer will terminate the recognition operation. [optional]
recognition_timeout_ms Integer When playback of prompts ends and there is no match for `recognitionTimeoutMs` milliseconds, the recognizer will terminate the recognition operation. [optional]
confidence_threshold Float When a recognition resource recognizes a spoken phrase, it associates a confidence level with that match. Parameter `confidenceThreshold` specifies what confidence level is considered a successful match. Values are between 0.0 and 1.0. [optional]
sensitivity_level Float The speech recognizer supports a variable level of sound sensitivity. The sensitivityLevel attribute allows for filtering out background noise, so it is not mistaken for speech. Values are between 0.0 and 1.0 [optional]
speech_complete_timeout_ms Integer Parameter `speechCompleteTimeoutMs` specifies the length of silence required following user speech before the speech recognizer finalizes a result. This timeout applies when the recognizer currently has a complete match against an active grammar. Reasonable speech complete timeout values are typically in the range of 0.3 seconds to 1.0 seconds. [optional]
speech_incomplete_timeout_ms Integer Parameter `speechIncompleteTimeoutMs` specifies the length of silence following user speech after which a recognizer finalizes a result. This timeout applies when the speech prior to the silence is an incomplete match of all active grammars. Timeout `speechIncompleteTimeoutMs` is usually longer than `speechCompleteTimeoutMs` to allow users to pause mid-utterance. [optional]
privacy_mode Boolean Parameter privacyMode will not log the `text` as required by PCI compliance. [optional]

Example

require 'freeclimb'

instance = Freeclimb::GetSpeech.new(
  action_url: null,
  grammar_type: null,
  grammar_file: null,
  grammar_rule: null,
  play_beep: null,
  prompts: null,
  no_input_timeout_ms: null,
  recognition_timeout_ms: null,
  confidence_threshold: null,
  sensitivity_level: null,
  speech_complete_timeout_ms: null,
  speech_incomplete_timeout_ms: null,
  privacy_mode: null
)