The ITSLanguage API 3.1.0 documentation

The ITSLanguage API 3.1.0

Websocket server providing various speech related services.

#ASR

Servers

api.itslanguage.nlwssITSLanguage API
staging.itslanguage.nlwssITSLanguage Staging API

Operations

PUB /recording
Save a recording with no additional processing.

Operation IDrecording
Accepts one of the following messages:
- #0start_recording
  Start a recording.
  Start a recording.
  
  object
  uid: start_recording
  text
  string
  Required for /prompt
  
  language
  string
  Required for /prompt and /asr only nld, eng, de`.
  
  age_group
  string
  Optional for /prompt only adult (default) or child.
  
  prompt_id
  number
  Optional for /prompt only.
  
  text_index
  number
  Optional for /prompt only. Resume the text from a certain index, if not supplied will start from the beginning of the text (0).
  
  asr
  any
  Optional for /asr only Choose the asr type. fast (default) or good.
  
  Additional properties are allowed.
  Examples
  { "text": "string", "language": "string", "age_group": "string", "prompt_id": 0, "text_index": 0, "asr": null }
  
  This example has been generated automatically.
- #1write_recording
  Write audio to a recording.
  Send WAV data to the recording.
  
  object
  uid: write_recording
  16-bit signed integer PCM WAV data. Minimal sample rate 16khz higher frequencies are downsampled, higher frequencies are still preferred as the quality can be higher. Stereo will be downsampled to mono.
  
  required
  array<any>
  Additional properties are allowed.
  Examples
  { "data": [] }
  
  This example has been generated automatically.
- #2end_recording
  End the recording
  End and save the recording.
  
  object
  uid: end_recording
  recording_id
  integer
  Additional properties are allowed.
  Examples
PUB /prompt
Get feedback on how well a given prompt was read.

Operation IDprompt_recording
Accepts one of the following messages:
- #0start_recording
  Start a recording.
  Start a recording.
  
  object
  uid: start_recording
  text
  string
  Required for /prompt
  
  language
  string
  Required for /prompt and /asr only nld, eng, de`.
  
  age_group
  string
  Optional for /prompt only adult (default) or child.
  
  prompt_id
  number
  Optional for /prompt only.
  
  text_index
  number
  Optional for /prompt only. Resume the text from a certain index, if not supplied will start from the beginning of the text (0).
  
  asr
  any
  Optional for /asr only Choose the asr type. fast (default) or good.
  
  Additional properties are allowed.
  Examples
  { "text": "string", "language": "string", "age_group": "string", "prompt_id": 0, "text_index": 0, "asr": null }
  
  This example has been generated automatically.
- #1write_recording
  Write audio to a recording.
  Send WAV data to the recording.
  
  object
  uid: write_recording
  16-bit signed integer PCM WAV data. Minimal sample rate 16khz higher frequencies are downsampled, higher frequencies are still preferred as the quality can be higher. Stereo will be downsampled to mono.
  
  required
  array<any>
  Additional properties are allowed.
  Examples
  { "data": [] }
  
  This example has been generated automatically.
- #2end_recording
  End the recording
  End and save the recording.
  
  object
  uid: end_recording
  recording_id
  integer
  Additional properties are allowed.
  Examples
SUB /prompt
Realtime feedback from the prompt.

Operation IDprompt_feedback
Accepts the following message:
feedback
Prompt feedback
Feedback on how well the speaker matches the prompt this can include omission words and pronunciation changes.

object
uid: feedback
sentenceConfidence
number
How sure is the model that the output is correct.

startTime
number
Start time of the sentence.

endTime
number
End time of the sentence.

sentenceIndex
number
Sentence count

upsample_p
number
How likely is the audio to be upsampled from 16kHz, where 0 is unlikely and 1.0 is most likely.

type
string
Unused.

Const:"EOS"
object
Feedback on the prompt.

word
string
What word is the label for?

start
number
Start time of the word.

end
number
End time of the word.

conf
number
How sure is the model that the output is correct.

type
string
What kind of label? CW = Correct Word OW = Omission Word PC = Pronunciation Change !unk = Unknown (separate from word labels)

phones
string
Phonemes that were detected for the word. When there is a pronunciation change the changed phonemes will be shown here.

textIndex
number
Word count.

clipping
boolean
Was clipping detected?

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "sentenceConfidence": 0, "startTime": 0, "endTime": 0, "sentenceIndex": 0, "upsample_p": 0, "type": "EOS", "labels": { "word": "string", "start": 0, "end": 0, "conf": 0, "type": "string", "phones": "string", "textIndex": 0, "clipping": true } }

This example has been generated automatically.
PUB /asr
Get a transcription of the audio.

Operation IDasr_recording
Accepts one of the following messages:
- #0start_recording
  Start a recording.
  Start a recording.
  
  object
  uid: start_recording
  text
  string
  Required for /prompt
  
  language
  string
  Required for /prompt and /asr only nld, eng, de`.
  
  age_group
  string
  Optional for /prompt only adult (default) or child.
  
  prompt_id
  number
  Optional for /prompt only.
  
  text_index
  number
  Optional for /prompt only. Resume the text from a certain index, if not supplied will start from the beginning of the text (0).
  
  asr
  any
  Optional for /asr only Choose the asr type. fast (default) or good.
  
  Additional properties are allowed.
  Examples
  { "text": "string", "language": "string", "age_group": "string", "prompt_id": 0, "text_index": 0, "asr": null }
  
  This example has been generated automatically.
- #1start_diarization
  Start a diarization.
  Start a diarization.
  
  object
  uid: start_recording
  text
  string
  Required for /prompt
  
  language
  string
  Required for /prompt and /asr only nld, eng, de`.
  
  age_group
  string
  Optional for /prompt only adult (default) or child.
  
  prompt_id
  number
  Optional for /prompt only.
  
  text_index
  number
  Optional for /prompt only. Resume the text from a certain index, if not supplied will start from the beginning of the text (0).
  
  asr
  any
  Optional for /asr only Choose the asr type. fast (default) or good.
  
  Additional properties are allowed.
  Examples
  { "text": "string", "language": "string", "age_group": "string", "prompt_id": 0, "text_index": 0, "asr": null }
  
  This example has been generated automatically.
