Skip to main content
Skip table of contents

VSDK 7 Complete Configuration Document

Field

Description/Notes

Optional

Default Value

Type

Possible Values

version

Version of the whole document

String

2.0

csdk

Object

csdk/paths

Object

csdk/paths/cache

Absolute or relative to vsdk.json

cache

Path

csdk/paths/data_root

Absolute or relative to vsdk.json

.

Path

csdk/paths/acmod

Absolute or relative to data_root

acmod

Path

csdk/paths/asr

Absolute or relative to data_root

asr

Path

csdk/paths/clc

Absolute or relative to data_root

clc

Path

csdk/paths/clc_ruleset

Absolute or relative to data_root

clc

Path

csdk/paths/dictionary

Absolute or relative to data_root

dictionaries

Path

csdk/paths/search

Absolute or relative to data_root

ctx

Path

csdk/paths/sem3

Absolute or relative to data_root

ctx

Path

csdk/paths/users

Absolute or relative to data_root

users

Path

csdk/paths/audio_based_classifier_model

Absolute or relative to data_root

abc

Path

csdk/paths/confusion_dictionary

Absolute or relative to data_root

dictionaries

Path

csdk/paths/language_model

Absolute or relative to data_root

lm

Path

csdk/tts

Object

csdk/tts/channels

Object

csdk/tts/channels/<channel_name_1>

Name of the channel, used in code

String

csdk/tts/channels/<channel_name_1>/voices

Array

csdk/tts/channels/<channel_name_1>/voices/0

String

<speaker>,<lang>,<quality>

csdk/asr

Object

csdk/asr/recognizers

Object

csdk/asr/recognizers/<recognizer_name_1>

Name of the recognizer, used in code

String

csdk/asr/recognizers/<recognizer_name_1>/acmods

Recognizers accept multiple acoustic models

Array

csdk/asr/recognizers/<recognizer_name_1>/acmods/0

String

csdk/asr/models

Object

csdk/asr/models/<model_name_1>

Name of the model, used in code

String

csdk/asr/models/<model_name_1>/type

String

static, dynamic, free- speech

csdk/asr/models/<model_name_1>/file

Compiled model file name, extension is .fcf

File

csdk/asr/models/<model_name_1>/sem3

Compiled semantic model file name, extension is .s3c

""

String

csdk/asr/models/<model_name_1>/settings

Object

csdk/asr/models/<model_name_1>/settings/LH_SEARCH_PARAM_STREAM_RESULT_MODE

The mode in which intermediate results are displayed during recognition. 1 means partial result are activated

0

Int

0, 1

csdk/asr/models/<model_name_1>/settings/LH_SEARCH_PARAM_ACCURACY

Trade-off between CPU- load, memory requirements and the obtained accuracy of the search

10000

Int

[100 ; 50000]

csdk/asr/models/<model_name_1>/settings/LH_SEARCH_PARAM_MAXNBEST

Maximum number of hypotheses returned in a result

3

Int

[1 ; 1000]

csdk/asr/models/<model_name_1>/settings/LH_SEARCH_PARAM_TSILENCE

Minimum amount of trailing silence, in milliseconds. Use a higher value for non- WUW models

100

Int

[100 ; 10000]

csdk/asr/models/<model_name_1>/settings/LH_SEARCH_PARAM_IG_LOWCONF

Maximum amount of confidence level that indicates that a spoken utterance is out of grammar

5000

Int

[0 ; 10000]

csdk/asr/models/<model_name_1>/settings/LH_SEARCH_PARAM_IG_HIGHCONF

Minimum amount of confidence level that indicates that a spoken utterance is in grammar

5000

Int

[0 ; 10000]

csdk/asr/models/<model_name_1>/settings/LH_SEARCH_PARAM_INITBEAMWIDTH

Init beam width. This parameter affects low- level behavior of the algorithm

2500

Int

[0 ; 10000]

csdk/asr/models/<model_name_1>/settings/LH_SEARCH_PARAM_TANYSPEECH

Allows the recognizer to stop the recognition process during the trailing AnySpeech state

LH_FALSE

String

LH_TRUE, LH_FALSE

csdk/asr/models/<model_name_1>/settings/LH_SEARCH_PARAM_NBESTRESULT_SETHIDDENKEYS

When enabled additional information is included on the ASR result that can be used for the FM use case

LH_FALSE

String

LH_TRUE, LH_FALSE

csdk/asr/models/<model_name_1>/settings/LH_SEARCH_PARAM_ONDEMANDLOADING

Context on-demand loading

LH_FALSE

Int

LH_TRUE, LH_FALSE

csdk/asr/models/<model_name_1>/settings/LH_SEARCH_PARAM_SPEECH_TIMEOUT

Speech duration timeout in milliseconds

0

Int

0, [100 ; 60000]

csdk/asr/models/<model_name_1>/acmod

∗Only for dynamic models. Must match with the one configured on the recognizer that will apply this model

✘∗

String

csdk/asr/models/<model_name_1>/slots

∗Only for dynamic models.

✘∗

Object

csdk/asr/models/<model_name_1>/slots/<slot_name_1>

Name of the slot, used in the code

Object

csdk/asr/models/<model_name_1>/slots/<slot_name_1>/slot

Grammar name is marked after !grammar and slot name is after

!slot in your BNF grammar

String

<grammar-name>#<slot-name>

csdk/asr/models/<model_name_1>/slots/<slot_name_1>/category

normal

String

normal, name, artist

csdk/asr/models/<model_name_1>/slots/<slot_name_1>/allow_custom_phonetic

Setting to true will allow for custom phonetic to be provided for this slot

false

Bool

