Apple SR Session Params JSON Reference
| Declared in | Voiceflow.schema.json |
Overview
Specifies the speech recognition parameters for the Apple 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.
Tasks
-
taskIDpropertyAn ID assigned to the speech recognition task. User defined. The value can be set at runtime using
"$[<FieldName>]"entry convention.Parameter is optional.
-
taskHintpropertyA 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.
-
enablePartialResultspropertySpecifies 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.
-
enablePartialResultsRuntimepropertyContains 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.
-
onDeviceSRpropertySpecifies whether a speech recognition request must keep its audio data on the device, however, on-device requests won’t be as accurate (from Apple developer documentation). Default:
"false". The value can be set at runtime using the"onDeviceSRRuntime"property.Parameter is optional.
-
onDeviceSRRuntimepropertyContains 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.
-
nBestCountpropertyNot implemented. Not supported by Apple speech recognizer. The value can be set at runtime using the
"nBestCountRuntime"property.Parameter is optional.
-
nBestCountRuntimepropertyNot implemented. Contains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"nBestCount"property. Example:"$[NBestCount]".Parameter is optional.
-
loadContextualPhrasespropertyNot implemented. Until implementation, Apple SR will load contextual phrases from
"contextualPhrasesFileName"if property is configured. The value can be set at runtime using the"loadContextualPhrasesRuntime"property.Parameter is optional.
-
loadContextualPhrasesRuntimepropertyNot implemented. 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"loadContextualPhrases"property. Example:"$[LoadContextualPhrases]".Parameter is optional.
-
contextualPhrasesListpropertyNot implemented. Until implementation, Apple SR will load contextual phrases from
"contextualPhrasesFileName"if property is configured. Specifies an array of phrases that should be recognized, even if they are not in the system vocabulary (from Apple developer documentation).Parameter is optional.
-
contextualPhrasesFileNamepropertyFile name that contains the list of contextual phrases for Apple SR. The value can be set at runtime using
"$[<FieldName>]"entry convention.Parameter is optional.
-
contextualPhrasesFileLocationpropertyURL or location of folder where
"contextualPhrasesFileName"is located. The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
Properties
contextualPhrasesFileLocation
"contextualPhrasesFileLocation": string
Discussion
URL or location of folder where "contextualPhrasesFileName" is located. The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
contextualPhrasesFileName
"contextualPhrasesFileName": string
Discussion
File name that contains the list of contextual phrases for Apple SR. The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
contextualPhrasesList
"contextualPhrasesList": array - [string]
Discussion
Not implemented. Until implementation, Apple SR will load contextual phrases from "contextualPhrasesFileName" if property is configured. Specifies an array of phrases that should be recognized, even if they are not in the system vocabulary (from Apple developer documentation).
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
loadContextualPhrases
"loadContextualPhrases": boolean
Discussion
Not implemented. Until implementation, Apple SR will load contextual phrases from "contextualPhrasesFileName" if property is configured. The value can be set at runtime using the "loadContextualPhrasesRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
loadContextualPhrasesRuntime
"loadContextualPhrasesRuntime": string
Discussion
Not implemented. 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 "loadContextualPhrases" property. Example: "$[LoadContextualPhrases]".
Parameter is optional.
Declared In
Voiceflow.schema.json
nBestCount
"nBestCount": integer
Discussion
Not implemented. Not supported by Apple speech recognizer. The value can be set at runtime using the "nBestCountRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
nBestCountRuntime
"nBestCountRuntime": string
Discussion
Not implemented. Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "nBestCount" property. Example: "$[NBestCount]".
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, however, on-device requests won’t be as accurate (from Apple developer documentation). 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