/docs
wordList
Scenes To Be Used
- Phonetic evaluation
- OOV words(Generally place names, personal names, uncommon words, proper nouns, self-made words, etc. )custom it's pronunciation Note: Most OOV word evaluation engines will automatically generate pronunciation phonetic symbols according to relevant rules and models, with a correct rate of greater than 95%, and only a few words require custom pronunciation.
Request Parameters
Mark the pronunciation by adding the wordlist parameter to the kernel evaluation parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| wordlist | Array | true | |
| - word | String | true | Phonemes or words that require custom pronunciation |
| - pron | Array | true | Phoneme、Syllable separator、Stressed syllable Note: 1. Phonemes are mapped from phonetic symbols according to Phoneme Comparison Table;2.The syllable separators and stressed syllables are marked with "-" and ' respectively. en.word.score、en.word.pron kernel is supported; |
Phonetic evaluation
For example, Evaluate the phonetic symbol /e/According to Phoneme Comparison Table，We know that the phoneme of the phonetic symbol is eh
The evaluation parameters are set as follows
{
"coreType": "en.word.score",
"refText": "eh", //phoneme
"wordlist":[
{
"word":"eh", //phoneme
"pron":[["eh"]] //phoneme of the phonetic symbol
}
],
"rank": 100,
"attachAudioUrl": 1
}
Sample of returned json result Example
Customize Word Pronunciation
Taking en.word.score kernel as an example, it is divided into two cases: monosyllabic word and polyphonic word
1.Monosyllabic words
For example, customize its pronunciation for Chivox. 1).Confirm the phonetic transcription of the word Chivox ：[tʃi:vɔks]； 2).According to the phoneme comparison table, the pronunciation phoneme corresponding to the word is ：[ch iy v oh k s]；
The evaluation parameters are set as follows
{
"coreType": "en.word.score",
"refText": "Chivox", //Evaluation word
"wordlist":[
{
"word":"Chivox", //Evaluation word
"pron":[["ch","iy","v","oh","k","s"]] //Phoneme
}
],
"rank": 100,
"attachAudioUrl": 1
}
Sample of returned json result Example
2.Polyphonic word
When a word has Anglo-American or multiple pronunciations, you can set multiple pronunciations in the pron field array. For example, the word abby has two pronunciations: American pronunciation [ˈæbi] British pronunciation [ˈeibi] According to the phoneme comparison table, the corresponding phonemes are: American pronunciation [ae b] British pronunciation [ey b]
The evaluation parameters are set as follows
{
"coreType": "en.word.score",
"refText": "abby", //Evaluation word
"wordlist":[
{
"word":"abby", //Evaluation word
"pron":[["ae","b"],["ey","b"]] //The phoneme array corresponding to the two pronunciations of the word
}
],
"rank": 100,
"attachAudioUrl": 1
}
Sample of returned json result Example
The above description is based on en.word.score kernel as an example. The usage of other kernels is similar. The detailed parameter examples are as follows
en.word.pron - Examples of custom pronunciation parameters
Customize the pronunciation of the word 'dilectory' and mark it's stressed syllable
{
"coreType": "en.word.pron",
"refText": "dilectory",
"wordlist":[
{
"word":"dilectory", //The word that need to customize the pronunciation
"pron":[["d","ih","-","'l","eh","k","-","t","ax","-","r","ih"]] //Mark phonemes, syllable separators, and stressed syllables(it needs to be marked in front of the first phoneme) corresponding to the pronunciation of the word.
}
],
"rank": 100,
"attachAudioUrl": 1
}
Sample of returned json result Example
en.sent.score - Examples of custom pronunciation parameters
Customize the pronunciation of the two words Abby and Chivox
{
"coreType": "en.sent.score",
"refText": "Abby is such an important player to Chivox.", //Evaluation sentence
"wordlist":[
{
"word":"Abby", //The word that need to customize the pronunciation
"pron":[["ae","b"],["ey","b"]] //The phoneme array corresponding to the two pronunciations of the word
},
{
"word":"Chivox", //The word that need to customize the pronunciation
"pron":[["ch","iy","v","oh","k","s"]] //Word pronunciation phoneme
}
],
"rank": 100,
"attachAudioUrl": 1
}
en.sent.pron - Examples of custom pronunciation parameters
Customize the pronunciation of the two words Abby and Chivox
{
"coreType": "en.sent.pron",
"refText": "Abby is such an important player to Chivox.",
"wordlist":[
{
"word":"Abby", //The word that need to customize the pronunciation
"pron":[["ae","b"],["ey","b"]] //The phoneme array corresponding to the two pronunciations of the word
},
{
"word":"Chivox", //The word that need to customize the pronunciation
"pron":[["ch","iy","v","oh","k","s"]] //Word pronunciation phoneme
}
],
"rank": 100,
"attachAudioUrl": 1
}
en.pred.score - Examples of custom pronunciation parameters
Customize the pronunciation of the word abby
{
"coreType": "en.pred.score",
"refText": "It was Sunday. Abby never get up early on Sundays. Abby sometimes stay in bed until lunchtime. Last Sunday Abby got up very late. Abby looked out of the window. It was dark outside. ",
"wordlist":[
{
"word":"Abby", //The word that need to customize the pronunciation
"pron":[["ae","b"],["ey","b"]] //The phoneme array corresponding to the two pronunciations of the word
}
],
"rank": 100,
"attachAudioUrl": 1
}
en.choc.score - Examples of custom pronunciation parameters
Customize the pronunciation of the word Chivox
{
"coreType": "en.choc.score",
"rank": 100,
"refText":
{
"least_hit_cnt": 1,
"lm":
[
{
"answer": 1,
"text": "He works for Chivox"
},
{
"answer": 0,
"text": "Today is Friday."
},
{
"answer": 0,
"text": "It is Monday."
}
]
},
"wordlist":
[
{
"word":"Chivox", //The word that need to customize the pronunciation
"pron":[["ch","iy","v","oh","k","s"]] //Word pronunciation phoneme
}
],
"attachAudioUrl": 1
}
en.sent.recscore - Examples of custom pronunciation parameters
Customize the pronunciation of the two words Abby and Chivox
{
"coreType": "en.sent.recscore",
"refText": "Abby walks to school. | I go to school by bus. |I go to school.| He works for Chivox",
"keyWords": "go to |school | on foot # walk to | school",
"wordlist":[
{
"word":"Abby", //The word that need to customize the pronunciation
"pron":[["ae","b"],["ey","b"]] //The phoneme array corresponding to the two pronunciations of the word
},
{
"word":"Chivox", //The word that need to customize the pronunciation
"pron":[["ch","iy","v","oh","k","s"]] //Word pronunciation phoneme
}
],
"attachAudioUrl": 1
}
en.scne.exam - Examples of custom pronunciation parameters
Customize the pronunciation of the two words Abby and Chivox
{
"coreType": "en.scne.exam",
"rank": 4,
"refText": {
"lm": [
{
"text": "Chivox City Center."
},
{
"text": "Our school is in the centre of city."
},
{
"text": "In the central part."
},
{
"text": "It is in the downtown."
},
{
"text": "Yes, my school is in the center of the city."
},
{
"text": "My school is in the centre of city.",
},
{
"text": "Thank you. Abby, How many grades are there in your school?",
}
],
"wordlist":[ //Worldlist is at the same level as refText.
{
"word":"Abby", //The word that need to customize the pronunciation
"pron":[["ae","b"],["ey","b"]] //The phoneme array corresponding to the two pronunciations of the word
},
{
"word":"Chivox", //The word that need to customize the pronunciation
"pron":[["ch","iy","v","oh","k","s"]] //Word pronunciation phoneme
}
]
},
"attachAudioUrl": 1,
}
en.prtl.exam - Examples of custom pronunciation parameters
Customize the pronunciation of the two words Abby and Chivox
{
"coreType": "en.prtl.exam",
"keywords": ["learning english", "Abby", "progress", "speak"],
"tokenId": "5a0019027a9fdb6193000001",
"refText": {
"lm": [
{
"text": "Abby works for Chivox, he is not good at learning english as he is not interested in english, so he needs some suggestions. actually i think he should have conversations with his classmates in english, and had better listen to english everyday. in this way, he can gradually make a progress. Speciadd."
},
{
"text": "Abby is not good at english. he is not interested in english. and he needs some advices for learning english. i think, he should talk with his classmates in english.
he had better listen to english everyday. so that he will get a progress."
},
{
"answer": 1,
"text": "Abby is not good at english. and he isn't interested in studying english. so he needs some advice about how to learn english well. i think he can talk with classmates in english. in addition, he'd better listen to english every day. if he can follow the advice, he will make progress in english."
},
...
],
"wordlist":[ //Worldlist is at the same level as refText.
{
"word":"Abby", //The word that need to customize the pronunciation
"pron":[["ae","b"],["ey","b"]] //The phoneme array corresponding to the two pronunciations of the word
},
{
"word":"Chivox", //The word that need to customize the pronunciation
"pron":[["ch","iy","v","oh","k","s"]] //Word pronunciation phoneme
}
]
},
"rank": 100,
"attachAudioUrl": 1
}