Many IDOL Speech Server tasks require you to send an action that includes a list of words or files. For example, the LanguageModelBuild
task requires a list of training text files. IDOL Speech Server has a list manager that allows you to easily create and manage lists.
Note: You can also create a list in a text file on a drive that the server can access, instead of using the list manager.
You first create a list in the list manager, and then populate it by sending each list entry as a separate action. You can delete individual entries or the entire list.
To create a list
Send the AddList
action to IDOL Speech Server, and set the following parameter:
Key
|
The list name. The name must consist only of characters included in the Portable Character Set. |
IDOL Speech Server creates a new list with the specified key.
For example:
http://localhost:13000/action=AddList&Key=TrainingText
This action uses port 13000
to instruct IDOL Speech Server, which is located on the local machine, to create a new list called TrainingText
.
To add a list entry
Send the AddListLine
action to IDOL Speech Server, and set the following parameters:
Key
|
The list name. |
Line
|
The list entry to add. |
IDOL Speech Server adds the list entry to the list with the specified key.
For example:
http://localhost:13000/action=AddListLine&Key=TrainingText&Line=T:\Data\testFile.txt
This action uses port 13000
to instruct IDOL Speech Server, which is located on the local machine, to add the entry T:\Data\testFile.txt
to the TrainingText
list.
To delete a list entry
Send the DelListLine
action to IDOL Speech Server, and set the following parameters:
Key
|
The list name. |
Line
|
The list entry to delete. |
Once (optional) |
Set to True to delete all instances of the entry in the list. |
IDOL Speech Server returns the NbLines
tag that contains the number of lines that IDOL Speech Server has deleted.
For example:
http://localhost:13000/action=DelListLine&Key=TrainingText&Line=T:\Data\testFile.txt&Once=True
This action uses port 13000
to instruct IDOL Speech Server, which is located on the local machine, to delete the entry T:\Data\testFile.txt
wherever it appears in the TrainingText
list.
To delete a list
Send the DelList
action to IDOL Speech Server, and set the following parameter:
Key
|
The list name. |
IDOL Speech Server deletes the list, unless the list is being used by a task. If the list is in use, IDOL Speech Server returns the message Resource key is busy
.
For example:
http://localhost:13000/action=DelList&Key=TrainingText
This action uses port 13000
to instruct IDOL Speech Server, which is located on the local machine, to delete the TrainingText
list.
You can view the names of the lists in the list manager, or view the entire contents of an individual list.
To view all lists
Send the ShowAllLists
action to IDOL Speech Server.
IDOL Speech Server returns the names of all lists.
For example:
http://localhost:13000/action=ShowAllLists
This action uses port 13000
to instruct IDOL Speech Server, which is located on the local machine, to display the names of all lists in the list manager.
To view the contents of a list
Send the ShowList
action to IDOL Speech Server, and set the following parameter:
Key
|
The list name. |
IDOL Speech Server returns all entries in the list.
For example:
http://localhost:13000/action=ShowList&Key=TrainingText
This action uses port 13000
to instruct IDOL Speech Server, which is located on the local machine, to display all entries in the TrainingText
list.
After you create and populate your lists, you can use them in IDOL Speech Server actions by setting the relevant parameter to ListManager/Key
, where Key
is the name of the list.
For example:
http://localhost:13000/action=AddTask&Type=AudioSecurity&File=C:\data\Sample.wav
&Out=SampleSec.ctm&TemplateList=ListManager/alarmTemplates
The AudioSecurity
task requires a list of alarm templates to identify the alarms that it detects. The TemplateList
parameter specifies the alarmTemplates
list in the list manager.
|