AddCustomPromptParams

Parameters for the addCustomPrompt operation.

Hierarchy

AddCustomPromptParams

Index

Properties

customizationId

customizationId: string

The customization ID (GUID) of the custom model. You must make the request with credentials for the instance of the service that owns the custom model.

file

file: ReadableStream | Buffer

An audio file that speaks the text of the prompt with intonation and prosody that matches how you would like the prompt to be spoken.

The prompt audio must be in WAV format and must have a minimum sampling rate of 16 kHz. The service accepts audio with higher sampling rates. The service transcodes all audio to 16 kHz before processing it.
The length of the prompt audio is limited to 30 seconds.

Optional headers

headers: OutgoingHttpHeaders

metadata

metadata: PromptMetadata

Information about the prompt that is to be added to a custom model. The following example of a PromptMetadata object includes both the required prompt text and an optional speaker model ID:

{ "prompt_text": "Thank you and good-bye!", "speaker_id": "823068b2-ed4e-11ea-b6e0-7b6456aa95cc" }.

promptId

promptId: string

The identifier of the prompt that is to be added to the custom model:

Include a maximum of 49 characters in the ID.
Include only alphanumeric characters and _ (underscores) in the ID.
Do not include XML sensitive characters (double quotes, single quotes, ampersands, angle brackets, and slashes) in the ID.
To add a new prompt, the ID must be unique for the specified custom model. Otherwise, the new information for the prompt overwrites the existing prompt that has that ID.