csdk/asr/models/<model_name_1>/lexicon

∗Only for dynamic models.

✘∗

String

csdk/asr/models/<model_name_1>/lexicon/clc

Used during runtime compilation. Use a language that match the rest of the grammar and the recognizer this model will be applied on

File

csdk/asr/models/<model_name_1>/lexicon/settings

Object

csdk/asr/models/<model_name_1>/extra_models

∗Only for free-speech models. All models for a given language must be listed or the program won't function properly

✘∗

Object

csdk/asr/models/<model_name_1>/extra_models/<name>

File

tnl

Object

tnl/paths

Object

tnl/paths/cache

Absolute or relative to vsdk.json

cache

Path

tnl/paths/models

Absolute or relative to vsdk.json

.

Path

tnl/asr

Object

tnl/asr/recognizers

String

tnl/asr/recognizers/<recognizer_name_1>

Name of the recognizer, used in the code

String

tnl/asr/recognizers/<recognizer_name_1>/audio_buffer_size_seconds

In seconds, so multiply by 16000 to get the actual memory space allocated

10

Int

> 0

tnl/asr/models

Object

tnl/asr/models/<model_name_1>

Name of the model, used in the code

Object

tnl/asr/models/<model_name_1>/type

String

static, dynamic

tnl/asr/models/<model_name_1>/file

Compiled model file name, extension is .snsr

File

tnl/asr/models/<model_name_1>/slots

∗Only for dynamic models

✘∗

Object

tnl/asr/models/<model_name_1>/slots/<slot_name_1>

Name of the slot, used in the code

Object

tnl/asr/concurrent_model

∗Only needed if you want to callRecognizer::setModels().

File name of a concurrent template model, extension is .snsr

✔∗

File

vasr

Object

vasr/paths

Object

vasr/paths/data_root

Absolute or relative to vsdk.json

.

Path

vasr/paths/models

Absolute or relative to data_root

models

Path

vasr/paths/g2p

Absolute or relative to data_root

g2p

Path

vasr/asr

Object

vasr/asr/recognizers

Object

vasr/asr/recognizers/<recognizer_name_1>

Name of the recognizer, used in the code

String

vasr/asr/models

Object

vasr/asr/models/<model_name_1>

Name of the model, used in the code

String

vasr/asr/models/<model_name_1>/type

String

static, dynamic

vasr/asr/models/<model_name_1>/dir

Absolute or relative to paths/models

Path

vasr/asr/models/<model_name_1>/grammar

∗Only for dynamic models. Absolute or relative to dir, extension is .bnf

✘∗

File

vasr/asr/models/<model_name_1>/lang

∗Only for dynamic models. Used during g2p model search, like so: g2p/model.fst or g2p/<lang>/model.fst

✘∗

String

eng-US, fra-FR

vasr/asr/models/<model_name_1>/g2p

∗Only for dynamic models. Absolute or relative to paths/g2p

✔∗

.

Path

vasr/asr/models/<model_name_1>/slots

∗Only for dynamic models.

✘∗

Object

vasr/asr/models/<model_name_1>/slots/<slot_name_1>

Name of the slot, used in the code

Object

baratinoo

Object

baratinoo/paths

Object

baratinoo/paths/data_root

Absolute or relative to vsdk.json

Path

baratinoo/tts

Object

baratinoo/tts/channels

Object

baratinoo/tts/channels/<channel_name_1>

Object

baratinoo/tts/channels/<channel_name_1>/voices

Array

baratinoo/tts/channels/<channel_name_1>/voices/0

String

<speaker>

vtapi

Object

vtapi/paths

Object

vtapi/paths/data_root

Absolute or relative to vsdk.json

Path

vtapi/tts

Object

vtapi/tts/channels

Object

vtapi/tts/channels/<channel_name_1>

Object

vtapi/tts/channels/<channel_name_1>/voices

Array

vtapi/tts/channels/<channel_name_1>/voices/0

String

<speaker>,<quality>

tssv

Object

tssv/biometrics

Object

tssv/biometrics/generated_models_path

Absolute or relative to the program's working directory

Path

tssv/biometrics/background_model_TD

Absolute or relative to the program's working directory

File

tssv/biometrics/background_model_TI

Absolute or relative to the program's working directory

File

idvoice

Object

idvoice/biometrics

Object

idvoice/biometrics/generated_models_path

Absolute or relative to the program's working directory

Path

idvoice/biometrics/background_model_TD

Absolute or relative to the program's working directory

File

idvoice/biometrics/background_model_TI

Absolute or relative to the program's working directory

File

vafe

Object

vafe/afe

Object

vafe/afe/analyzers

Object

vafe/afe/analyzers/<name_1>

Object

vafe/afe/analyzers/<name_1>/type

String

snr, rt60, mos

vafe/afe/analyzers/<name_1>/bitspersample

∗Only for rt60

analyzers.

✘∗

Int

Power of 2, [16 ; 1024]

vafe/afe/analyzers/<name_1>/model

∗Only for mos analyzers. Absolute path to the mos configuration file, extension is .json

✘∗

Path

vafe/afe/filters

Object

vafe/afe/filters/<name_1>

Object

vafe/afe/filters/<name_1>/type

String

bandpass, lowpass, highpass

vafe/afe/filters/<name_1>/lowfrequency

∗Only for bandpass filters.

✘∗

Int

[1 ; 16000]

vafe/afe/filters/<name_1>/highfrequency

∗Only for bandpass filters.

✘∗

Int

[1 ; 16000]

vafe/afe/filters/<name_1>/frequency

∗Only for lowpass and highpass filters.

✘∗

Int

[1 ; 16000]

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.