This article answers commonly asked questions about the speech-to-text service. If you can't find answers to your questions here, check out other support options.
What is the difference between a base model and a custom speech-to-text model?
A baseline speech-to-text model has been trained with Microsoft-owned data and is already deployed in the cloud. You can create and use a custom model to better fit an environment that has specific ambient noise or language. Factory floors, cars, or noisy streets would require an adapted acoustic model. Topics such as biology, physics, radiology, product names, and custom acronyms would require an adapted language model. If you want to train a custom model, you should start with related text to improve the recognition of special terms and phrases.
Where do I start if I want to use a base model?
First, get a Speech resource key and region in the Azure portal. If you want to make REST calls to a predeployed base model, see the REST APIs documentation. If you want to use WebSockets, download the Speech SDK.
Do I always need to build a custom speech model?
No. If your application uses generic, day-to-day language, you don't need to customize a model. If your application is used in an environment where there's little or no background noise, you don't need to customize a model.
You can deploy baseline and customized models in the portal and then run accuracy tests against them. You can use this feature to measure the accuracy of a base model versus a custom model.
How will I know when the processing for my dataset or model is complete?
Currently, the only way to know is to view the status of the model or dataset in the table. When the processing is complete, the status is Succeeded.
Can I create more than one model?
There's no limit to the number of models you can have in your collection.
I realize that I've made a mistake. How do I cancel a data import or model creation that's in progress?
Currently, you can't roll back an acoustic or language adaptation process. You can delete imported data and models when they're in a terminal state.
I get several results for each phrase with the detailed output format. Which one should I use?
Always take the first result, even if another result ("N-Best") might have a higher confidence value. Speech service considers the first result to be the best. The result can also be an empty string if no speech was recognized.
The other results are likely worse and might not have full capitalization and punctuation applied. These results are most useful in special scenarios, such as giving users the option to pick corrections from a list or handling incorrectly recognized commands.
Why are there multiple base models?
You can choose from more than one base model in Speech service. Each model name contains the date when it was added. When you start training a custom model, use the most recent model to get the best accuracy. Older base models are still available for some time after a new model is made available. You can continue using the model that you've worked with until it is retired (see Model and endpoint lifecycle). We still recommend that you switch to the latest base model for better accuracy.
Can I update my existing model (model stacking)?
You can't update an existing model. As a solution, combine the old dataset with the new dataset and readapt.
The old dataset and the new dataset must be combined in a single .zip file (for acoustic data) or in a .txt file (for language data). When the adaptation is finished, redeploy the new, updated model to obtain a new endpoint.
When a new version of a base model is available, is my deployment automatically updated?
Deployments are not automatically updated.
If you've adapted and deployed a model, the existing deployment will remain as is. You can decommission the deployed model, readapt it by using the newer version of the base model, and redeploy it for better accuracy.
Both base models and custom models will be retired after some time (see Model and endpoint lifecycle).
Can I download my model and run it locally?
You can run a custom model locally in a Docker container.
Can I copy or move my datasets, models, and deployments to another region or subscription?
You can use the REST API to copy a custom model to another region or subscription. Datasets and deployments can't be copied. You can import a dataset again in another subscription and create endpoints there by using the model copies.
Are my requests logged?
By default, requests aren't logged (neither audio nor transcription). If necessary, you can select the Log content from this endpoint option when you create a custom endpoint. You can also enable audio logging in the Speech SDK on a per-request basis, without having to create a custom endpoint. In both cases, audio and recognition results of requests will be stored in secure storage. Subscriptions that use Microsoft-owned storage will be available for 30 days.
You can export the logged files on the deployment page in Speech Studio if you use a custom endpoint with Log content from this endpoint enabled. If audio logging is enabled via the SDK, call the API to access the files. You can also use API to delete the logs any time.
Are my requests throttled?
For information, see Speech service quotas and limits.
How am I charged for dual channel audio?
If you submit each channel separately in their own file, you'll be charged for the duration of each file. If you submit a single file with the channels multiplexed together, you'll be charged for the duration of the single file. For more information about pricing, see the Azure Cognitive Services pricing page.
If you have further privacy concerns that prevent you from using the Custom Speech service, contact one of the support channels.
For information, see Speech service quotas and limits.
What is the limit to the size of a dataset, and why is it the limit?
The limit is because of the restriction on the size of files for HTTP upload. For the actual limit, see Speech service quotas and limits. You can split your data into multiple datasets and select all of them to train the model.
Can I zip (compress) my text files so that I can upload a larger text file?
No. Currently, only uncompressed text files are allowed.
The data report says there were failed utterances. What is the issue?
A failure to upload 100 percent of the utterances in a file isn't a problem. If the vast majority of the utterances in an acoustic or language dataset (for example, more than 95 percent) are successfully imported, the dataset can be usable. However, we still recommend that you try to understand why the utterances failed and then fix the problem. Most common problems, such as formatting errors, are easy to fix.
Creating an acoustic model
How much acoustic data do I need?
We recommend starting with from 30 minutes to 1 hour of acoustic data.
What data should I collect?
Collect data that's as close to the application scenario and use case as possible. The data collection should match the target application and users in terms of device or devices, environments, and types of speakers. In general, you should collect data from as broad a range of speakers as possible.
How should I collect acoustic data?
You can create a standalone data collection application or use off-the-shelf audio recording software. You can also create a version of your application that logs the audio data and then uses the data.
Do I need to transcribe adaptation data myself?
Yes. You can transcribe it yourself or use a professional transcription service. Some users prefer professional transcribers, and others use crowdsourcing or transcribe the data themselves.
How long does it take to train a custom model with audio data?
Training a model with audio data can be a lengthy process. Depending on the amount of data, it can take several days to create a custom model. If it can't be finished within one week, the service might abort the training operation and report the model as failed.
In general, Speech service processes approximately 10 hours of audio data per day in regions that have dedicated hardware. It can process only about 1 hour of audio data per day in other regions. Training with text only is much faster and ordinarily finishes within minutes.
Use one of the regions where dedicated hardware is available for training. Speech service will use up to 20 hours of audio for training in these regions. In other regions, Speech service will use only up to 8 hours.
What is word error rate (WER), and how is it computed?
WER is the evaluation metric for speech recognition. WER is calculated as the total number of errors (insertions, deletions, and substitutions), divided by the total number of words in the reference transcription. For more information, see Test model quantitatively.
How do I determine whether the results of an accuracy test are good?
The results show a comparison between the base model and the model you customized. To make customization worthwhile, you should aim to beat the base model.
How do I determine the WER of a base model so I can see whether it improved?
The offline test results show the baseline accuracy of the custom model and the improvement over baseline.
Creating a language model
How much text data do I need to upload?
It depends on how different the vocabulary and phrases used in your application are from the starting language models. For all new words, it's useful to provide as many examples as possible of the usage of those words. For common phrases that are used in your application, including phrases in the language data, providing many examples is useful because it tells the system to listen for these terms also. It's common to have at least 100 and, ordinarily, several hundred or more utterances in the language dataset. Also, if some types of queries are expected to be more common than others, you can insert multiple copies of the common queries in the dataset.
Can I simply upload a list of words?
Uploading a list of words adds them to the vocabulary, but it doesn't teach the system how the words are ordinarily used. By providing full or partial utterances (sentences or phrases of things that users are likely to say), the language model can learn the new words and how they're used. The custom language model is good not only for adding new words to the system, but also for adjusting the likelihood of known words for your application. Providing full utterances helps the system learn better.