Edit

Share via

Deploy your custom text to speech avatar model as an endpoint

  • Article

You must deploy the custom avatar to an endpoint before you can use it. Once your custom text to speech avatar model is successfully trained through our manual process, we'll notify you. Then you can deploy it to a custom avatar endpoint. You can create up to 10 custom avatar endpoints for each standard (S0) Speech resource.

After you deploy your custom avatar, it's available to use in Speech Studio or via API:

  • The avatar appears in the avatar list of text to speech avatar on Speech Studio.
  • The avatar appears in the avatar list of live chat avatar on Speech Studio.
  • You can call the avatar from the API by specifying the avatar model name.

Add a deployment endpoint

To create a custom avatar endpoint, follow these steps:

  1. Sign in to Speech Studio.
  2. Navigate to Custom Avatar > Your project name > Train model.
  3. All available models are listed on the Train model page. Select a model link to view more information, such as the created date and a preview image of the custom avatar.
  4. Select a model that you would like to deploy, then select the Deploy model button above the list.
  5. Confirm the deployment to create your endpoint.

Once your model is successfully deployed as an endpoint, you can select the endpoint link on the Deploy model page. There, you find a link to the text to speech avatar portal on Speech Studio, where you can try to create videos with your custom avatar using text input.

Remove a deployment endpoint

To remove a deployment endpoint, follow these steps:

  1. Sign in to Speech Studio.
  2. Navigate to Custom Avatar > Your project name > Train model.
  3. All available models are listed on the Train model page. Select a model link to view more information, such as the created date and a preview image of the custom avatar.
  4. Select a model on the Train model page. If it's in "Succeeded" status, it means it's in hosting status. You can select the Delete button and confirm the deletion to remove the hosting.

Use your custom neural voice

If you're also creating a custom neural voice for the actor, the avatar can be highly realistic. For more information, see What is custom text to speech avatar.

Custom neural voice and custom text to speech avatar are separate features. You can use them independently or together.

If you created a custom neural voice (CNV) and want to use it together with the custom avatar, pay attention to the following points:

  • Ensure that the CNV endpoint is created in the same Speech resource as the custom avatar endpoint. You can see the custom neural voice option in the voices list of the avatar content generation page and live chat voice settings.
  • If you're using batch synthesis for avatar API, add the "customVoices" property to associate the deployment ID of the CNV model with the voice name in the request. For more information, see the Text to speech properties.
  • If you're using real-time synthesis for avatar API, refer to our sample code on GitHub to set the custom neural voice.
  • If your custom neural voice endpoint is in a different Speech resource from the custom avatar endpoint, refer to Train your professional voice model to copy the CNV model to the same Speech resource as the custom avatar endpoint.

Next steps

  • Learn more about custom text to speech avatar in the overview.