Type Alias VoiceOutput

VoiceOutput: {
    accent?: string;
    context?: string;
    description?: string;
    display_name?: string;
    expire_time?: string;
    gender?: string;
    id?: string;
    key?: string;
    language_code?: string;
    model?: string;
    persona?: string;
    pitch?: Pitch;
    prompted?: PromptedVoice;
    region_code?: string;
    sample_audio?: AudioData;
    type: VoiceType;
    usage?: Usage;
}

A voice resource representing either a custom voice (created via

Type declaration

  • Optionalaccent?: string

    Optional. Regional accent descriptor (e.g. "American", "British").

  • Optionalcontext?: string

    Optional. Optimal usage context or domain (e.g. "Conversational",

    Remarks

    "Audiobook", "News").

  • Optionaldescription?: string

    Optional. Descriptive summary of vocal timbre, personality, and tone.

  • Optionaldisplay_name?: string

    Optional. User-provided display name for a stored voice (store = true),

    Remarks

    or the catalog name for a prebuilt voice.

  • Optionalexpire_time?: string

    Output only. The timestamp at which a custom stored voice (store = true)

    Remarks

    or replicated voice key (store = false) expires. For custom stored voices (store = true), this expiration time is extended when the voice is used for speech synthesis or as a base_voice in CreateVoice. Unset for prebuilt catalog voices ("prebuilt"), which do not expire.

  • Optionalgender?: string

    Optional. Perceived voice gender presentation (e.g. "female", "male",

    Remarks

    "neutral").

  • Optionalid?: string

    Output only. The unique identifier of the voice.

    Remarks

    • For Google-managed custom voices (store = true), this is a generated ID with prefix voice_ (for example, voice_abc123def456). Pass voices/{id} as the name in GetVoice and DeleteVoice, and pass {id} directly to SpeechConfig.voice_config.voice (or SpeechConfig.voice) during speech synthesis.
    • For prebuilt catalog voices ("prebuilt" returned by ListVoices), this is the speaker name (for example, Puck or Charon).
    • Unset when CreateVoice is called with store = false.
  • Optionalkey?: string

    Output only. The client-managed voice replication key (with prefix

    Remarks

    voicekey_). Returned only by CreateVoice when type is "replicated" and store is false. Pass this key to SpeechConfig.voice_config.voice (or SpeechConfig.voice) during speech synthesis.

  • Optionallanguage_code?: string

    Optional. Primary BCP-47 language tag (e.g. "en-US", "fr-FR").

  • Optionalmodel?: string

    Optional. The model used to design or replicate the voice.

    Remarks

    If omitted in CreateVoice, defaults to the latest supported voice design model. Returned in CreateVoice, GetVoice, and ListVoices responses for custom voices ("prompted" and "replicated"); unset for "prebuilt" voices. Created voices can be synthesized across any supported TTS synthesis model.

  • Optionalpersona?: string

    Optional. Intended persona or character archetype (e.g. "Warm, Friendly",

    Remarks

    "Narrator").

  • Optionalpitch?: Pitch
  • Optionalprompted?: PromptedVoice

    Parameters for prompted voice generation.

    Remarks

    Required in CreateVoice when type is "prompted". Returned in CreateVoice, GetVoice, and ListVoices responses for prompted voices.

  • Optionalregion_code?: string

    Optional. ISO 3166-1 alpha-2 or UN M.49 geographic region code (e.g. "US",

    Remarks

    "GB", "001").

  • Optionalsample_audio?: AudioData

    Audio payload used for voice creation.

  • type: VoiceType
  • Optionalusage?: Usage

    Statistics on the interaction request's token usage.

Remarks

CreateVoice) or a prebuilt system voice (returned by ListVoices).

Settings