srSessionParams JSON Reference
| Declared in | Voiceflow.schema.json |
Overview
Specifies the speech recognition parameters for the speech recognition session.
Note: Unless stated otherwise, value of properties that are of type "string" can be updated at runtime by an application if their value is entered as a field name wrapped by "$[" and "]". If a property is of a type other than "string", then an additional property of type "string" with the same property name appended with the string "Runtime" is added to have its value entered as a field name wrapped by "$[" and "]". This allows the application to set the value of the field name at runtime to be the value of the original non-runtime property. Valid values of runtime fields override the values of non-runtime properties.
Properties
-
taskIDjson parameterAn ID assigned to the speech recognition task. User defined. The value can be set at runtime using
"$[<FieldName>]"entry convention.Parameter is optional.
-
taskHintjson parameterA value that indicates the type of speech recognition being performed (from Apple developer documentation) Values:
"dictation","search","confirmation"or"unspecified". Default:"unspecified". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
enablePartialResultsjson parameterSpecifies whether intermediate results are returned for each utterance (from Apple developer documentation). Default:
"false". The value can be set at runtime using the"enablePartialResultsRuntime"property.Parameter is optional.
-
enablePartialResultsRuntimejson parameterContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"enablePartialResults"property. Example:"$[EnablePartialResults]".Parameter is optional.
-
autoPunctuatejson parameterSpecifies whether or not to have the speech recognizer automatically punctaute the recognized text. Default:
"false". The value can be set at runtime using the"autoPunctuateRuntime"property.Parameter is optional.
-
autoPunctuateRuntimejson parameterContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"autoPunctuate"property. Example:"$[AutoPunctuate]".Parameter is optional.
-
onDeviceSRjson parameterSpecifies whether a speech recognition request must keep its audio data on the device instead of using the cloud. On device speech recognition may be less accurate than speech recognition that uses the cloud. Default:
"false". The value can be set at runtime using the"onDeviceSRRuntime"property.Parameter is optional.
-
onDeviceSRRuntimejson parameterContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"onDeviceSR"property. Example:"$[OnDeviceSR]".Parameter is optional.
-
contextualStringsDictionaryjson parameterSpecifies custom contextual string dictionaries to be sent to speech recognizer for more accurate speech recognition.
Parameter is optional.
JSON Parameters
autoPunctuate
"autoPunctuate": boolean
Discussion
Specifies whether or not to have the speech recognizer automatically punctaute the recognized text. Default: "false". The value can be set at runtime using the "autoPunctuateRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
autoPunctuateRuntime
"autoPunctuateRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "autoPunctuate" property. Example: "$[AutoPunctuate]".
Parameter is optional.
Declared In
Voiceflow.schema.json
contextualStringsDictionary
"contextualStringsDictionary": object - contextualStringsDictionary
Discussion
Specifies custom contextual string dictionaries to be sent to speech recognizer for more accurate speech recognition.
Parameter is optional.
Declared In
Voiceflow.schema.json
enablePartialResults
"enablePartialResults": boolean
Discussion
Specifies whether intermediate results are returned for each utterance (from Apple developer documentation). Default: "false". The value can be set at runtime using the "enablePartialResultsRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
enablePartialResultsRuntime
"enablePartialResultsRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "enablePartialResults" property. Example: "$[EnablePartialResults]".
Parameter is optional.
Declared In
Voiceflow.schema.json
onDeviceSR
"onDeviceSR": boolean
Discussion
Specifies whether a speech recognition request must keep its audio data on the device instead of using the cloud. On device speech recognition may be less accurate than speech recognition that uses the cloud. Default: "false". The value can be set at runtime using the "onDeviceSRRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
onDeviceSRRuntime
"onDeviceSRRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "onDeviceSR" property. Example: "$[OnDeviceSR]".
Parameter is optional.
Declared In
Voiceflow.schema.json
taskHint
"taskHint": string
Discussion
A value that indicates the type of speech recognition being performed (from Apple developer documentation) Values: "dictation", "search", "confirmation" or "unspecified". Default: "unspecified". The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json