- #2write_recording
  Write audio to a recording.
  Send WAV data to the recording.
  
  object
  uid: write_recording
  16-bit signed integer PCM WAV data. Minimal sample rate 16khz higher frequencies are downsampled, higher frequencies are still preferred as the quality can be higher. Stereo will be downsampled to mono.
  
  required
  array<any>
  Additional properties are allowed.
  Examples
  { "data": [] }
  
  This example has been generated automatically.
- #3end_recording
  End the recording
  End and save the recording.
  
  object
  uid: end_recording
  recording_id
  integer
  Additional properties are allowed.
  Examples
SUB /asr
Realtime transcription of the recording.

Operation IDasr
Accepts the following message:
asr
Transcription
Transcription of a given recording.

Examples

Messages

#1start_recording
Start a recording.
Start a recording.

object
uid: start_recording
text
string
Required for /prompt

language
string
Required for /prompt and /asr only nld, eng, de`.

age_group
string
Optional for /prompt only adult (default) or child.

prompt_id
number
Optional for /prompt only.

text_index
number
Optional for /prompt only. Resume the text from a certain index, if not supplied will start from the beginning of the text (0).

asr
any
Optional for /asr only Choose the asr type. fast (default) or good.

Additional properties are allowed.
#2start_diarization
Start a diarization.
Start a diarization.

object
uid: start_recording
text
string
Required for /prompt

language
string
Required for /prompt and /asr only nld, eng, de`.

age_group
string
Optional for /prompt only adult (default) or child.

prompt_id
number
Optional for /prompt only.

text_index
number
Optional for /prompt only. Resume the text from a certain index, if not supplied will start from the beginning of the text (0).

asr
any
Optional for /asr only Choose the asr type. fast (default) or good.

Additional properties are allowed.
#3write_recording
Write audio to a recording.
Send WAV data to the recording.

object
uid: write_recording
16-bit signed integer PCM WAV data. Minimal sample rate 16khz higher frequencies are downsampled, higher frequencies are still preferred as the quality can be higher. Stereo will be downsampled to mono.

required
array<any>
Additional properties are allowed.
#4end_recording
End the recording
End and save the recording.

object
uid: end_recording
recording_id
integer
Additional properties are allowed.
#5feedback
Prompt feedback
Feedback on how well the speaker matches the prompt this can include omission words and pronunciation changes.

object
uid: feedback
sentenceConfidence
number
How sure is the model that the output is correct.

startTime
number
Start time of the sentence.

endTime
number
End time of the sentence.

sentenceIndex
number
Sentence count

upsample_p
number
How likely is the audio to be upsampled from 16kHz, where 0 is unlikely and 1.0 is most likely.

type
string
Unused.

Const:"EOS"
object
Feedback on the prompt.

word
string
What word is the label for?

start
number
Start time of the word.

end
number
End time of the word.

conf
number
How sure is the model that the output is correct.

type
string
What kind of label? CW = Correct Word OW = Omission Word PC = Pronunciation Change !unk = Unknown (separate from word labels)

phones
string
Phonemes that were detected for the word. When there is a pronunciation change the changed phonemes will be shown here.

textIndex
number
Word count.

clipping
boolean
Was clipping detected?

Additional properties are allowed.
Additional properties are allowed.
#6asr
Transcription
Transcription of a given recording.

Schemas

object
uid: start_recording
text
string
Required for /prompt

language
string
Required for /prompt and /asr only nld, eng, de`.

age_group
string
Optional for /prompt only adult (default) or child.

prompt_id
number
Optional for /prompt only.

text_index
number
Optional for /prompt only. Resume the text from a certain index, if not supplied will start from the beginning of the text (0).

asr
any
Optional for /asr only Choose the asr type. fast (default) or good.

Additional properties are allowed.
object
uid: write_recording
16-bit signed integer PCM WAV data. Minimal sample rate 16khz higher frequencies are downsampled, higher frequencies are still preferred as the quality can be higher. Stereo will be downsampled to mono.

required
array<any>
Additional properties are allowed.
object
uid: end_recording
recording_id
integer
Additional properties are allowed.
object
uid: feedback
sentenceConfidence
number
How sure is the model that the output is correct.

startTime
number
Start time of the sentence.

endTime
number
End time of the sentence.

sentenceIndex
number
Sentence count

upsample_p
number
How likely is the audio to be upsampled from 16kHz, where 0 is unlikely and 1.0 is most likely.

type
string
Unused.

Const:"EOS"
object
Feedback on the prompt.

word
string
What word is the label for?

start
number
Start time of the word.

end
number
End time of the word.

conf
number
How sure is the model that the output is correct.

type
string
What kind of label? CW = Correct Word OW = Omission Word PC = Pronunciation Change !unk = Unknown (separate from word labels)

phones
string
Phonemes that were detected for the word. When there is a pronunciation change the changed phonemes will be shown here.

textIndex
number
Word count.

clipping
boolean
Was clipping detected?

Additional properties are allowed.
Additional properties are allowed.

The ITSLanguage API 3.1.0

Servers

Operations

PUB /recording

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

PUB /prompt

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

SUB /prompt

Examples

This example has been generated automatically.

PUB /asr

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

SUB /asr

Examples

Messages

Schemas