Pocket Sphinx SR Task JSON Reference
| Declared in | Voiceflow.schema.json |
Overview
Speech recognition task for Pocket Sphinx to load.
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
-
taskIDpropertyThe ID of the task. User Defined. Example:
"GoForwardBackwardMeters". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is required.
-
taskTypepropertyThe type of the task. Values:
"jsgf","jsgfString","allPhone","lm","keyPhrase","kws","fsg". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is required.
-
taskFileNamepropertyFile name containing the task data. Example:
"taskFileName":"goforward.gram". Example of a dymamic task file name specified by Client at runtime:"taskFileName":"$[DynaGramName]". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
taskFileLocationpropertyURL or location of folder containing the task file. Example of a dymamic task file location specified by Client at runtime:
"taskFileLocation":"$[DynaGramLocation]". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
taskDatapropertyThe text string containing the task data. Example:
"taskData":"#JSGF V1.0;\n/\n\ngrammar goforward;\n\npublic <move> = go forward ten meters;\n\npublic <move2> = go <direction> <distance> [meter | meters];\n\n<direction> = forward | backward;\n\n<distance> = one | two | three | four | five | six | seven | eight | nine | ten;". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
taskRulepropertyThe rule name of the task to activate. Example:
"taskRule":"move". Example of a dymamic task rule specified by Client at runtime:"taskRule":"$[DynaSRTaskRule]". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
autoResolveUnknownWordspropertySpecifies whether to have Pocket Sphinx automatically resolve unknown words or words not in Pocket Sphinx dictionary. Default:
"false". The value can be set at runtime using the"autoResolveUnknownWordsRuntime"property.Parameter is optional.
-
autoResolveUnknownWordsRuntimepropertyContains 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"autoResolveUnknownWords"property. Example:"$[AutoResolveUnknownWords]".Parameter is optional.
Properties
autoResolveUnknownWords
"autoResolveUnknownWords": boolean
Discussion
Specifies whether to have Pocket Sphinx automatically resolve unknown words or words not in Pocket Sphinx dictionary. Default: "false". The value can be set at runtime using the "autoResolveUnknownWordsRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
autoResolveUnknownWordsRuntime
"autoResolveUnknownWordsRuntime": 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 "autoResolveUnknownWords" property. Example: "$[AutoResolveUnknownWords]".
Parameter is optional.
Declared In
Voiceflow.schema.json
taskData
"taskData": string
Discussion
The text string containing the task data. Example: "taskData": "#JSGF V1.0;\n/\n\ngrammar goforward;\n\npublic <move> = go forward ten meters;\n\npublic <move2> = go <direction> <distance> [meter | meters];\n\n<direction> = forward | backward;\n\n<distance> = one | two | three | four | five | six | seven | eight | nine | ten;". The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
taskFileLocation
"taskFileLocation": string
Discussion
URL or location of folder containing the task file. Example of a dymamic task file location specified by Client at runtime: "taskFileLocation": "$[DynaGramLocation]". The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
taskFileName
"taskFileName": string
Discussion
File name containing the task data. Example: "taskFileName": "goforward.gram". Example of a dymamic task file name specified by Client at runtime: "taskFileName": "$[DynaGramName]". The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
taskID
"taskID": string
Discussion
The ID of the task. User Defined. Example: "GoForwardBackwardMeters". The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is required.
Declared In
Voiceflow.schema.json
taskRule
"taskRule": string
Discussion
The rule name of the task to activate. Example: "taskRule": "move". Example of a dymamic task rule specified by Client at runtime: "taskRule": "$[DynaSRTaskRule]". The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json